TreeSelectionModel
Java SE 6
| public interface javax.swing.tree TreeSelectionModel
|
Java SE 6 |
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.
| version | 1.25 11/17/05 |
| Fields | |
|---|---|
| final public static int | SINGLE_TREE_SELECTION Selection can only contain one path at a time. |
| final public static int | CONTIGUOUS_TREE_SELECTION Selection can only be contiguous. This will only be enforced if a RowMapper instance is provided. That is, if no RowMapper is set this behaves the same as DISCONTIGUOUS_TREE_SELECTION. |
| final public static int | DISCONTIGUOUS_TREE_SELECTION Selection can contain any number of items that are not necessarily contiguous. |
| Methods | |||
|---|---|---|---|
| public void | addPropertyChangeListener(PropertyChangeListener listener) Details
Adds a PropertyChangeListener to the listener list.
The listener is registered for all properties.
A PropertyChangeEvent will get fired when the selection mode changes.
| ||
| public void | addSelectionPath(TreePath path) Details
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.
| ||
| public void | addSelectionPaths(TreePath[] paths) Details
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.
| ||
| public void | addTreeSelectionListener(TreeSelectionListener x) Details
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. If this represents a change in the current selection, the selection listeners are notified. | ||
| public void | removePropertyChangeListener(PropertyChangeListener listener) Details
Removes a PropertyChangeListener from the listener list.
This removes a PropertyChangeListener that was registered
for all properties.
| ||
| public void | removeSelectionPath(TreePath path) Details
Removes path from the selection. If path is in the selection
The TreeSelectionListeners are notified. This has no effect if
path is null.
| ||
| public void | removeSelectionPaths(TreePath[] paths) Details
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.
| ||
| public void | removeTreeSelectionListener(TreeSelectionListener x) Details
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. This should be invoked when the mapping from TreePaths to integers has changed (for example, a node has been expanded). You do not normally have to call this; JTree and its associated listeners will invoke this for you. If you are implementing your own view class, then you will have to invoke this. | ||
| Properties | |||
|---|---|---|---|
| public TreePath | getLeadSelectionPath() Returns the last path that was added. This may differ from the leadSelectionPath property maintained by the JTree. | ||
| public int | getLeadSelectionRow() Returns the lead selection index. That is the last index that was added. | ||
| public int | getMaxSelectionRow() Returns the largest value obtained from the RowMapper for the current set of selected TreePaths. If nothing is selected, or there is no RowMapper, this will return -1. | ||
| public int | getMinSelectionRow() Returns the smallest value obtained from the RowMapper for the current set of selected TreePaths. If nothing is selected, or there is no RowMapper, this will return -1. | ||
| public boolean | isPathSelected(TreePath path) Returns true if the path, path, is in the current
selection.
| ||
| public void | setRowMapper(RowMapper newMapper) Sets the RowMapper instance. This instance is used to determine the row for a particular TreePath. | ||
| public RowMapper | getRowMapper() Returns the RowMapper instance that is able to map a TreePath to a row. | ||
| public boolean | isRowSelected(int row) Returns true if the row identified by row is selected.
| ||
| public int | getSelectionCount() Returns the number of paths that are selected. | ||
| public boolean | isSelectionEmpty() Returns true if the selection is currently empty. | ||
| public void | setSelectionMode(int mode) Sets the selection model, which must be one of SINGLE_TREE_SELECTION, CONTIGUOUS_TREE_SELECTION or DISCONTIGUOUS_TREE_SELECTION.
This may change the selection if the current selection is not valid
for the new mode. For example, if three TreePaths are
selected when the mode is changed to | ||
| public int | getSelectionMode() Returns the current selection mode, one of SINGLE_TREE_SELECTION,
CONTIGUOUS_TREE_SELECTION or
DISCONTIGUOUS_TREE_SELECTION.
| ||
| public void | setSelectionPath(TreePath path) Details
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.
| ||
| public TreePath | getSelectionPath() 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 void | setSelectionPaths(TreePath[] paths) Details
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.
| ||
| public TreePath[] | getSelectionPaths() Returns the paths in the selection. This will return null (or an empty array) if nothing is currently selected. | ||
| public int[] | getSelectionRows() Returns all of the currently selected rows. This will return null (or an empty array) if there are no selected TreePaths or a RowMapper has not been set. | ||
| About DocWeb · Bundles · Export · Export All | Top 10 · Statistics · Login |
| About Sun · Contact · Privacy · Terms of Use · Trademarks | Java SE 6 · Copyright © 1994-2009 Sun Microsystems, Inc.All rights reserved. Use is subject to license terms |
 |
 |
|