javax.swing.event

Class TreeSelectionEvent

public class TreeSelectionEvent extends EventObject

An event that carries information about a change to a {@link TreeSelectionModel}.

See Also:

Field Summary
protected boolean[]areNew
Flags indicating if the paths were added (true) or removed (false) from the selection.
protected TreePathnewLeadSelectionPath
The new lead selection path (may be null).
protected TreePatholdLeadSelectionPath
The old lead selection path (may be null).
protected TreePath[]paths
The paths that have been added or removed from the selection.
Constructor Summary
TreeSelectionEvent(Object source, TreePath[] paths, boolean[] areNew, TreePath oldLeadSelectionPath, TreePath newLeadSelectionPath)
Creates a new TreeSelectionEvent.
TreeSelectionEvent(Object source, TreePath path, boolean isNew, TreePath oldLeadSelectionPath, TreePath newLeadSelectionPath)
Creates a new TreeSelectionEvent.
Method Summary
ObjectcloneWithSource(Object source)
Creates a shallow copy of this TreeSelectionEvent, replacing the source with source.
TreePathgetNewLeadSelectionPath()
Returns the new lead selection path.
TreePathgetOldLeadSelectionPath()
Returns the old lead selection path.
TreePathgetPath()
Returns the first path element.
TreePath[]getPaths()
Returns an array of the paths that changed in the selection.
booleanisAddedPath()
Returns true if the path returned by {@link #getPath()} has been added to the selection, and false if it has been removed.
booleanisAddedPath(TreePath path)
Returns true if path has been added to the selection, and false if the path has been removed from the selection.
booleanisAddedPath(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.

Field Detail

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 Detail

TreeSelectionEvent

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

Parameters: source the source (usually a {@link 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.

TreeSelectionEvent

public TreeSelectionEvent(Object source, TreePath path, boolean isNew, TreePath oldLeadSelectionPath, TreePath newLeadSelectionPath)
Creates a new TreeSelectionEvent.

Parameters: source the event source (usually a {@link 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.

Method Detail

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

isAddedPath

public boolean isAddedPath()
Returns true if the path returned by {@link #getPath()} has been added to the selection, and false if it has been removed.

Returns: A boolean.

See Also: TreeSelectionEvent

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: TreeSelectionEvent

UNKNOWN: IllegalArgumentException if path is not one of the paths in {@link #getPaths()}.

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