TreeSelectionModel JDK 1.6)

Description

public interface TreeSelectionModel

This interface represents the current state of the selection for the tree component.

This interface represents the current state of the selection for the tree component. For information and examples of using tree selection models, see How to Use Trees in The Java Tutorial.

The state of the tree selection is characterized by a set of TreePaths, and optionally a set of integers. The mapping from TreePath to integer is done by way of an instance of RowMapper. It is not necessary for a TreeSelectionModel to have a RowMapper to correctly operate, but without a RowMapper getSelectionRows will return null.

A TreeSelectionModel can be configured to allow only one path (SINGLE_TREE_SELECTION) a number of continguous paths (CONTIGUOUS_TREE_SELECTION) or a number of discontiguous paths (DISCONTIGUOUS_TREE_SELECTION). A RowMapper is used to determine if TreePaths are contiguous. In the absence of a RowMapper CONTIGUOUS_TREE_SELECTION and DISCONTIGUOUS_TREE_SELECTION behave the same, that is they allow any number of paths to be contained in the TreeSelectionModel.

For a selection model of CONTIGUOUS_TREE_SELECTION any time the paths are changed (setSelectionPath, addSelectionPath ...) the TreePaths are again checked to make they are contiguous. A check of the TreePaths can also be forced by invoking resetRowSelection. How a set of discontiguous TreePaths is mapped to a contiguous set is left to implementors of this interface to enforce a particular policy.

Implementations should combine duplicate TreePaths that are added to the selection. For example, the following code

   TreePath[] paths = new TreePath[] { treePath, treePath };
   treeSelectionModel.setSelectionPaths(paths);

should result in only one path being selected: treePath, and not two copies of treePath.

The lead TreePath is the last path that was added (or set). The lead row is then the row that corresponds to the TreePath as determined from the RowMapper.

See also:

Methods

Hide/Show inherited methods

public void addPropertyChangeListener (PropertyChangeListener listener)

Adds a PropertyChangeListener to the listener list.

public void addSelectionPath (TreePath path)

Adds path to the current selection.

Adds path to the current selection. If path is not currently
in the selection the TreeSelectionListeners are notified. This has
no effect if path is null.
Parameters:
- path - the new path to add to the current selection

public void addSelectionPaths (TreePath paths)

Adds paths to the current selection.

Adds paths to the current selection. If any of the paths in
paths are not currently in the selection the TreeSelectionListeners
are notified. This has
no effect if paths is null.
Parameters:
- paths - the new paths to add to the current selection

public void addTreeSelectionListener (TreeSelectionListener x)

Adds x to the list of listeners that are notified each time the set of selected TreePaths changes.

public void clearSelection ()

Empties the current selection.

public TreePath getLeadSelectionPath ()

Returns the last path that was added.

public int getLeadSelectionRow ()

Returns the lead selection index.

public int getMaxSelectionRow ()

Returns the largest value obtained from the RowMapper for the current set of selected TreePaths.

public int getMinSelectionRow ()

Returns the smallest value obtained from the RowMapper for the current set of selected TreePaths.

public RowMapper getRowMapper ()

Returns the RowMapper instance that is able to map a TreePath to a row.

public int getSelectionCount ()

Returns the number of paths that are selected.

public int getSelectionMode ()

Returns the current selection mode, one of SINGLE_TREE_SELECTION, CONTIGUOUS_TREE_SELECTION or DISCONTIGUOUS_TREE_SELECTION.

public TreePath getSelectionPath ()

Returns the first path in the selection.

Returns the first path in the selection. How first is defined is
up to implementors, and may not necessarily be the TreePath with
the smallest integer value as determined from the
RowMapper.

public TreePath getSelectionPaths ()

Returns the paths in the selection.

public int getSelectionRows ()

Returns all of the currently selected rows.

public boolean isPathSelected (TreePath path)

Returns true if the path, path, is in the current selection.

public boolean isRowSelected (int row)

Returns true if the row identified by row is selected.

public boolean isSelectionEmpty ()

Returns true if the selection is currently empty.

public void removePropertyChangeListener (PropertyChangeListener listener)

Removes a PropertyChangeListener from the listener list.

public void removeSelectionPath (TreePath path)

Removes path from the selection.

Removes path from the selection. If path is in the selection
The TreeSelectionListeners are notified. This has no effect if
path is null.
Parameters:
- path - the path to remove from the selection

public void removeSelectionPaths (TreePath paths)

Removes paths from the selection.

Removes paths from the selection. If any of the paths in
paths
are in the selection, the TreeSelectionListeners are notified.
This method has no effect if paths is null.
Parameters:
- paths - the path to remove from the selection

public void removeTreeSelectionListener (TreeSelectionListener x)

Removes x from the list of listeners that are notified each time the set of selected TreePaths changes.

public void resetRowSelection ()

Updates this object's mapping from TreePaths to rows.

public void setRowMapper (RowMapper newMapper)

Sets the RowMapper instance.

public void setSelectionMode (int mode)

Sets the selection model, which must be one of SINGLE_TREE_SELECTION, CONTIGUOUS_TREE_SELECTION or DISCONTIGUOUS_TREE_SELECTION.

public void setSelectionPath (TreePath path)

Sets the selection to path.

Sets the selection to path. If this represents a change, then
the TreeSelectionListeners are notified. If path is
null, this has the same effect as invoking clearSelection.
Parameters:
- path - new path to select

public void setSelectionPaths (TreePath paths)

Sets the selection to path.

Sets the selection to path. If this represents a change, then
the TreeSelectionListeners are notified. If paths is
null, this has the same effect as invoking clearSelection.
Parameters:
- paths - new selection