Home » openjdk-7 » javax » swing » tree » [javadoc | source]
javax.swing.tree
public class: DefaultTreeSelectionModel [javadoc | source]
java.lang.Object
   javax.swing.tree.DefaultTreeSelectionModel

All Implemented Interfaces:
    Cloneable, TreeSelectionModel, java$io$Serializable

Direct Known Subclasses:
    EmptySelectionModel

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 java.beans.XMLEncoder .

Field Summary
public 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. 
Constructor:
 public DefaultTreeSelectionModel() 
Method from javax.swing.tree.DefaultTreeSelectionModel Summary:
addPropertyChangeListener,   addSelectionPath,   addSelectionPaths,   addTreeSelectionListener,   arePathsContiguous,   canPathsBeAdded,   canPathsBeRemoved,   clearSelection,   clone,   fireValueChanged,   getLeadSelectionPath,   getLeadSelectionRow,   getListeners,   getMaxSelectionRow,   getMinSelectionRow,   getPropertyChangeListeners,   getRowMapper,   getSelectionCount,   getSelectionMode,   getSelectionPath,   getSelectionPaths,   getSelectionRows,   getTreeSelectionListeners,   insureRowContinuity,   insureUniqueness,   isPathSelected,   isRowSelected,   isSelectionEmpty,   notifyPathChange,   removePropertyChangeListener,   removeSelectionPath,   removeSelectionPaths,   removeTreeSelectionListener,   resetRowSelection,   setRowMapper,   setSelectionMode,   setSelectionPath,   setSelectionPaths,   toString,   updateLeadIndex
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.swing.tree.DefaultTreeSelectionModel Detail:
 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.

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

 public  void addTreeSelectionListener(TreeSelectionListener x) 
    Adds x to the list of listeners that are notified each time the set of selected TreePaths changes.
 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.
 public  void clearSelection() 
    Empties the current selection. If this represents a change in the current selection, the selection listeners are notified.
 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.
 protected  void fireValueChanged(TreeSelectionEvent e) 
    Notifies all listeners that are registered for tree selection events on this object.
 public TreePath getLeadSelectionPath() 
    Returns the last path that was added. This may differ from the leadSelectionPath property maintained by the JTree.
 public int getLeadSelectionRow() 
    Returns the lead selection index. That is the last index that was added.
 public 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.
 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.
 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.
 public PropertyChangeListener[] getPropertyChangeListeners() 
    Returns an array of all the property change listeners registered on this DefaultTreeSelectionModel.
 public RowMapper getRowMapper() 
    Returns the RowMapper instance that is able to map a TreePath to a row.
 public int getSelectionCount() 
    Returns the number of paths that are selected.
 public int getSelectionMode() 
    Returns the selection mode, one of SINGLE_TREE_SELECTION, DISCONTIGUOUS_TREE_SELECTION or CONTIGUOUS_TREE_SELECTION.
 public TreePath getSelectionPath() 
    Returns the first path in the selection. This is useful if there if only one item currently selected.
 public TreePath[] getSelectionPaths() 
    Returns the selection.
 public int[] getSelectionRows() 
    Returns the selection in terms of rows. There is not necessarily a one-to-one mapping between the {@code TreePath}s returned from {@code getSelectionPaths} and this method. In particular, if a {@code TreePath} is not viewable (the {@code RowMapper} returns {@code -1} for the row corresponding to the {@code TreePath}), then the corresponding row is not included in the returned array. For example, if the selection consists of two paths, {@code A} and {@code B}, with {@code A} at row {@code 10}, and {@code B} not currently viewable, then this method returns an array with the single entry {@code 10}.
 public TreeSelectionListener[] getTreeSelectionListeners() 
    Returns an array of all the tree selection listeners registered on this model.
 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  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.
 public boolean isPathSelected(TreePath path) 
    Returns true if the path, path, is in the current selection.
 public boolean isRowSelected(int row) 
    Returns true if the row identified by row is selected.
 public boolean isSelectionEmpty() 
    Returns true if the selection is currently empty.
 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.
 public synchronized  void removePropertyChangeListener(PropertyChangeListener listener) 
    Removes a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties.
 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.
 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.
 public  void removeTreeSelectionListener(TreeSelectionListener x) 
    Removes x from the list of listeners that are notified each time the set of selected TreePaths changes.
 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.

 public  void setRowMapper(RowMapper newMapper) 
    Sets the RowMapper instance. This instance is used to determine the row for a particular TreePath.
 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.

 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.
 public  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 {@code null}, or empty, the selection is cleared. If the selection mode is {@code SINGLE_TREE_SELECTION}, only the first path in {@code pPaths} is used. If the selection mode is {@code CONTIGUOUS_TREE_SELECTION} and the supplied paths are not contiguous, then only the first path in {@code pPaths} is used. If the selection mode is {@code DISCONTIGUOUS_TREE_SELECTION}, then all paths are used.

    All {@code null} paths in {@code pPaths} are ignored.

    If this represents a change, all registered {@code TreeSelectionListener}s are notified.

    The lead path is set to the last unique path.

    The paths returned from {@code getSelectionPaths} are in the same order as those supplied to this method.

 public String toString() 
    Returns a string that displays and identifies this object's properties.
 protected  void updateLeadIndex() 
    Updates the leadIndex instance variable.