/*

 * Copyright 1997-2001 Sun Microsystems, Inc.  All Rights Reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 */

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; }

}