Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: cc45fbb5926fc9fbca0b2f4134b1c381d99db704 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
/*******************************************************************************
 * Copyright (c) 2000, 2004 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials 
 * are made available under the terms of the Common Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/cpl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.jface.text;
 
/**
 * Extension interface for <code>IDocumentAdapter</code>. Introduces the concepts of 
 * batching a series of document changes into one styled text content change. Batching start
 * when a client calls <code>stopForwardingDocumentChanges</code>. After that call this document
 * adapter does not send out any styled text content change until 
 * <code>resumeForwardingDocumentChanges</code> is called. Then, it sends out one styled text
 * content change that covers all changes that have been applied to the document since calling
 * <code>stopForwardingDocumentChanges</code>.
 * 
 * @since 2.0 
 */
public interface IDocumentAdapterExtension {
	
	/**
	 * Stops forwarding document changes to the styled text.
	 */
	void stopForwardingDocumentChanges();
	
	/**
	 * Resumes forwarding document changes to the styled text.
	 * Also forces the styled text to catch up with all the changes
	 * that have been applied since <code>stopForwardingDocumentChanges</code>
	 * has been called.
	 */
	void resumeForwardingDocumentChanges();
}

Back to the top