Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
Boxed
org.gnu.gtk.TreePath
public class TreePath
extends Boxed
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 | |
| |
|
Method Summary | |
void |
|
int | |
void |
|
int |
|
int[] |
|
boolean |
|
boolean |
|
void |
|
void |
|
boolean |
|
String |
|
boolean |
|
public TreePath()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Constructs a new path.
public TreePath(String path)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Creates a new TreePath initialized topath
.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.
public void appendIndex(int index)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Appends a new index to the path. As a result, the depth of the path is increased
- Parameters:
index
-
public int compare(TreePath other)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Compares the path with another path. If the other path appears before this one in a tree, then -1 is returned. If this one appears before the other, then 1 is returned. If the two nodes are equal, then 0 is returned.
public void down()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Moves path to point to the first child of the current path.
public int getDepth()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Returns the current depth of path.
public int[] getIndices()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Returns the current indices of the path.
- Returns:
- An array of ints, each representing a node in the tree.
public boolean isAncestor(TreePath descendant)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Returns TRUE if descendant is a descendant of path.
- Parameters:
descendant
- Another TreePath
- Returns:
- TRUE if descendant is contained inside path
public boolean isDescendant(TreePath ancestor)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Returns TRUE if path is a descendant of ancestor.
- Parameters:
ancestor
- Another TreePath
- Returns:
- TRUE if ancestor contains path somewhere below it
public void next()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Moves the path to point to the next node at the current depth.
public void prependIndex(int index)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Prepends a new index to the path. As a result, the depth of the path is increased
- Parameters:
index
-
public boolean previous()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Moves the path to point to the previous node at the current depth, if it exists.
- Returns:
- TRUE if path has a previous node, and the move was made.
public String toString()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Generates a string representation of the path. This string is a ':' separated list of numbers. For example, "4:10:0:3" would be an acceptable return value for this string.
- Returns:
- String representation of the path.
public boolean up()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Moves the path to point to it's parent node, if it has a parent.
- Returns:
- TRUE if path has a parent, and the move was made.