|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.gnu.glib.Struct
org.gnu.glib.GObject
org.gnu.gtk.TreeSelection
public class TreeSelection
The TreeSelection object is a helper object to manage the selection for a
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
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 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).
TreeView
Method Summary | |
---|---|
void |
addListener(TreeSelectionListener listener)
Register an object to handle Selection change events which are emitted whenever the selection has (possibly) changed |
int |
countRows()
Returns the number of rows that have been selected. |
void |
forEachSelected(TreeSelectionForEach implementor)
Calls the forEach method of the specified class for every selected value. |
java.lang.Class |
getEventListenerClass(java.lang.String signal)
|
EventType |
getEventType(java.lang.String signal)
|
SelectionMode |
getMode()
|
boolean |
getSelected(TreeIter iter)
Returns TRUE if the row pointed to by iter is currently selected. |
boolean |
getSelected(TreePath path)
Returns TRUE if the row pointed to by path is currently selected. |
TreePath[] |
getSelectedRows()
Returns an array of rows which are currently selected |
TreeView |
getTreeView()
Returns the TreeView associated with the selection. |
static Type |
getType()
Retrieve the runtime type used by the GLib library. |
void |
removeListener(TreeSelectionListener listener)
Removes a listener |
void |
select(TreeIter iter)
Selects the specified iterator. |
void |
select(TreePath path)
Select the row at path. |
void |
select(TreePath startPath,
TreePath endPath)
Selects a range of nodes, determined by startPath and endPath inclusive. |
void |
selectAll()
Selects all the nodes. |
void |
setMode(SelectionMode mode)
Sets the selection mode of the selection. |
void |
unselect(TreeIter iter)
Unselects the specified iterator. |
void |
unselect(TreePath path)
Unselects the row at path. |
void |
unselect(TreePath startPath,
TreePath endPath)
|
void |
unselectAll()
Unselects all the nodes. |
Methods inherited from class org.gnu.glib.Struct |
---|
equals, getHandle, getNullHandle, hashCode |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public void forEachSelected(TreeSelectionForEach implementor)
public void setMode(SelectionMode mode)
mode
- The selection mode to use.public SelectionMode getMode()
public TreeView getTreeView()
TreeView
associated with the selection.
public void select(TreePath path)
path
- The path to be selected.public void unselect(TreePath path)
path
- The path to be deselectedpublic boolean getSelected(TreePath path)
path
- A patch to check the selection on
public void select(TreeIter iter)
iter
- The TreeIter
to be selected.public void unselect(TreeIter iter)
iter
- The TreeIter
to be unselected.public boolean getSelected(TreeIter iter)
iter
- The iter to test the selection of
public void selectAll()
public void unselectAll()
public void select(TreePath startPath, TreePath endPath)
startPath
- The initial node of the range.endPath
- The final node of the range.public void unselect(TreePath startPath, TreePath endPath)
public TreePath[] getSelectedRows()
public int countRows()
public void addListener(TreeSelectionListener listener)
TreeSelectionListener
public void removeListener(TreeSelectionListener listener)
addListener(TreeSelectionListener)
public java.lang.Class getEventListenerClass(java.lang.String signal)
getEventListenerClass
in class GObject
public EventType getEventType(java.lang.String signal)
getEventType
in class GObject
public static Type getType()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |