All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.java.swing.tree.DefaultTreeSelectionModel

java.lang.Object
   |
   +----com.sun.java.swing.tree.DefaultTreeSelectionModel

public class DefaultTreeSelectionModel

extends Object

implements Cloneable, Serializable, TreeSelectionModel

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 Swing1.0 applications. It will not be possible to load serialized Swing1.0 objects with future releases of Swing. The JDK1.2 release of Swing will be the compatibility baseline for the serialized form of Swing objects.

changeSupport

Used to messaged registered listeners.

leadIndex

Index of the lead path in selection.

leadPath

Last path that was added.

leadRow

Lead row.

listenerList

Event listener list.

listSelectionModel

Handles maintaining the list selection model.

rowMapper

Provides a row for a given path.

selection

Paths that are currently selected.

SELECTION_MODE_PROPERTY

Property name for selectionMode.

selectionMode

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

DefaultTreeSelectionModel()

addPropertyChangeListener(PropertyChangeListener)

Add a PropertyChangeListener to the listener list.

addSelectionPath(TreePath)

Adds path to the current selection.

addSelectionPaths(TreePath[])

Adds paths to the current selection.

addTreeSelectionListener(TreeSelectionListener)

Adds x to the list of listeners that are notified each time the selection changes.

arePathsContiguous(TreePath[])

Returns true if the paths are contiguous.

canPathsBeAdded(TreePath[])

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

canPathsBeRemoved(TreePath[])

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

clearSelection()

Empties the current selection.

clone()

Returns a clone of the reciever with the same selection.

fireValueChanged(TreeSelectionEvent)

getLeadSelectionPath()

Returns the last path that was added.

getLeadSelectionRow()

Returns the lead selection index.

getMaxSelectionRow()

Gets the last selected row.

getMinSelectionRow()

Gets the first selected row.

getRowMapper()

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

getSelectionCount()

Returns the number of paths that are selected.

getSelectionMode()

Returns the selection mode.

getSelectionPath()

Returns the first path in the selection.

getSelectionPaths()

Returns the paths in the selection.

getSelectionRows()

Returns all of the currently selected rows.

insureRowContinuity()

Useful for CONTIGUOUS_TREE_SELECTION.

insureUniqueness()

Insures that all the elements in path are unique.

isPathSelected(TreePath)

Returns true if the path, path, is in the current selection.

isRowSelected(int)

Returns true if the row identitifed by row is selected.

isSelectionEmpty()

Returns true if the selection is currently empty.

notifyPathChange(Vector, TreePath)

Notifies listeners of a change in path.

removePropertyChangeListener(PropertyChangeListener)

Remove a PropertyChangeListener from the listener list.

removeSelectionPath(TreePath)

Removes path from the selection.

removeSelectionPaths(TreePath[])

Removes paths from the selection.

removeTreeSelectionListener(TreeSelectionListener)

Removes x from the list of listeners that are notified each time the selection changes.

resetRowSelection()

Recalculates what rows are selected by asking the RowMapper for the row for each path.

setRowMapper(RowMapper)

Sets the RowMapper instance.

setSelectionMode(int)

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

setSelectionPath(TreePath)

Sets the selection to path.

setSelectionPaths(TreePath[])

Sets the selection to the paths in paths.

toString()

updateLeadIndex()

Updates the leadIndex instance variable.

 public static final String SELECTION_MODE_PROPERTY

Property name for selectionMode.

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

 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()

 public void setRowMapper(RowMapper newMapper)

Sets the RowMapper instance. This instance is used to determine what row corresponds to what path.

 public RowMapper getRowMapper()

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

 public void setSelectionMode(int mode)

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

 public int getSelectionMode()

Returns the selection mode.

 public void setSelectionPath(TreePath path)

Sets the selection to path. If this represents a change, then the TreeSelectionListeners are notified.

Parameters:

path - new path to select

 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 the reciever, in other words don't change any of the objects in the array once passed in.

Parameters:

paths - new selection.

 public void addSelectionPath(TreePath path)

Adds path to the current selection. If path is not currently in the selection the TreeSelectionListeners are notified.

Parameters:

path - the new path to add to the current selection.

 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.

Parameters:

path - the new path to add to the current selection.

 public void removeSelectionPath(TreePath path)

Removes path from the selection. If path is in the selection The TreeSelectionListeners are notified.

Parameters:

path - the path to remove from the selection.

 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.

Parameters:

path - the path to remove from the selection.

 public TreePath getSelectionPath()

Returns the first path in the selection.

 public TreePath[] getSelectionPaths()

Returns the paths in the selection.

 public int getSelectionCount()

Returns the number of paths that are selected.

 public boolean isPathSelected(TreePath path)

Returns true if the path, path, is in the current selection.

 public boolean isSelectionEmpty()

Returns true if the selection is currently empty.

 public void clearSelection()

Empties the current selection. If this represents a change in the current selection, the selection listeners are notified.

 public void addTreeSelectionListener(TreeSelectionListener x)

Adds x to the list of listeners that are notified each time the selection changes.

Parameters:

x - the new listener to be added.

 public void removeTreeSelectionListener(TreeSelectionListener x)

Removes x from the list of listeners that are notified each time the selection changes.

Parameters:

x - the listener to remove.

 protected void fireValueChanged(TreeSelectionEvent e)

 public int[] getSelectionRows()

Returns all of the currently selected rows.

 public int getMinSelectionRow()

Gets the first selected row.

 public int getMaxSelectionRow()

Gets the last selected row.

 public boolean isRowSelected(int row)

Returns true if the row identitifed by row is selected.

 public void resetRowSelection()

Recalculates what rows are selected by asking the RowMapper for the row for each path.

 public int getLeadSelectionRow()

Returns the lead selection index. That is the last index that was added.

 public TreePath getLeadSelectionPath()

Returns the last path that was added.

 public synchronized void addPropertyChangeListener(PropertyChangeListener listener)

Add a PropertyChangeListener to the listener list. The listener is registered for all properties.

A PropertyChangeEvent will get fired in response to an explicit setFont, setBackground, or SetForeground on the current component. Note that if the current component is inheriting its foreground, background, or font from its container, then no event will be fired in response to a change in the inherited property.

Parameters:

listener - The PropertyChangeListener to be added

 public synchronized void removePropertyChangeListener(PropertyChangeListener listener)

Remove a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties.

Parameters:

listener - The PropertyChangeListener to be removed

 protected void insureRowContinuity()

Useful for CONTIGUOUS_TREE_SELECTION. If the rows that are selected are not contiguous then the selection is reset to be contiguous. Or if the selection mode is single selection and more than one this is selected the selection is reset.

 protected boolean arePathsContiguous(TreePath paths[])

Returns true if the paths are contiguous.

 protected boolean canPathsBeAdded(TreePath paths[])

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

 protected boolean canPathsBeRemoved(TreePath paths[])

Returns true if the paths can be removed without breaking the continuity of the model. This is rather expensive.

 protected void notifyPathChange(Vector changedPaths,
                                 TreePath oldLeadSelection)

Notifies listeners of a change in path. changePaths should contain instances of PathPlaceHolder.

 protected void updateLeadIndex()

Updates the leadIndex instance variable.

 protected void insureUniqueness()

Insures that all the elements in path are unique. This does not check for a null selection!

 public String toString()

Overrides:

toString in class Object

 public Object clone() throws CloneNotSupportedException

Returns a clone of the reciever with the same selection. selectionListeners, and PropertyListeners are not duplicated.

Throws: CloneNotSupportedException

if the receiver does not both (a) implement the Cloneable interface and (b) define a clone method.

Overrides:

clone in class Object

All Packages  Class Hierarchy  This Package  Previous  Next  Index