/*
* Copyright (c) 1997, 2001, Oracle and/or its affiliates. All rights reserved.
* ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*/
package javax.swing.event;
import java.util.EventObject;
import javax.swing.tree.TreePath;
/**
* An event used to identify a single path in a tree. The source
* returned by <b>getSource</b> will be an instance of JTree.
* <p>
* For further documentation and examples see
* the following sections in <em>The Java Tutorial</em>:
* <a href="http://java.sun.com/docs/books/tutorial/uiswing/events/treeexpansionlistener.html">How to Write a Tree Expansion Listener</a> and
* <a href="http://java.sun.com/docs/books/tutorial/uiswing/events/treewillexpandlistener.html">How to Write a Tree-Will-Expand Listener</a>.
* <p>
* <strong>Warning:</strong>
* Serialized objects of this class will not be compatible with
* future Swing releases. The current serialization support is
* appropriate for short term storage or RMI between applications running
* the same version of Swing. As of 1.4, support for long term storage
* of all JavaBeans<sup><font size="-2">TM</font></sup>
* has been added to the <code>java.beans</code> package.
* Please see {@link java.beans.XMLEncoder}.
*
* @author Scott Violet
*/
public class TreeExpansionEvent extends EventObject
{
/**
* Path to the value this event represents.
*/
protected TreePath path;
/**
* Constructs a TreeExpansionEvent object.
*
* @param source the Object that originated the event
* (typically <code>this</code>)
* @param path a TreePath object identifying the newly expanded
* node
*/
public TreeExpansionEvent(Object source, TreePath path) {
super(source);
this.path = path;
}
/**
* Returns the path to the value that has been expanded/collapsed.
*/
public TreePath getPath() { return path; }
}