< prev index next >

src/java.desktop/share/classes/javax/swing/event/TreeExpansionEvent.java

Print this page




  26 package javax.swing.event;
  27 
  28 import java.util.EventObject;
  29 import javax.swing.tree.TreePath;
  30 
  31 /**
  32  * An event used to identify a single path in a tree.  The source
  33  * returned by <b>getSource</b> will be an instance of JTree.
  34  * <p>
  35  * For further documentation and examples see
  36  * the following sections in <em>The Java Tutorial</em>:
  37  * <a href="http://docs.oracle.com/javase/tutorial/uiswing/events/treeexpansionlistener.html">How to Write a Tree Expansion Listener</a> and
  38  * <a href="http://docs.oracle.com/javase/tutorial/uiswing/events/treewillexpandlistener.html">How to Write a Tree-Will-Expand Listener</a>.
  39  * <p>
  40  * <strong>Warning:</strong>
  41  * Serialized objects of this class will not be compatible with
  42  * future Swing releases. The current serialization support is
  43  * appropriate for short term storage or RMI between applications running
  44  * the same version of Swing.  As of 1.4, support for long term storage
  45  * of all JavaBeans&trade;
  46  * has been added to the <code>java.beans</code> package.
  47  * Please see {@link java.beans.XMLEncoder}.
  48  *
  49  * @author Scott Violet
  50  */
  51 @SuppressWarnings("serial") // Same-version serialization only
  52 public class TreeExpansionEvent extends EventObject
  53 {
  54     /**
  55       * Path to the value this event represents.
  56       */
  57     protected TreePath path;
  58 
  59     /**
  60      * Constructs a TreeExpansionEvent object.
  61      *
  62      * @param source  the Object that originated the event
  63      *                (typically <code>this</code>)
  64      * @param path    a TreePath object identifying the newly expanded
  65      *                node
  66      */
  67     public TreeExpansionEvent(Object source, TreePath path) {
  68         super(source);
  69         this.path = path;
  70     }
  71 
  72     /**
  73       * Returns the path to the value that has been expanded/collapsed.
  74       *
  75       * @return this event's {@code TreePath} object
  76       */
  77     public TreePath getPath() { return path; }
  78 }


  26 package javax.swing.event;
  27 
  28 import java.util.EventObject;
  29 import javax.swing.tree.TreePath;
  30 
  31 /**
  32  * An event used to identify a single path in a tree.  The source
  33  * returned by <b>getSource</b> will be an instance of JTree.
  34  * <p>
  35  * For further documentation and examples see
  36  * the following sections in <em>The Java Tutorial</em>:
  37  * <a href="http://docs.oracle.com/javase/tutorial/uiswing/events/treeexpansionlistener.html">How to Write a Tree Expansion Listener</a> and
  38  * <a href="http://docs.oracle.com/javase/tutorial/uiswing/events/treewillexpandlistener.html">How to Write a Tree-Will-Expand Listener</a>.
  39  * <p>
  40  * <strong>Warning:</strong>
  41  * Serialized objects of this class will not be compatible with
  42  * future Swing releases. The current serialization support is
  43  * appropriate for short term storage or RMI between applications running
  44  * the same version of Swing.  As of 1.4, support for long term storage
  45  * of all JavaBeans&trade;
  46  * has been added to the {@code java.beans} package.
  47  * Please see {@link java.beans.XMLEncoder}.
  48  *
  49  * @author Scott Violet
  50  */
  51 @SuppressWarnings("serial") // Same-version serialization only
  52 public class TreeExpansionEvent extends EventObject
  53 {
  54     /**
  55       * Path to the value this event represents.
  56       */
  57     protected TreePath path;
  58 
  59     /**
  60      * Constructs a TreeExpansionEvent object.
  61      *
  62      * @param source  the Object that originated the event
  63      *                (typically {@code this})
  64      * @param path    a TreePath object identifying the newly expanded
  65      *                node
  66      */
  67     public TreeExpansionEvent(Object source, TreePath path) {
  68         super(source);
  69         this.path = path;
  70     }
  71 
  72     /**
  73       * Returns the path to the value that has been expanded/collapsed.
  74       *
  75       * @return this event's {@code TreePath} object
  76       */
  77     public TreePath getPath() { return path; }
  78 }
< prev index next >