|
|||||||||
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.Boxed
org.gnu.gtk.TreePath
public class TreePath
A path refers to a single row in a TreeModel
(such as a
ListStore
or a TreeStore
). In this respect, it is similar to
a TreeIter
, however a path also contains details of the structure of
the tree (TreeIter is a generic object for the entire TreeView family,
including flat lists and tables.)
Constructor Summary | |
---|---|
TreePath()
Constructs a new path. |
|
TreePath(java.lang.String path)
Creates a new TreePath initialized to path . |
Method Summary | |
---|---|
void |
appendIndex(int index)
Appends a new index to the path. |
int |
compare(TreePath other)
Compares the path with another path. |
void |
down()
Moves path to point to the first child of the current path. |
int |
getDepth()
Returns the current depth of path. |
int[] |
getIndices()
Returns the current indices of the path. |
boolean |
isAncestor(TreePath descendant)
Returns TRUE if descendant is a descendant of path. |
boolean |
isDescendant(TreePath ancestor)
Returns TRUE if path is a descendant of ancestor. |
void |
next()
Moves the path to point to the next node at the current depth. |
void |
prependIndex(int index)
Prepends a new index to the path. |
boolean |
previous()
Moves the path to point to the previous node at the current depth, if it exists. |
java.lang.String |
toString()
Generates a string representation of the path. |
boolean |
up()
Moves the path to point to it's parent node, if it has a parent. |
Methods inherited from class org.gnu.glib.Boxed |
---|
equals, getBoxedFromHandle, hashCode |
Methods inherited from class org.gnu.glib.Struct |
---|
getHandle, getNullHandle |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public TreePath()
public TreePath(java.lang.String path)
path
.
path
is expected to be a colon separated list of numbers.
For example, the string "10:4:0" would create a path of depth 3 pointing
to the 11th child of the root node, the 5th child of that 11th child, and
the 1st child of that 5th child. If an invalid path string is passed in,
NULL is returned. TODO: throw an exception on null response.
Method Detail |
---|
public java.lang.String toString()
toString
in class java.lang.Object
public int getDepth()
public int compare(TreePath other)
public void next()
public boolean previous()
public boolean up()
public void down()
public boolean isAncestor(TreePath descendant)
descendant
- Another TreePath
public boolean isDescendant(TreePath ancestor)
ancestor
- Another TreePath
public void appendIndex(int index)
index
- public void prependIndex(int index)
index
- public int[] getIndices()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |