01 /*
02 * Copyright 1997-2001 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
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://java.sun.com/docs/books/tutorial/uiswing/events/treeexpansionlistener.html">How to Write a Tree Expansion Listener</a> and
38 * <a href="http://java.sun.com/docs/books/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<sup><font size="-2">TM</font></sup>
46 * has been added to the <code>java.beans</code> package.
47 * Please see {@link java.beans.XMLEncoder}.
48 *
49 * @author Scott Violet
50 * @version 1.27 05/05/07
51 */
52 public class TreeExpansionEvent extends EventObject {
53 /**
54 * Path to the value this event represents.
55 */
56 protected TreePath path;
57
58 /**
59 * Constructs a TreeExpansionEvent object.
60 *
61 * @param source the Object that originated the event
62 * (typically <code>this</code>)
63 * @param path a TreePath object identifying the newly expanded
64 * node
65 */
66 public TreeExpansionEvent(Object source, TreePath path) {
67 super (source);
68 this .path = path;
69 }
70
71 /**
72 * Returns the path to the value that has been expanded/collapsed.
73 */
74 public TreePath getPath() {
75 return path;
76 }
77 }
|