org.eclipse.jface.text.IDocumentExtension2 Maven / Gradle / Ivy

/*******************************************************************************
 * Copyright (c) 2000, 2010 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.jface.text;

/**
 * Extension interface for {@link org.eclipse.jface.text.IDocument}.
 *
 * It adds configuration methods to post notification replaces and document
 * listener notification.
 *
 * @since 2.1
 */
public interface IDocumentExtension2 {

	/**
	 * Tells the receiver to ignore calls to
	 * registerPostNotificationReplace until
	 * acceptPostNotificationReplaces is called.
	 */
	void ignorePostNotificationReplaces();

	/**
	 * Tells the receiver to accept calls to
	 * registerPostNotificationReplace until
	 * ignorePostNotificationReplaces is called.
	 */
	void acceptPostNotificationReplaces();

	/**
	 * Can be called prior to a replace operation. After the
	 * replace resumeListenerNotification must be
	 * called. The effect of these calls is that no document listener is notified
	 * until resumeListenerNotification is called. This allows clients
	 * to update structure before any listener is informed about the change.
	 * Listener notification can only be stopped for a single replace operation.
	 * Otherwise, document change notifications will be lost.
	 */
	void stopListenerNotification();

	/**
	 * Resumes the notification of document listeners which must previously
	 * have been stopped by a call to stopListenerNotification.
	 */
	void resumeListenerNotification();
}