Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.swing.event

Class TreeSelectionEvent

Implemented Interfaces:
Serializable
public class TreeSelectionEvent
extends EventObject
An event that carries information about a change to a TreeSelectionModel.
See Also:
TreeSelectionListener, Serialized Form

Field Summary

protected boolean[]
areNew
Flags indicating if the paths were added (true) or removed (false) from the selection.
protected TreePath
newLeadSelectionPath
The new lead selection path (may be null).
protected TreePath
oldLeadSelectionPath
The old lead selection path (may be null).
protected TreePath[]
paths
The paths that have been added or removed from the selection.

Fields inherited from class java.util.EventObject

source

Constructor Summary

TreeSelectionEvent(Object source, TreePath path, boolean isNew, TreePath oldLeadSelectionPath, TreePath newLeadSelectionPath)
Creates a new TreeSelectionEvent.
TreeSelectionEvent(Object source, TreePath[] paths, boolean[] areNew, TreePath oldLeadSelectionPath, TreePath newLeadSelectionPath)
Creates a new TreeSelectionEvent.

Method Summary

Object
cloneWithSource(Object source)
Creates a shallow copy of this TreeSelectionEvent, replacing the source with source.
TreePath
getNewLeadSelectionPath()
Returns the new lead selection path.
TreePath
getOldLeadSelectionPath()
Returns the old lead selection path.
TreePath
getPath()
Returns the first path element.
TreePath[]
getPaths()
Returns an array of the paths that changed in the selection.
boolean
isAddedPath()
Returns true if the path returned by getPath() has been added to the selection, and false if it has been removed.
boolean
isAddedPath(int index)
Returns true if the path at the specified index has been added to the selection, and false if the path has been removed from the selection.
boolean
isAddedPath(TreePath path)
Returns true if path has been added to the selection, and false if the path has been removed from the selection.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

areNew

protected boolean[] areNew
Flags indicating if the paths were added (true) or removed (false) from the selection.

newLeadSelectionPath

protected TreePath newLeadSelectionPath
The new lead selection path (may be null).

oldLeadSelectionPath

protected TreePath oldLeadSelectionPath
The old lead selection path (may be null).

paths

protected TreePath[] paths
The paths that have been added or removed from the selection.

Constructor Details

TreeSelectionEvent

public TreeSelectionEvent(Object source,
                          TreePath path,
                          boolean isNew,
                          TreePath oldLeadSelectionPath,
                          TreePath newLeadSelectionPath)
Creates a new TreeSelectionEvent.
Parameters:
source - the event source (usually a TreeSelectionModel, null not permitted).
path - the path.
isNew - true indicates that path has been added to the selection, and false indicates that it has been removed.
oldLeadSelectionPath - the old lead selection path (null permitted).
newLeadSelectionPath - the new lead selection path (null permitted).
Throws:
IllegalArgumentException - if source is null.

TreeSelectionEvent

public TreeSelectionEvent(Object source,
                          TreePath[] paths,
                          boolean[] areNew,
                          TreePath oldLeadSelectionPath,
                          TreePath newLeadSelectionPath)
Creates a new TreeSelectionEvent.
Parameters:
source - the source (usually a TreeSelectionModel, null not permitted).
paths - an array of the paths that have been added to or removed from the selection.
areNew - a flag for each path where true indicates the corresponding path has been added to the selection and false indicates the path has been removed.
oldLeadSelectionPath - the old lead selection path (null permitted).
newLeadSelectionPath - the new lead selection path (null permitted).
Throws:
IllegalArgumentException - if source is null.

Method Details

cloneWithSource

public Object cloneWithSource(Object source)
Creates a shallow copy of this TreeSelectionEvent, replacing the source with source.
Parameters:
source - the new event source (null not permitted).
Returns:
A cloned event with another event source.
Throws:
IllegalArgumentException - if source is null.

getNewLeadSelectionPath

public TreePath getNewLeadSelectionPath()
Returns the new lead selection path.
Returns:
The new lead selection path (possibly null).
See Also:
getOldLeadSelectionPath()

getOldLeadSelectionPath

public TreePath getOldLeadSelectionPath()
Returns the old lead selection path.
Returns:
The old lead selection path (possibly null).
See Also:
getNewLeadSelectionPath()

getPath

public TreePath getPath()
Returns the first path element.
Returns:
The first path element.
See Also:
getPaths()

getPaths

public TreePath[] getPaths()
Returns an array of the paths that changed in the selection.
Returns:
The paths that changed in the selection.
See Also:
isAddedPath(TreePath)

isAddedPath

public boolean isAddedPath()
Returns true if the path returned by getPath() has been added to the selection, and false if it has been removed.
Returns:
A boolean.
See Also:
isAddedPath(int)

isAddedPath

public boolean isAddedPath(int index)
Returns true if the path at the specified index has been added to the selection, and false if the path has been removed from the selection.
Parameters:
index - the path index.
Returns:
A flag indicating whether the path has been added to, or removed from, the selection.
Since:
1.3
See Also:
isAddedPath(TreePath)

isAddedPath

public boolean isAddedPath(TreePath path)
Returns true if path has been added to the selection, and false if the path has been removed from the selection.
Parameters:
path - the path to check.
Returns:
A flag indicating whether the path has been added to, or removed from, the selection.
See Also:
isAddedPath(int)
TreeSelectionEvent.java -- Copyright (C) 2002, 2004, 2005, 2006, Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath 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 for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About