This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.swing.tree
class DefaultTreeSelectionModel

java.lang.Object extended by javax.swing.tree.DefaultTreeSelectionModel
All Implemented Interfaces:
Serializable, Cloneable, TreeSelectionModel
Direct Known Subclasses:
JTree.EmptySelectionModel

Most common way to construct:

DefaultTreeSelectionModel dtsm = new DefaultTreeSelectionModel();

Based on 7 examples


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 JavaBeansTM has been added to the java.beans package. Please see {@link java.beans.XMLEncoder}.


Field Summary
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 transient RowMapper rowMapper
          Provides a row for a given path.
protected TreePath[] selection
          Paths that are currently selected.
protected int selectionMode
          Mode for the selection, will be either SINGLE_TREE_SELECTION, CONTIGUOUS_TREE_SELECTION or DISCONTIGUOUS_TREE_SELECTION.
static String SELECTION_MODE_PROPERTY
          Property name for selectionMode.
 
Constructor Summary

          Creates a new instance of DefaultTreeSelectionModel that is empty, with a selection mode of DISCONTIGUOUS_TREE_SELECTION.
 
Method Summary
 void

          Adds a PropertyChangeListener to the listener list.
 void

          Adds path to the current selection.
 void

          Adds paths to the current selection.
 void

          Adds x to the list of listeners that are notified each time the set of selected TreePaths changes.
protected boolean

          Returns true if the paths are contiguous, or this object has no RowMapper.
protected boolean

          Used to test if a particular set of TreePaths can be added.
protected boolean

          Returns true if the paths can be removed without breaking the continuity of the model.
 void

          Empties the current selection.
 Object

          Returns a clone of this object with the same selection.
protected void

          Notifies all listeners that are registered for tree selection events on this object.
 TreePath

          Returns the last path that was added.
 int

          Returns the lead selection index.
 EventListener[]
getListeners(Class listenerType)

          Returns an array of all the objects currently registered as FooListeners upon this model.
 int

          Returns the largest value obtained from the RowMapper for the current set of selected TreePaths.
 int

          Returns the smallest value obtained from the RowMapper for the current set of selected TreePaths.
 PropertyChangeListener[]

          Returns an array of all the property change listeners registered on this DefaultTreeSelectionModel.
 RowMapper

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

          Returns the number of paths that are selected.
 int

          Returns the selection mode, one of SINGLE_TREE_SELECTION, DISCONTIGUOUS_TREE_SELECTION or CONTIGUOUS_TREE_SELECTION.
 TreePath

          Returns the first path in the selection.
 TreePath[]

          Returns the paths in the selection.
 int[]

          Returns all of the currently selected rows.
 TreeSelectionListener[]

          Returns an array of all the tree selection listeners registered on this model.
protected void

          Makes sure the currently selected TreePaths are valid for the current selection mode.
protected void

          This method is obsolete and its implementation is now a noop.
 boolean

          Returns true if the path, path, is in the current selection.
 boolean
isRowSelected(int row)

          Returns true if the row identified by row is selected.
 boolean

          Returns true if the selection is currently empty.
protected void
notifyPathChange(Vector changedPaths, TreePath oldLeadSelection)

          Notifies listeners of a change in path.
 void

          Removes a PropertyChangeListener from the listener list.
 void

          Removes path from the selection.
 void

          Removes paths from the selection.
 void

          Removes x from the list of listeners that are notified each time the set of selected TreePaths changes.
 void

          Updates this object's mapping from TreePath to rows.
 void

          Sets the RowMapper instance.
 void
setSelectionMode(int mode)

          Sets the selection model, which must be one of SINGLE_TREE_SELECTION, CONTIGUOUS_TREE_SELECTION or DISCONTIGUOUS_TREE_SELECTION.
 void

          Sets the selection to path.
 void

          Sets the selection to the paths in paths.
 String

          Returns a string that displays and identifies this object's properties.
protected void

          Updates the leadIndex instance variable.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

changeSupport

protected SwingPropertyChangeSupport changeSupport
Used to messaged registered listeners.

leadIndex

protected int leadIndex
Index of the lead path in selection.

leadPath

protected TreePath leadPath
Last path that was added.

leadRow

protected int leadRow
Lead row.

listenerList

protected EventListenerList listenerList
Event listener list.

listSelectionModel

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.

rowMapper

protected transient RowMapper rowMapper
Provides a row for a given path.

selection

protected TreePath[] selection
Paths that are currently selected. Will be null if nothing is currently selected.

selectionMode

protected int selectionMode
Mode for the selection, will be either SINGLE_TREE_SELECTION, CONTIGUOUS_TREE_SELECTION or DISCONTIGUOUS_TREE_SELECTION.

SELECTION_MODE_PROPERTY

public static final String SELECTION_MODE_PROPERTY
Property name for selectionMode.
Constructor Detail

DefaultTreeSelectionModel

public DefaultTreeSelectionModel()
Creates a new instance of DefaultTreeSelectionModel that is empty, with a selection mode of DISCONTIGUOUS_TREE_SELECTION.

Method Detail

addPropertyChangeListener

public synchronized 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.

Parameters:
listener - the PropertyChangeListener to be added

addSelectionPath

public 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

addSelectionPaths

public 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.

Parameters:
paths - the new path to add to the current selection

addTreeSelectionListener

public void addTreeSelectionListener(TreeSelectionListener x)
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

arePathsContiguous

protected boolean arePathsContiguous(TreePath[] paths)
Returns true if the paths are contiguous, or this object has no RowMapper.

Parameters:
paths

canPathsBeAdded

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.

Parameters:
paths

canPathsBeRemoved

protected boolean canPathsBeRemoved(TreePath[] paths)
Returns true if the paths can be removed without breaking the continuity of the model. This is rather expensive.

Parameters:
paths

clearSelection

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


clone

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.

Overrides:
clone in class Object
Throws:
CloneNotSupportedException - never thrown by instances of this class

fireValueChanged

protected void fireValueChanged(TreeSelectionEvent e)
Notifies all listeners that are registered for tree selection events on this object.

Parameters:
e

getLeadSelectionPath

public TreePath getLeadSelectionPath()
Returns the last path that was added. This may differ from the leadSelectionPath property maintained by the JTree.


getLeadSelectionRow

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


getListeners

public EventListener[] getListeners(Class 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.

Parameters:
listenerType - the type of listeners requested; this parameter should specify an interface that descends from java.util.EventListener
Returns:
an array of all objects registered as FooListeners on this component, or an empty array if no such listeners have been added

getMaxSelectionRow

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.


getMinSelectionRow

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.


getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners()
Returns an array of all the property change listeners registered on this DefaultTreeSelectionModel.

Returns:
all of this model's PropertyChangeListeners or an empty array if no property change listeners are currently registered

getRowMapper

public RowMapper getRowMapper()
Returns the RowMapper instance that is able to map a TreePath to a row.


getSelectionCount

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


getSelectionMode

public int getSelectionMode()
Returns the selection mode, one of SINGLE_TREE_SELECTION, DISCONTIGUOUS_TREE_SELECTION or CONTIGUOUS_TREE_SELECTION.


getSelectionPath

public TreePath getSelectionPath()
Returns the first path in the selection. This is useful if there if only one item currently selected.


getSelectionPaths

public TreePath[] getSelectionPaths()
Returns the paths in the selection. This will return null (or an empty array) if nothing is currently selected.


getSelectionRows

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. This may return an array of length less that than of the selected TreePaths if some of the rows are not visible (that is the RowMapper returned -1 for the row corresponding to the TreePath).


getTreeSelectionListeners

public TreeSelectionListener[] getTreeSelectionListeners()
Returns an array of all the tree selection listeners registered on this model.

Returns:
all of this model's TreeSelectionListeners or an empty array if no tree selection listeners are currently registered

insureRowContinuity

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.


insureUniqueness

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 compatability.


isPathSelected

public boolean isPathSelected(TreePath path)
Returns true if the path, path, is in the current selection.

Parameters:
path

isRowSelected

public boolean isRowSelected(int row)
Returns true if the row identified by row is selected.

Parameters:
row

isSelectionEmpty

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


notifyPathChange

protected void notifyPathChange(Vector changedPaths,
                                TreePath oldLeadSelection)
Notifies listeners of a change in path. changePaths should contain instances of PathPlaceHolder.

Parameters:
changedPaths
oldLeadSelection

removePropertyChangeListener

public synchronized void removePropertyChangeListener(PropertyChangeListener listener)
Removes a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties.

Parameters:
listener - the PropertyChangeListener to be removed

removeSelectionPath

public 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.

Parameters:
path - the path to remove from the selection

removeSelectionPaths

public 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.

Parameters:
paths - the paths to remove from the selection

removeTreeSelectionListener

public void removeTreeSelectionListener(TreeSelectionListener x)
Removes x from the list of listeners that are notified each time the set of selected TreePaths changes.

Parameters:
x - the listener to remove

resetRowSelection

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.


setRowMapper

public void setRowMapper(RowMapper newMapper)
Sets the RowMapper instance. This instance is used to determine the row for a particular TreePath.

Parameters:
newMapper

setSelectionMode

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.

Parameters:
mode

setSelectionPath

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.

Parameters:
path - new path to select

setSelectionPaths

public void setSelectionPaths(TreePath[] pPaths)
Sets the selection to the paths in paths. If this represents a change the TreeSelectionListeners are notified. Potentially paths will be held by this object; in other words don't change any of the objects in the array once passed in.

If paths is null, this has the same effect as invoking clearSelection.

The lead path is set to the last path in pPaths.

If the selection mode is CONTIGUOUS_TREE_SELECTION, and adding the new paths would make the selection discontiguous, the selection is reset to the first TreePath in paths.

Parameters:
pPaths - new selection

toString

public String toString()
Returns a string that displays and identifies this object's properties.

Overrides:
toString in class Object
Returns:
a String representation of this object

updateLeadIndex

protected void updateLeadIndex()
Updates the leadIndex instance variable.



This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.