KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > text > undo > IDocumentUndoListener


1 /*******************************************************************************
2  * Copyright (c) 2006 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 package org.eclipse.text.undo;
12
13
14 /**
15  * This interface is used to listen to notifications from a DocumentUndoManager.
16  * The supplied DocumentUndoEvent describes the particular notification.
17  * <p>
18  * Document undo listeners must be prepared to receive notifications from a
19  * background thread. Any UI access occurring inside the implementation must be
20  * properly synchronized using the techniques specified by the client's widget
21  * library.</p>
22  * <p>
23  * Clients may implement this interface.
24  * </p>
25  *
26  * @since 3.2
27  */
28 public interface IDocumentUndoListener {
29     
30     /**
31      * The document is involved in an undo-related change. Notify listeners
32      * with an event describing the change.
33      *
34      * @param event the document undo event that describes the particular notification
35      */
36     void documentUndoNotification(DocumentUndoEvent event);
37
38 }
39
Popular Tags