1. /*

  2.  * @(#)TreeModelListener.java	1.12 01/11/29

  3.  *

  4.  * Copyright 2002 Sun Microsystems, Inc. All rights reserved.

  5.  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.

  6.  */

  7. 

  8. package javax.swing.event;

  9. 

  10. import java.util.EventListener;

  11. 

  12. /**

  13.  * TreeChangeListener defines the interface for an object that listens

  14.  * to changes in a TreeModel.

  15.  *

  16.  * @version 1.12 11/29/01

  17.  * @author Rob Davis

  18.  * @author Ray Ryan

  19.  */

  20. public interface TreeModelListener extends EventListener {

  21. 

  22.     /**

  23.      * <p>Invoked after a node (or a set of siblings) has changed in some

  24.      * way. The node(s) have not changed locations in the tree or

  25.      * altered their children arrays, but other attributes have

  26.      * changed and may affect presentation. Example: the name of a

  27.      * file has changed, but it is in the same location in the file

  28.      * system.</p>

  29.      * <p>To indicate the root has changed, childIndices and children

  30.      * will be null. </p>

  31.      * 

  32.      * <p>e.path() returns the path the parent of the changed node(s).</p>

  33.      * 

  34.      * <p>e.childIndices() returns the index(es) of the changed node(s).</p>

  35.      */

  36.     void treeNodesChanged(TreeModelEvent e);

  37. 

  38.     /**

  39.      * <p>Invoked after nodes have been inserted into the tree.</p>

  40.      * 

  41.      * <p>e.path() returns the parent of the new nodes

  42.      * <p>e.childIndices() returns the indices of the new nodes in

  43.      * ascending order.

  44.      */

  45.     void treeNodesInserted(TreeModelEvent e);

  46. 

  47.     /**

  48.      * <p>Invoked after nodes have been removed from the tree.  Note that

  49.      * if a subtree is removed from the tree, this method may only be

  50.      * invoked once for the root of the removed subtree, not once for

  51.      * each individual set of siblings removed.</p>

  52.      *

  53.      * <p>e.path() returns the former parent of the deleted nodes.</p>

  54.      * 

  55.      * <p>e.childIndices() returns the indices the nodes had before they were deleted in ascending order.</p>

  56.      */

  57.     void treeNodesRemoved(TreeModelEvent e);

  58. 

  59.     /**

  60.      * <p>Invoked after the tree has drastically changed structure from a

  61.      * given node down.  If the path returned by e.getPath() is of length

  62.      * one and the first element does not identify the current root node

  63.      * the first element should become the new root of the tree.<p>

  64.      * 

  65.      * <p>e.path() holds the path to the node.</p>

  66.      * <p>e.childIndices() returns null.</p>

  67.      */

  68.     void treeStructureChanged(TreeModelEvent e);

  69. 

  70. }