public class DefaultTreeSelectionModel extends Object implements Cloneable, Serializable, TreeSelectionModel
Default implementation of TreeSelectionModel. Listeners are notified whenever the paths in the selection change, not the rows. In order to be able to track row changes you may wish to become a listener for expansion events on the tree and test for changes from there.
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.
JTreepublic static final String SELECTION_MODE_PROPERTY
Property name for selectionMode.
protected SwingPropertyChangeSupport changeSupport
Used to messaged registered listeners.
protected TreePath[] selection
Paths that are currently selected. Will be null if nothing is currently selected.
protected EventListenerList listenerList
Event listener list.
protected transient RowMapper rowMapper
Provides a row for a given path.
protected DefaultListSelectionModel listSelectionModel
Handles maintaining the list selection model. The RowMapper is used to map from a TreePath to a row, and the value is then placed here.
protected int selectionMode
Mode for the selection, will be either SINGLE_TREE_SELECTION, CONTIGUOUS_TREE_SELECTION or DISCONTIGUOUS_TREE_SELECTION.
protected TreePath leadPath
Last path that was added.
protected int leadIndex
Index of the lead path in selection.
protected int leadRow
Lead row.
public DefaultTreeSelectionModel()
Creates a new instance of DefaultTreeSelectionModel that is empty, with a selection mode of DISCONTIGUOUS_TREE_SELECTION.
public void setRowMapper(RowMapper newMapper)
Sets the RowMapper instance. This instance is used to determine the row for a particular TreePath.
setRowMapper in interface TreeSelectionModel
public RowMapper getRowMapper()
Returns the RowMapper instance that is able to map a TreePath to a row.
getRowMapper in interface TreeSelectionModel
public void setSelectionMode(int mode)
Sets the selection model, which must be one of SINGLE_TREE_SELECTION, CONTIGUOUS_TREE_SELECTION or DISCONTIGUOUS_TREE_SELECTION. If mode is not one of the defined value, 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
public int getSelectionMode()
Returns the selection mode, one of SINGLE_TREE_SELECTION, DISCONTIGUOUS_TREE_SELECTION or CONTIGUOUS_TREE_SELECTION.
getSelectionMode in interface TreeSelectionModel
public 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.
setSelectionPath in interface TreeSelectionModel
path - new path to selectpublic void setSelectionPaths(TreePath[] pPaths)
Sets the selection. Whether the supplied paths are taken as the new selection depends upon the selection mode. If the supplied array is 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 TreeSelectionListeners 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)
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.
addSelectionPath in interface TreeSelectionModel
path - the new path to add to the current selectionpublic 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.
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)
Removes path from the selection. If path is in the selection The TreeSelectionListeners are notified. This has no effect if path is null.
removeSelectionPath in interface TreeSelectionModel
path - the path to remove from the selectionpublic void removeSelectionPaths(TreePath[] paths)
Removes paths from the selection. If any of the paths in paths are in the selection the TreeSelectionListeners are notified. This has no effect if paths is null.
removeSelectionPaths in interface TreeSelectionModel
paths - the paths to remove from the selectionpublic TreePath getSelectionPath()
Returns the first path in the selection. This is useful if there if only one item currently selected.
getSelectionPath in interface TreeSelectionModel
public TreePath[] getSelectionPaths()
Returns the selection.
getSelectionPaths in interface TreeSelectionModel
public int getSelectionCount()
Returns the number of paths that are selected.
getSelectionCount in interface TreeSelectionModel
public boolean isPathSelected(TreePath path)
Returns true if the path, path, is in the current selection.
isPathSelected in interface TreeSelectionModel
public boolean isSelectionEmpty()
Returns true if the selection is currently empty.
isSelectionEmpty in interface TreeSelectionModel
public void clearSelection()
Empties the current selection. If this represents a change in the current selection, the selection listeners are notified.
clearSelection in interface TreeSelectionModel
public void addTreeSelectionListener(TreeSelectionListener x)
Adds x to the list of listeners that are notified each time the set of selected TreePaths changes.
addTreeSelectionListener in interface TreeSelectionModel
x - the new listener to be addedpublic void removeTreeSelectionListener(TreeSelectionListener x)
Removes x from the list of listeners that are notified each time the set of selected TreePaths changes.
removeTreeSelectionListener in interface TreeSelectionModel
x - the listener to removepublic TreeSelectionListener[] getTreeSelectionListeners()
Returns an array of all the tree selection listeners registered on this model.
TreeSelectionListeners or an empty array if no tree selection listeners are currently registeredaddTreeSelectionListener(javax.swing.event.TreeSelectionListener), removeTreeSelectionListener(javax.swing.event.TreeSelectionListener)
protected void fireValueChanged(TreeSelectionEvent e)
Notifies all listeners that are registered for tree selection events on this object.
public <T extends EventListener> T[] getListeners(Class<T> listenerType)
Returns an array of all the objects currently registered as FooListeners upon this model. FooListeners 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.
listenerType - the type of listeners requested; this parameter should specify an interface that descends from java.util.EventListener
FooListeners 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
getTreeSelectionListeners(), getPropertyChangeListeners()
public int[] getSelectionRows()
Returns the selection in terms of rows. There is not necessarily a one-to-one mapping between the TreePaths 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()
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.
getMinSelectionRow in interface TreeSelectionModel
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.
getMaxSelectionRow in interface TreeSelectionModel
public boolean isRowSelected(int row)
Returns true if the row identified by row is selected.
isRowSelected in interface TreeSelectionModel
public void resetRowSelection()
Updates this object's mapping from TreePath 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.
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()
Returns the lead selection index. That is the last index that was added.
getLeadSelectionRow in interface TreeSelectionModel
public TreePath getLeadSelectionPath()
Returns the last path that was added. This may differ from the leadSelectionPath property maintained by the JTree.
getLeadSelectionPath in interface TreeSelectionModel
public void addPropertyChangeListener(PropertyChangeListener listener)
Adds a PropertyChangeListener to the listener list. The listener is registered for all properties.
A PropertyChangeEvent will get fired when the selection mode changes.
addPropertyChangeListener in interface TreeSelectionModel
listener - the PropertyChangeListener to be addedpublic void removePropertyChangeListener(PropertyChangeListener listener)
Removes a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties.
removePropertyChangeListener in interface TreeSelectionModel
listener - the PropertyChangeListener to be removedpublic PropertyChangeListener[] getPropertyChangeListeners()
Returns an array of all the property change listeners registered on this DefaultTreeSelectionModel.
PropertyChangeListeners or an empty array if no property change listeners are currently registeredaddPropertyChangeListener(java.beans.PropertyChangeListener), removePropertyChangeListener(java.beans.PropertyChangeListener)
protected void insureRowContinuity()
Makes sure the currently selected TreePaths 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)
Returns true if the paths are contiguous, or this object has no RowMapper.
protected boolean canPathsBeAdded(TreePath[] paths)
Used to test if a particular set of TreePaths 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 TreePaths.
protected boolean canPathsBeRemoved(TreePath[] paths)
Returns true if the paths can be removed without breaking the continuity of the model. This is rather expensive.
@Deprecated
protected void notifyPathChange(Vector<?> changedPaths,
TreePath oldLeadSelection) Deprecated. As of JDK version 1.7
Notifies listeners of a change in path. changePaths should contain instances of PathPlaceHolder.
protected void updateLeadIndex()
Updates the leadIndex instance variable.
protected void insureUniqueness()
This method is obsolete and its implementation is now a noop. It's still called by setSelectionPaths and addSelectionPaths, but only for backwards compatibility.
public String toString()
Returns a string that displays and identifies this object's properties.
public Object clone()
throws CloneNotSupportedException Returns a clone of this object with the same selection. This method does not duplicate selection listeners and property listeners.
clone in class Object
CloneNotSupportedException - never thrown by instances of this classCloneable
© 1993–2017, 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.