Serializable
, Cloneable
, TreeSelectionModel
JTree.EmptySelectionModel
public class DefaultTreeSelectionModel extends Object implements Cloneable, Serializable, TreeSelectionModel
resetRowSelection is called from any of the methods that update the selected paths. If you subclass any of these methods to filter what is allowed to be selected, be sure and message resetRowSelection
if you do not message super. Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans has been added to the java.beans
package. Please see XMLEncoder
.
Modifier and Type | Field | Description |
---|---|---|
protected SwingPropertyChangeSupport |
changeSupport |
Used to messaged registered listeners. |
protected int |
leadIndex |
Index of the lead path in selection. |
protected TreePath |
leadPath |
Last path that was added. |
protected int |
leadRow |
Lead row. |
protected EventListenerList |
listenerList |
Event listener list. |
protected DefaultListSelectionModel |
listSelectionModel |
Handles maintaining the list selection model. |
protected RowMapper |
rowMapper |
Provides a row for a given path. |
protected TreePath[] |
selection |
Paths that are currently selected. |
static final String |
SELECTION_MODE_PROPERTY |
Property name for selectionMode. |
protected int |
selectionMode |
Mode for the selection, will be either SINGLE_TREE_SELECTION, CONTIGUOUS_TREE_SELECTION or DISCONTIGUOUS_TREE_SELECTION. |
CONTIGUOUS_TREE_SELECTION, DISCONTIGUOUS_TREE_SELECTION, SINGLE_TREE_SELECTION
Constructor | Description |
---|---|
DefaultTreeSelectionModel() |
Creates a new instance of DefaultTreeSelectionModel that is empty, with a selection mode of DISCONTIGUOUS_TREE_SELECTION. |
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. |
protected boolean |
arePathsContiguous |
Returns true if the paths are contiguous, or this object has no RowMapper. |
protected boolean |
canPathsBeAdded |
Used to test if a particular set of TreePath s can be added. |
protected boolean |
canPathsBeRemoved |
Returns true if the paths can be removed without breaking the continuity of the model. |
void |
clearSelection() |
Empties the current selection. |
Object |
clone() |
Returns a clone of this object with the same selection. |
protected void |
fireValueChanged |
Notifies all listeners that are registered for tree selection events on this object. |
TreePath |
getLeadSelectionPath() |
Returns the last path that was added. |
int |
getLeadSelectionRow() |
Returns the lead selection index. |
<T extends EventListener> |
getListeners |
Returns an array of all the objects currently registered as FooListener s upon this model. |
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. |
PropertyChangeListener[] |
getPropertyChangeListeners() |
Returns an array of all the property change listeners registered on this DefaultTreeSelectionModel . |
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 selection mode, one of SINGLE_TREE_SELECTION , DISCONTIGUOUS_TREE_SELECTION or CONTIGUOUS_TREE_SELECTION . |
TreePath |
getSelectionPath() |
Returns the first path in the selection. |
TreePath[] |
getSelectionPaths() |
Returns the selection. |
int[] |
getSelectionRows() |
Returns the selection in terms of rows. |
TreeSelectionListener[] |
getTreeSelectionListeners() |
Returns an array of all the tree selection listeners registered on this model. |
protected void |
insureRowContinuity() |
Makes sure the currently selected TreePath s are valid for the current selection mode. |
protected void |
insureUniqueness() |
This method is obsolete and its implementation is now a noop. |
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. |
protected void |
notifyPathChange |
Deprecated. As of JDK version 1.7 |
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 TreePath 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. |
String |
toString() |
Returns a string that displays and identifies this object's properties. |
protected void |
updateLeadIndex() |
Updates the leadIndex instance variable. |
public static final String SELECTION_MODE_PROPERTY
protected SwingPropertyChangeSupport changeSupport
protected TreePath[] selection
protected EventListenerList listenerList
protected transient RowMapper rowMapper
protected DefaultListSelectionModel listSelectionModel
protected int selectionMode
protected TreePath leadPath
protected int leadIndex
protected int leadRow
public DefaultTreeSelectionModel()
public void setRowMapper(RowMapper newMapper)
setRowMapper
in interface TreeSelectionModel
newMapper
- RowMapper to be setpublic RowMapper getRowMapper()
getRowMapper
in interface TreeSelectionModel
public void setSelectionMode(int mode)
DISCONTIGUOUS_TREE_SELECTION
is assumed. 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.
Setting the mode to something other than the defined types will result in the mode becoming DISCONTIGUOUS_TREE_SELECTION
.
setSelectionMode
in interface TreeSelectionModel
mode
- selection mode to be setpublic int getSelectionMode()
SINGLE_TREE_SELECTION
, DISCONTIGUOUS_TREE_SELECTION
or CONTIGUOUS_TREE_SELECTION
.getSelectionMode
in interface TreeSelectionModel
public void setSelectionPath(TreePath path)
path
is null, this has the same effect as invoking clearSelection
.setSelectionPath
in interface TreeSelectionModel
path
- new path to selectpublic void setSelectionPaths(TreePath[] pPaths)
null
, or empty, the selection is cleared. If the selection mode is SINGLE_TREE_SELECTION
, only the first path in pPaths
is used. If the selection mode is CONTIGUOUS_TREE_SELECTION
and the supplied paths are not contiguous, then only the first path in pPaths
is used. If the selection mode is DISCONTIGUOUS_TREE_SELECTION
, then all paths are used. All null
paths in pPaths
are ignored.
If this represents a change, all registered
TreeSelectionListener
s are notified.
The lead path is set to the last unique path.
The paths returned from getSelectionPaths
are in the same order as those supplied to this method.
setSelectionPaths
in interface TreeSelectionModel
pPaths
- the new selectionpublic void addSelectionPath(TreePath path)
path
is null.addSelectionPath
in interface TreeSelectionModel
path
- the new path to add to the current selectionpublic void addSelectionPaths(TreePath[] paths)
paths
is null. The lead path is set to the last element in paths
.
If the selection mode is CONTIGUOUS_TREE_SELECTION
, and adding the new paths would make the selection discontiguous. Then two things can result: if the TreePaths in paths
are contiguous, then the selection becomes these TreePaths, otherwise the TreePaths aren't contiguous and the selection becomes the first TreePath in paths
.
addSelectionPaths
in interface TreeSelectionModel
paths
- the new path to add to the current selectionpublic void removeSelectionPath(TreePath path)
path
is null.removeSelectionPath
in interface TreeSelectionModel
path
- the path to remove from the selectionpublic void removeSelectionPaths(TreePath[] paths)
paths
is null.removeSelectionPaths
in interface TreeSelectionModel
paths
- the paths to remove from the selectionpublic TreePath getSelectionPath()
getSelectionPath
in interface TreeSelectionModel
public TreePath[] getSelectionPaths()
getSelectionPaths
in interface TreeSelectionModel
public int getSelectionCount()
getSelectionCount
in interface TreeSelectionModel
public boolean isPathSelected(TreePath path)
path
, is in the current selection.isPathSelected
in interface TreeSelectionModel
path
- the path to be loked forpath
is in the current selectionpublic boolean isSelectionEmpty()
isSelectionEmpty
in interface TreeSelectionModel
public void clearSelection()
clearSelection
in interface TreeSelectionModel
public void addTreeSelectionListener(TreeSelectionListener x)
addTreeSelectionListener
in interface TreeSelectionModel
x
- the new listener to be addedpublic void removeTreeSelectionListener(TreeSelectionListener x)
removeTreeSelectionListener
in interface TreeSelectionModel
x
- the listener to removepublic TreeSelectionListener[] getTreeSelectionListeners()
TreeSelectionListener
s or an empty array if no tree selection listeners are currently registeredprotected void fireValueChanged(TreeSelectionEvent e)
e
- the event that characterizes the changepublic <T extends EventListener> T[] getListeners(Class<T> listenerType)
FooListener
s upon this model. FooListener
s are registered using the addFooListener
method. You can specify the listenerType
argument with a class literal, such as FooListener.class
. For example, you can query a DefaultTreeSelectionModel
m
for its tree selection listeners with the following code:
TreeSelectionListener[] tsls = (TreeSelectionListener[])(m.getListeners(TreeSelectionListener.class));If no such listeners exist, this method returns an empty array.
T
- the listener typelistenerType
- the type of listeners requestedFooListener
s on this component, or an empty array if no such listeners have been addedClassCastException
- if listenerType
doesn't specify a class or interface that implements java.util.EventListener
public int[] getSelectionRows()
TreePath
s returned from getSelectionPaths
and this method. In particular, if a TreePath
is not viewable (the
RowMapper
returns -1
for the row corresponding to the TreePath
), then the corresponding row is not included in the returned array. For example, if the selection consists of two paths, A
and B
, with A
at row 10
, and B
not currently viewable, then this method returns an array with the single entry 10
.getSelectionRows
in interface TreeSelectionModel
public int getMinSelectionRow()
getMinSelectionRow
in interface TreeSelectionModel
public int getMaxSelectionRow()
getMaxSelectionRow
in interface TreeSelectionModel
public boolean isRowSelected(int row)
row
is selected.isRowSelected
in interface TreeSelectionModel
row
- row to checkpublic void 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.
This will invoke insureRowContinuity
to make sure the currently selected TreePaths are still valid based on the selection mode.
resetRowSelection
in interface TreeSelectionModel
public int getLeadSelectionRow()
getLeadSelectionRow
in interface TreeSelectionModel
public TreePath getLeadSelectionPath()
getLeadSelectionPath
in interface TreeSelectionModel
public void addPropertyChangeListener(PropertyChangeListener listener)
A PropertyChangeEvent will get fired when the selection mode changes.
addPropertyChangeListener
in interface TreeSelectionModel
listener
- the PropertyChangeListener to be addedpublic void removePropertyChangeListener(PropertyChangeListener listener)
removePropertyChangeListener
in interface TreeSelectionModel
listener
- the PropertyChangeListener to be removedpublic PropertyChangeListener[] getPropertyChangeListeners()
DefaultTreeSelectionModel
.PropertyChangeListener
s or an empty array if no property change listeners are currently registeredprotected void insureRowContinuity()
TreePath
s are valid for the current selection mode. If the selection mode is CONTIGUOUS_TREE_SELECTION
and a RowMapper
exists, this will make sure all the rows are contiguous, that is, when sorted all the rows are in order with no gaps. If the selection isn't contiguous, the selection is reset to contain the first set, when sorted, of contiguous rows. If the selection mode is SINGLE_TREE_SELECTION
and more than one TreePath is selected, the selection is reset to contain the first path currently selected.
protected boolean arePathsContiguous(TreePath[] paths)
paths
- array of paths to checkprotected boolean canPathsBeAdded(TreePath[] paths)
TreePath
s can be added. This will return true if paths
is null (or empty), or this object has no RowMapper, or nothing is currently selected, or the selection mode is DISCONTIGUOUS_TREE_SELECTION
, or adding the paths to the current selection still results in a contiguous set of TreePath
s.paths
- array of TreePaths
to checkTreePaths
can be addedprotected boolean canPathsBeRemoved(TreePath[] paths)
paths
- array of TreePath
to check@Deprecated protected void notifyPathChange(Vector<?> changedPaths, TreePath oldLeadSelection)
changedPaths
- the vector of the changed pathsoldLeadSelection
- the old selection pathprotected void updateLeadIndex()
protected void insureUniqueness()
public String toString()
public Object clone() throws CloneNotSupportedException
clone
in class Object
CloneNotSupportedException
- never thrown by instances of this class
© 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/DefaultTreeSelectionModel.html