1. /*

  2.  * @(#)DocumentListener.java	1.11 00/02/02

  3.  *

  4.  * Copyright 1997-2000 Sun Microsystems, Inc. All Rights Reserved.

  5.  * 

  6.  * This software is the proprietary information of Sun Microsystems, Inc.  

  7.  * Use is subject to license terms.

  8.  * 

  9.  */

  10. package javax.swing.event;

  11. 

  12. import java.util.EventListener;

  13. 

  14. /**

  15.  * Interface for an observer to register to receive notifications 

  16.  * of changes to a text document.  

  17.  * <p>

  18.  * The default implementation of

  19.  * the Document interface (AbstractDocument) supports asynchronous

  20.  * mutations.  If this feature is used (i.e. mutations are made

  21.  * from a thread other than the Swing event thread), the listeners

  22.  * will be notified via the mutating thread.  <em>This means that

  23.  * if asynchronous updates are made, the implementation of this

  24.  * interface must be threadsafe</em>!

  25.  * <p>

  26.  * The DocumentEvent notification is based upon the JavaBeans

  27.  * event model.  There is no guarantee about the order of delivery

  28.  * to listeners, and all listeners must be notified prior to making 

  29.  * further mutations to the Document.  <em>This means implementations 

  30.  * of the DocumentListener may not mutate the source of the event 

  31.  * (i.e. the associated Document)</em>.

  32.  *

  33.  * @author  Timothy Prinzing

  34.  * @version 1.11 02/02/00

  35.  * @see javax.swing.text.Document

  36.  * @see javax.swing.text.StyledDocument

  37.  * @see DocumentEvent

  38.  */

  39. public interface DocumentListener extends EventListener {

  40. 

  41.     /**

  42.      * Gives notification that there was an insert into the document.  The 

  43.      * range given by the DocumentEvent bounds the freshly inserted region.

  44.      *

  45.      * @param e the document event

  46.      */

  47.     public void insertUpdate(DocumentEvent e);

  48. 

  49.     /**

  50.      * Gives notification that a portion of the document has been 

  51.      * removed.  The range is given in terms of what the view last

  52.      * saw (that is, before updating sticky positions).

  53.      *

  54.      * @param e the document event

  55.      */

  56.     public void removeUpdate(DocumentEvent e);

  57. 

  58.     /**

  59.      * Gives notification that an attribute or set of attributes changed.

  60.      *

  61.      * @param e the document event

  62.      */

  63.     public void changedUpdate(DocumentEvent e);

  64. }