KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > jface > text > IDocumentAdapterExtension


1 /*******************************************************************************
2  * Copyright (c) 2000, 2005 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11
12 package org.eclipse.jface.text;
13
14 /**
15  * Extension interface for {@link org.eclipse.jface.text.IDocumentAdapter}.
16  * <p>
17  * Introduces the concepts of batching a series of document changes into a
18  * single styled text content change notification. Batching start when a client
19  * calls <code>stopForwardingDocumentChanges</code>. After that call this
20  * document adapter does not send out styled text content change notifications
21  * until <code>resumeForwardingDocumentChanges</code> is called. On
22  * <code>resumeForwardingDocumentChanges</code>, it sends out one styled text
23  * content change notification that covers all changes that have been applied to
24  * the document since calling <code>stopForwardingDocumentChanges</code>.
25  *
26  * @since 2.0
27  */
28 public interface IDocumentAdapterExtension {
29
30     /**
31      * Stops forwarding document changes to the styled text.
32      */
33     void stopForwardingDocumentChanges();
34
35     /**
36      * Resumes forwarding document changes to the styled text.
37      * Also forces the styled text to catch up with all the changes
38      * that have been applied since <code>stopForwardingDocumentChanges</code>
39      * has been called.
40      */
41     void resumeForwardingDocumentChanges();
42 }
43
Popular Tags