TreeSelectionModel

This interface represents the current state of the selection for the tree component. For information and examples of using tree selection models, see How to Use Trees in The Java Tutorial.

The state of the tree selection is characterized by a set of TreePaths, and optionally a set of integers. The mapping from TreePath to integer is done by way of an instance of RowMapper. It is not necessary for a TreeSelectionModel to have a RowMapper to correctly operate, but without a RowMapper getSelectionRows will return null.

A TreeSelectionModel can be configured to allow only one path (SINGLETREESELECTION) a number of continguous paths (CONTIGUOUSTREESELECTION) or a number of discontiguous paths (DISCONTIGUOUSTREESELECTION). A RowMapper is used to determine if TreePaths are contiguous. In the absence of a RowMapper CONTIGUOUSTREESELECTION and DISCONTIGUOUSTREESELECTION behave the same, that is they allow any number of paths to be contained in the TreeSelectionModel.

For a selection model of CONTIGUOUSTREESELECTION any time the paths are changed (setSelectionPath, addSelectionPath ...) the TreePaths are again checked to make they are contiguous. A check of the TreePaths can also be forced by invoking resetRowSelection. How a set of discontiguous TreePaths is mapped to a contiguous set is left to implementors of this interface to enforce a particular policy.

Implementations should combine duplicate TreePaths that are added to the selection. For example, the following code

  var paths:Array = [ treePath, treePath ];
  treeSelectionModel.setSelectionPaths(paths);

should result in only one path being selected: treePath, and not two copies of treePath.

The lead TreePath is the last path that was added (or set). The lead row is then the row that corresponds to the TreePath as determined from the RowMapper.

* (Fully quoted from java swing's tree doc)

@author paling

Instance Fields

`function addPropertyChangeListener(listener:Dynamic ->Void?priority:Int, ?useWeakReference:Bool): Void`

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

A PropertyChangeEvent will get fired when the selection mode changes.

@param priority the priority

 * @param useWeakReference Determines whether the reference to the listener is strong or weak.

@see org.aswing.JTree#ONPROPERTYCHANGED

listener

the propertyChangeListener to be added *

`function addSelectionPath(path:TreePath, ?programmatic:Bool): Void`

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.

path	the new path to add to the current selection.
programmatic	indicate if this is a programmatic change.

`function addSelectionPaths(paths:Array<Dynamic>, ?programmatic:Bool): Void`

Adds paths(TreePath[]) 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.

paths	the new paths to add to the current selection.
programmatic	indicate if this is a programmatic change.

`function addTreeSelectionListener(listener:Dynamic ->Void?priority:Int, ?useWeakReference:Bool): Void`

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

@param priority the priority

  * @param useWeakReference Determines whether the reference to the listener is strong or weak.

@see org.aswing.JTree#ONSELECTIONCHANGED

listener

the new listener to be added *

`function clearSelection(?programmatic:Bool): Void`

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

programmatic

indicate if this is a programmatic change.

`function getLeadSelectionPath(): TreePath`

Returns the last path that was added. This may differ from the leadSelectionPath property maintained by the JTree.

`function getLeadSelectionRow(): Int`

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

`function getMaxSelectionRow(): Int`

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.

`function getMinSelectionRow(): Int`

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.

`function getRowMapper(): RowMapper`

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

`function getSelectionCount(): Int`

Returns the number of paths that are selected.

`function getSelectionMode(): Int`

Returns the current selection mode, one of SINGLETREESELECTION, CONTIGUOUSTREESELECTION or DISCONTIGUOUSTREESELECTION.

`function getSelectionPath(): TreePath`

Returns the first path in the selection. How first is defined is up to implementors, and may not necessarily be the TreePath with the smallest integer value as determined from the RowMapper.

`function getSelectionPaths(): Array<Dynamic>`

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

`function getSelectionRows(): Array<Dynamic>`

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.

`function isPathSelected(path:TreePath): Bool`

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

`function isRowSelected(row:Int): Bool`

Returns true if the row identified by row is selected.

`function isSelectionEmpty(): Bool`

Returns true if the selection is currently empty.

`function removePropertyChangeListener(listener:Dynamic ->Void): Void`

Removed a propertyChangeListener.

listener

the listener to be removed.

`function removeSelectionPath(path:TreePath, ?programmatic:Bool): Void`

Removes path from the selection. If path is in the selection The TreeSelectionListeners are notified. This has no effect if path is null.

path	the path to remove from the selection.
programmatic	indicate if this is a programmatic change.

`function removeSelectionPaths(paths:Array<Dynamic>, ?programmatic:Bool): Void`

Removes paths(TreePath[]) from the selection. If any of the paths in paths are in the selection, the TreeSelectionListeners are notified. This method has no effect if paths is null.

paths	the path to remove from the selection.
programmatic	indicate if this is a programmatic change.

`function removeTreeSelectionListener(listener:Dynamic ->Void): Void`

Removed a treeSelectionListener.

listener

the listener to be removed.

`function resetRowSelection(): Void`

Updates this object's mapping from TreePaths 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.

`function setRowMapper(newMapper:RowMapper): Void`

Sets the RowMapper instance. This instance is used to determine the row for a particular TreePath.

`function setSelectionMode(mode:Int): Void`

Sets the selection model, which must be one of SINGLETREESELECTION, CONTIGUOUSTREESELECTION or DISCONTIGUOUSTREESELECTION.

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 SINGLETREESELECTION, only one TreePath will remain selected. It is up to the particular implementation to decide what TreePath remains selected.

`function setSelectionPath(path:TreePath, ?programmatic:Bool): Void`

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.

path	new path to select.
programmatic	indicate if this is a programmatic change.

`function setSelectionPaths(paths:Array<Dynamic>, ?programmatic:Bool): Void`

Sets the selection to path(TreePath[]) . If this represents a change, then the TreeSelectionListeners are notified. If paths is null, this has the same effect as invoking clearSelection.

paths	new selection.
programmatic	indicate if this is a programmatic change.

interface org.aswing.tree.TreeSelectionModel

Instance Fields

function addPropertyChangeListener(listener:Dynamic ->Void?priority:Int, ?useWeakReference:Bool): Void

function addSelectionPath(path:TreePath, ?programmatic:Bool): Void

function addSelectionPaths(paths:Array<Dynamic>, ?programmatic:Bool): Void

function addTreeSelectionListener(listener:Dynamic ->Void?priority:Int, ?useWeakReference:Bool): Void

function clearSelection(?programmatic:Bool): Void

function getLeadSelectionPath(): TreePath

function getLeadSelectionRow(): Int

function getMaxSelectionRow(): Int

function getMinSelectionRow(): Int

function getRowMapper(): RowMapper

function getSelectionCount(): Int

function getSelectionMode(): Int

function getSelectionPath(): TreePath

function getSelectionPaths(): Array<Dynamic>

function getSelectionRows(): Array<Dynamic>

function isPathSelected(path:TreePath): Bool

function isRowSelected(row:Int): Bool

function isSelectionEmpty(): Bool

function removePropertyChangeListener(listener:Dynamic ->Void): Void

function removeSelectionPath(path:TreePath, ?programmatic:Bool): Void

function removeSelectionPaths(paths:Array<Dynamic>, ?programmatic:Bool): Void

function removeTreeSelectionListener(listener:Dynamic ->Void): Void

function resetRowSelection(): Void

function setRowMapper(newMapper:RowMapper): Void

function setSelectionMode(mode:Int): Void

function setSelectionPath(path:TreePath, ?programmatic:Bool): Void

function setSelectionPaths(paths:Array<Dynamic>, ?programmatic:Bool): Void

`interface org.aswing.tree.TreeSelectionModel`

`function addPropertyChangeListener(listener:Dynamic ->Void?priority:Int, ?useWeakReference:Bool): Void`

`function addSelectionPath(path:TreePath, ?programmatic:Bool): Void`

`function addSelectionPaths(paths:Array<Dynamic>, ?programmatic:Bool): Void`

`function addTreeSelectionListener(listener:Dynamic ->Void?priority:Int, ?useWeakReference:Bool): Void`

`function clearSelection(?programmatic:Bool): Void`

`function getLeadSelectionPath(): TreePath`

`function getLeadSelectionRow(): Int`

`function getMaxSelectionRow(): Int`

`function getMinSelectionRow(): Int`

`function getRowMapper(): RowMapper`

`function getSelectionCount(): Int`

`function getSelectionMode(): Int`

`function getSelectionPath(): TreePath`

`function getSelectionPaths(): Array<Dynamic>`

`function getSelectionRows(): Array<Dynamic>`

`function isPathSelected(path:TreePath): Bool`

`function isRowSelected(row:Int): Bool`

`function isSelectionEmpty(): Bool`

`function removePropertyChangeListener(listener:Dynamic ->Void): Void`

`function removeSelectionPath(path:TreePath, ?programmatic:Bool): Void`

`function removeSelectionPaths(paths:Array<Dynamic>, ?programmatic:Bool): Void`

`function removeTreeSelectionListener(listener:Dynamic ->Void): Void`

`function resetRowSelection(): Void`

`function setRowMapper(newMapper:RowMapper): Void`

`function setSelectionMode(mode:Int): Void`

`function setSelectionPath(path:TreePath, ?programmatic:Bool): Void`

`function setSelectionPaths(paths:Array<Dynamic>, ?programmatic:Bool): Void`