DefaultTreeSelectionModel
, JTree.EmptySelectionModel
public interface TreeSelectionModel
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 contiguous 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.
Modifier and Type | Field | Description |
---|---|---|
static final int |
CONTIGUOUS_TREE_SELECTION |
Selection can only be contiguous. |
static final int |
DISCONTIGUOUS_TREE_SELECTION |
Selection can contain any number of items that are not necessarily contiguous. |
static final int |
SINGLE_TREE_SELECTION |
Selection can only contain one path at a time. |
Modifier and Type | Method | Description |
---|---|---|
void |
addPropertyChangeListener |
Adds a PropertyChangeListener to the listener list. |
void |
addSelectionPath |
Adds path to the current selection. |
void |
addSelectionPaths |
Adds paths to the current selection. |
void |
addTreeSelectionListener |
Adds x to the list of listeners that are notified each time the set of selected TreePaths changes. |
void |
clearSelection() |
Empties the current selection. |
TreePath |
getLeadSelectionPath() |
Returns the last path that was added. |
int |
getLeadSelectionRow() |
Returns the lead selection index. |
int |
getMaxSelectionRow() |
Returns the largest value obtained from the RowMapper for the current set of selected TreePaths. |
int |
getMinSelectionRow() |
Returns the smallest value obtained from the RowMapper for the current set of selected TreePaths. |
RowMapper |
getRowMapper() |
Returns the RowMapper instance that is able to map a TreePath to a row. |
int |
getSelectionCount() |
Returns the number of paths that are selected. |
int |
getSelectionMode() |
Returns the current selection mode, one of SINGLE_TREE_SELECTION , CONTIGUOUS_TREE_SELECTION or DISCONTIGUOUS_TREE_SELECTION . |
TreePath |
getSelectionPath() |
Returns the first path in the selection. |
TreePath[] |
getSelectionPaths() |
Returns the paths in the selection. |
int[] |
getSelectionRows() |
Returns all of the currently selected rows. |
boolean |
isPathSelected |
Returns true if the path, path , is in the current selection. |
boolean |
isRowSelected |
Returns true if the row identified by row is selected. |
boolean |
isSelectionEmpty() |
Returns true if the selection is currently empty. |
void |
removePropertyChangeListener |
Removes a PropertyChangeListener from the listener list. |
void |
removeSelectionPath |
Removes path from the selection. |
void |
removeSelectionPaths |
Removes paths from the selection. |
void |
removeTreeSelectionListener |
Removes x from the list of listeners that are notified each time the set of selected TreePaths changes. |
void |
resetRowSelection() |
Updates this object's mapping from TreePaths to rows. |
void |
setRowMapper |
Sets the RowMapper instance. |
void |
setSelectionMode |
Sets the selection model, which must be one of SINGLE_TREE_SELECTION, CONTIGUOUS_TREE_SELECTION or DISCONTIGUOUS_TREE_SELECTION. |
void |
setSelectionPath |
Sets the selection to path. |
void |
setSelectionPaths |
Sets the selection to path. |
static final int SINGLE_TREE_SELECTION
static final int CONTIGUOUS_TREE_SELECTION
static final int DISCONTIGUOUS_TREE_SELECTION
void setSelectionMode(int mode)
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 SINGLE_TREE_SELECTION
, only one TreePath will remain selected. It is up to the particular implementation to decide what TreePath remains selected.
mode
- selection mode to be setint getSelectionMode()
SINGLE_TREE_SELECTION
, CONTIGUOUS_TREE_SELECTION
or DISCONTIGUOUS_TREE_SELECTION
.void setSelectionPath(TreePath path)
path
is null, this has the same effect as invoking clearSelection
.path
- new path to selectvoid setSelectionPaths(TreePath[] paths)
paths
is null, this has the same effect as invoking clearSelection
.paths
- new selectionvoid addSelectionPath(TreePath path)
path
is null.path
- the new path to add to the current selectionvoid addSelectionPaths(TreePath[] paths)
paths
is null.paths
- the new paths to add to the current selectionvoid removeSelectionPath(TreePath path)
path
is null.path
- the path to remove from the selectionvoid removeSelectionPaths(TreePath[] paths)
paths
are in the selection, the TreeSelectionListeners are notified. This method has no effect if paths
is null.paths
- the path to remove from the selectionTreePath getSelectionPath()
RowMapper
.TreePath[] getSelectionPaths()
int getSelectionCount()
boolean isPathSelected(TreePath path)
path
, is in the current selection.path
- the path to be loked forpath
is in the current selectionboolean isSelectionEmpty()
void clearSelection()
void setRowMapper(RowMapper newMapper)
newMapper
- RowMapper to be setRowMapper getRowMapper()
int[] getSelectionRows()
int getMinSelectionRow()
int getMaxSelectionRow()
boolean isRowSelected(int row)
row
is selected.row
- row to checkvoid resetRowSelection()
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.
int getLeadSelectionRow()
TreePath getLeadSelectionPath()
void addPropertyChangeListener(PropertyChangeListener listener)
A PropertyChangeEvent will get fired when the selection mode changes.
listener
- the PropertyChangeListener to be addedvoid removePropertyChangeListener(PropertyChangeListener listener)
listener
- the PropertyChangeListener to be removedvoid addTreeSelectionListener(TreeSelectionListener x)
x
- the new listener to be addedvoid removeTreeSelectionListener(TreeSelectionListener x)
x
- the listener to remove
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/tree/TreeSelectionModel.html