org.gnu.gtk

Class TreeSelection

public class TreeSelection extends GObject

The TreeSelection object is a helper object to manage the selection for a {@link TreeView} widget. The TreeSelection object is automatically created when a newTreeView widget is created, and cannot exist independentally of this widget. The primary reason the TreeSelection objects exists is for cleanliness of code and API. That is, there is no conceptual reason all these functions could not be methods on the TreeView widget instead of a separate function.

The TreeSelection object is gotten from a TreeView by calling {@link TreeView#getSelection()}. It can be manipulated to check the selection status of the tree, as well as select and deselect individual rows. Selection is done completely view side. As a result, multiple views of the same model can have completely different selections. Additionally, you cannot change the selection of a row on the model that is not currently displayed by the view without expanding its parents first.

One of the important things to remember when monitoring the selection of a view is that the {@link org.gnu.gtk.event.TreeSelectionEvent.Type#CHANGED CHANGED} event is mostly a hint. That is, it may only emit one signal when a range of rows is selected. Additionally, it may on occasion emit a "changed" event when nothing has happened (mostly as a result of programmers calling selectRow on an already selected row).

See Also: TreeView

Method Summary
voidaddListener(TreeSelectionListener listener)
Register an object to handle Selection change events which are emitted whenever the selection has (possibly) changed
intcountRows()
Returns the number of rows that have been selected.
voidforEachSelected(TreeSelectionForEach implementor)
Calls the forEach method of the specified class for every selected value.
ClassgetEventListenerClass(String signal)
EventTypegetEventType(String signal)
SelectionModegetMode()
booleangetSelected(TreePath path)
Returns TRUE if the row pointed to by path is currently selected.
booleangetSelected(TreeIter iter)
Returns TRUE if the row pointed to by iter is currently selected.
TreePath[]getSelectedRows()
Returns an array of rows which are currently selected
TreeViewgetTreeView()
Returns the {@link TreeView} associated with the selection.
static TypegetType()
Retrieve the runtime type used by the GLib library.
voidremoveListener(TreeSelectionListener listener)
Removes a listener
voidselect(TreePath path)
Select the row at path.
voidselect(TreeIter iter)
Selects the specified iterator.
voidselect(TreePath startPath, TreePath endPath)
Selects a range of nodes, determined by startPath and endPath inclusive.
voidselectAll()
Selects all the nodes.
voidsetMode(SelectionMode mode)
Sets the selection mode of the selection.
voidunselect(TreePath path)
Unselects the row at path.
voidunselect(TreeIter iter)
Unselects the specified iterator.
voidunselect(TreePath startPath, TreePath endPath)
voidunselectAll()
Unselects all the nodes.

Method Detail

addListener

public void addListener(TreeSelectionListener listener)
Register an object to handle Selection change events which are emitted whenever the selection has (possibly) changed

See Also: TreeSelectionListener

countRows

public int countRows()
Returns the number of rows that have been selected.

Since: 2.2

forEachSelected

public void forEachSelected(TreeSelectionForEach implementor)
Calls the forEach method of the specified class for every selected value.

getEventListenerClass

public Class getEventListenerClass(String signal)

getEventType

public EventType getEventType(String signal)

getMode

public SelectionMode getMode()

getSelected

public boolean getSelected(TreePath path)
Returns TRUE if the row pointed to by path is currently selected. If path does not point to a valid location, FALSE is returned

Parameters: path A patch to check the selection on

Returns: True if the path is selected.

getSelected

public boolean getSelected(TreeIter iter)
Returns TRUE if the row pointed to by iter is currently selected.

Parameters: iter The iter to test the selection of

Returns: true if the iter is selected.

getSelectedRows

public TreePath[] getSelectedRows()
Returns an array of rows which are currently selected

Returns: an empty array if there aren't any rows selected; or an array filled with TreePath objects, representing the selections.

Since: 2.2

getTreeView

public TreeView getTreeView()
Returns the {@link TreeView} associated with the selection.

Returns: Associated widget

getType

public static Type getType()
Retrieve the runtime type used by the GLib library.

removeListener

public void removeListener(TreeSelectionListener listener)
Removes a listener

See Also: addListener

select

public void select(TreePath path)
Select the row at path.

Parameters: path The path to be selected.

select

public void select(TreeIter iter)
Selects the specified iterator.

Parameters: iter The {@link TreeIter} to be selected.

select

public void select(TreePath startPath, TreePath endPath)
Selects a range of nodes, determined by startPath and endPath inclusive.

Parameters: startPath The initial node of the range. endPath The final node of the range.

selectAll

public void selectAll()
Selects all the nodes. Mode must be set to SelectionMode.MULTIPLE

setMode

public void setMode(SelectionMode mode)
Sets the selection mode of the selection. If the previous type was SelectionMode.MULTIPLE, then the anchor is kept selected, if it was previously selected.

Parameters: mode The selection mode to use.

unselect

public void unselect(TreePath path)
Unselects the row at path.

Parameters: path The path to be deselected

unselect

public void unselect(TreeIter iter)
Unselects the specified iterator.

Parameters: iter The {@link TreeIter} to be unselected.

unselect

public void unselect(TreePath startPath, TreePath endPath)

unselectAll

public void unselectAll()
Unselects all the nodes.