TreeSelectionModel (Java SE 19 & JDK 19) (original) (raw)

Method Details

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 SINGLE_TREE_SELECTION, only one TreePath will remain selected. It is up to the particular implementation to decide what TreePath remains selected.
Parameters:
mode - selection mode to be set

int getSelectionMode()
Returns the current selection mode, one ofSINGLE_TREE_SELECTION,CONTIGUOUS_TREE_SELECTION orDISCONTIGUOUS_TREE_SELECTION.
Returns:
the current selection mode

void setSelectionPath(TreePath 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

void setSelectionPaths(TreePath[] paths)
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

void addSelectionPath(TreePath path)
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

void addSelectionPaths(TreePath[] paths)
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

void removeSelectionPath(TreePath path)
Removes path from the selection. If path is in the selection The TreeSelectionListeners are notified. This has no effect ifpath is null.
Parameters:
path - the path to remove from the selection

void removeSelectionPaths(TreePath[] paths)
Removes paths from the selection. If any of the paths inpaths 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

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 theRowMapper.
Returns:
the first path in the selection

Returns the paths in the selection. This will return null (or an empty array) if nothing is currently selected.
Returns:
the paths in the selection

int getSelectionCount()
Returns the number of paths that are selected.
Returns:
the number of paths that are selected

boolean isPathSelected(TreePath path)
Returns true if the path, path, is in the current selection.
Parameters:
path - the path to be loked for
Returns:
whether the path is in the current selection

boolean isSelectionEmpty()
Returns true if the selection is currently empty.
Returns:
whether the selection is currently empty

void clearSelection()
Empties the current selection. If this represents a change in the current selection, the selection listeners are notified.

void setRowMapper(RowMapper newMapper)
Sets the RowMapper instance. This instance is used to determine the row for a particular TreePath.
Parameters:
newMapper - RowMapper to be set

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

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.
Returns:
all of the currently selected rows

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.
Returns:
the smallest value obtained from the RowMapper for the current set of selected TreePaths

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.
Returns:
the largest value obtained from the RowMapper for the current set of selected TreePaths

boolean isRowSelected(int row)
Returns true if the row identified by row is selected.
Parameters:
row - row to check
Returns:
whether the row is selected

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.

int getLeadSelectionRow()
Returns the lead selection index. That is the last index that was added.
Returns:
the lead selection index

Returns the last path that was added. This may differ from the leadSelectionPath property maintained by the JTree.
Returns:
the last path that was added

Adds a PropertyChangeListener to the listener list. The listener is registered for all properties.
A PropertyChangeEvent will get fired when the selection mode changes.
Parameters:
listener - the PropertyChangeListener to be added

Removes a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties.
Parameters:
listener - the PropertyChangeListener to be removed

Adds x to the list of listeners that are notified each time the set of selected TreePaths changes.
Parameters:
x - the new listener to be added

Removes x from the list of listeners that are notified each time the set of selected TreePaths changes.
Parameters:
x - the listener to remove