1/*
2 * Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package javax.swing.event;
27
28import java.util.EventObject;
29import 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
52public 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}
79