org.gnu.gtk
public class TreeStore extends TreeModel implements TreeSortable, TreeDragDest, TreeDragSource
Deprecated: This class is part of the java-gnome 2.x family of libraries,
which, due to their inefficiency and complexity, are no longer
being maintained and have been abandoned by the java-gnome
project. This class may in the future have an equivalent in
java-gnome 4.0, try looking for
org.gnome.gtk.TreeStore
.
You should be aware that there is a considerably different API
in the new library: the architecture is completely different
and most notably internals are no longer exposed to public view.
Data is stored within this object in DataColumns. This data is displayed in the widgets via CellRenderer's; the mapping between this data and the cell renderers of each treeview column is done in the TreeViewColumn class.
Constructor Summary | |
---|---|
TreeStore(DataColumn[] dataColumns)
Constructs a new TreeStore, defining the types for each datablock.
|
Method Summary | |
---|---|
void | addRow(DataRow aRow)
Adds a row to the tree. |
void | addRow(DataRow aRow, TreeIter aParent)
Adds a row to the tree. |
void | addRowAt(DataRow aRow, int aPosition)
Adds a row to the tree, at the specified position. |
void | addRowAt(DataRow aRow, TreeIter aParent, int aPosition)
Adds a row to the tree, at the specified position. |
TreeIter | appendRow(TreeIter parent)
Appends a new row to tree_store. |
void | clear()
Removes all items from the treestore. |
List | getAllDataColumns()
Returns a List with the types for every column as a
DataColumn object.
|
DataColumn | getDataColumn(int aCol)
Returns the type of the column aCol as a
DataColumn . |
int | getIteratorDepth(TreeIter iter)
Returns the depth of the iterator. |
DataRow | getRowAt(TreeIter aIter)
Gets all the values in the row indicated by aIter . |
DataColumn | getSortColumn()
Get a DataColumn object representing the currently sorted column. |
SortType | getSortOrder()
Get the current sorting order of the store.
|
static Type | getType()
Retrieve the runtime type used by the GLib library. |
int | handleCompareFunc(Handle model, Handle aIter, Handle bIter, int col)
Call-back method invoked by the JNI code when sorting is required. |
TreeIter | insertRow(TreeIter parent, int position)
Creates a new row at position. |
TreeIter | insertRowAfter(TreeIter sibling, TreeIter parent)
Inserts a new row after sibling. |
TreeIter | insertRowBefore(TreeIter sibling, TreeIter parent)
Inserts a new row before sibling. |
boolean | isAncestor(TreeIter iter, TreeIter descendant)
Returns TRUE if iter is an ancestor of descendant. |
boolean | isIterValid(TreeIter iter) |
void | moveRowAfter(TreeIter iter, TreeIter position)
Moves iter in this store to the position after position. |
void | moveRowBefore(TreeIter iter, TreeIter position)
Moves iter in tree_store to the position before position. |
void | moveRowToEnd(TreeIter iter)
Moves iter to the end of the model
|
void | moveRowToStart(TreeIter iter)
Moves iter in this store to the start of the store.
|
TreeIter | prependRow(TreeIter parent)
Prepends a new row to the store. |
void | removeRow(TreeIter iter)
Removes a row from the tree store. |
void | reorder(TreeIter iter, int[] newOrder) |
void | setColumnTypes(DataColumn[] dataColumns) |
void | setDragDestListener(TreeDragDestListener listener)
This method has not yet been implemented. |
void | setDragSourceListener(TreeDragSourceListener listener)
This method has not yet been implemented. |
void | setRowAt(DataRow aRow, TreeIter aIter)
Sets all columns pointed by aIter to the values stored in
aRow .
|
void | setSortColumn(DataColumn column, SortType order)
Set the column in the list to sort on. |
void | setSortMethod(TreeIterComparison method, DataColumn column)
Set the class used to sort the list according to the values stored in the
given DataColumn. |
void | setValue(TreeIter iter, DataColumnString dataBlock, String value)
Sets a value in the dataStore. |
void | setValue(TreeIter iter, DataColumnStockItem dataBlock, GtkStockItem value)
Sets a value in the dataStore. |
void | setValue(TreeIter iter, DataColumnIconSize dataBlock, IconSize value)
Sets a value in the dataStore. |
void | setValue(TreeIter iter, DataColumnInt dataBlock, int value)
Sets a value in the dataStore. |
void | setValue(TreeIter iter, DataColumnLong dataBlock, long value)
Sets a value in the dataStore. |
void | setValue(TreeIter iter, DataColumnBoolean dataBlock, boolean value)
Sets a value in the dataStore. |
void | setValue(TreeIter iter, DataColumnDouble dataBlock, double value)
Sets a value in the dataStore. |
void | setValue(TreeIter iter, DataColumnObject dataBlock, Object value)
Sets a value in the dataStore. |
void | setValue(TreeIter iter, DataColumnPixbuf dataBlock, Pixbuf value)
Sets a value in the dataStore. |
void | swapRows(TreeIter a, TreeIter b)
Swaps a and b in the same level of tree_store. |
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 TreeStore, defining the types for each datablock. Subsequent setting of data to any of the datablocks must follow the types you set out here.Parameters: dataColumns Types for the data to be stored in the TreeStore.
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.
Adds a row to the tree. This method can be used to easily add data to the tree. Each item in the DataRow must match the DataColumn type specified in the constructor of TreeStore. For example, if it was passed{new DataColumnBoolean(), new DataColumnString()}
to the
constructor, then the DataRow must contain a Boolean and a String object,
respectively.
Parameters: aRow a row to be added to the list
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.
Adds a row to the tree. This method can be used to easily add data to the tree. Each item in the DataRow must match the DataColumn type specified in the constructor of TreeStore. For example, if it was passed{new DataColumnBoolean(), new DataColumnString()}
to the
constructor, then the DataRow must contain a Boolean and a String object,
respectively.
Parameters: aRow
a row to be added to the list aParent
a TreeIter
pointing to a parent row.
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.
Adds a row to the tree, at the specified position. This method can be used to easily add data to the tree. Each item in the DataRow must match the DataColumn type specified in the constructor of TreeStore. For example, if it was passed{new DataColumnBoolean(), new DataColumnString()}
to the
constructor, then the DataRow must contain a Boolean and a String object,
respectively.
Parameters: aRow a row to be added to the list
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.
Adds a row to the tree, at the specified position. This method can be used to easily add data to the tree. Each item in the DataRow must match the DataColumn type specified in the constructor of TreeStore. For example, if it was passed{new DataColumnBoolean(), new DataColumnString()}
to the
constructor, then the DataRow must contain a Boolean and a String object,
respectively.
Parameters: aRow
a row to be added to the list aParent
a TreeIter
pointing to a parent row.
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 row to tree_store. If parent is non-NULL, then it will append the new row after the last child of parent, otherwise it will append a row to the top level.Parameters: parent A valid TreeIter, or NULL
Returns: Iterator for the new row.
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.
Removes all items from the treestore.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 aList
with the types for every column as a
DataColumn
object.
Returns: the list of DataColumn
's
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 type of the columnaCol
as a
DataColumn
. This is similar to calling
getType(int)
; the difference is that this method returns
the type as a DataColumn, which is a more high-level structure.
Parameters: aCol the column index
Returns: the corresponding DataColumn
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 depth of the iterator. This will be 0 for anything on the root level, 1 for anything down a level, etc.Parameters: iter The iterator to test the depth of
Returns: Depth of the iterator.
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.
Gets all the values in the row indicated byaIter
. There
are several ways you can get a TreeIter
to pass; for
example: using methods like getIter
and
getFirstIter()
, or from a TreeSelection
.
Parameters: aIter the iter pointing to the row
Returns: a DataRow
filled with the values of the row.
See Also: getIter getIter getFirstIter TreeSelection
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.
Get a DataColumn object representing the currently sorted column. This is not the same DataColumn used to create the store. It is only of type DataColumn (not DataColumnString, etc). It can be compared with another DataColumn object using the DataColumn method.Returns: A DataColumn object representing the currently sorted column or null if there is no column currently sorted.
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.
Get the current sorting order of the store.Returns: A SortType object defining the current sorting order of the store or null if there is no current sort order.
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.
Retrieve the runtime type used by the GLib library.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.
Call-back method invoked by the JNI code when sorting is required. This is for internal use only.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 row at position. If parent is non-NULL, then the row will be made a child of parent. Otherwise, the row will be created at the toplevel. If position is larger than the number of rows at that level, then the new row will be inserted to the end of the list.Parameters: parent A valid TreeIter, or NULL position Position to insert the new row
Returns: Iterator for the new row
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.
Inserts a new row after sibling. If sibling is NULL, then the row will be prepended to the beginning of the parent 's children. If parent and sibling are NULL, then the row will be prepended to the toplevel. If both sibling and parent are set, then parent must be the parent of sibling. When sibling is set, parent is optional.Parameters: parent A valid TreeIter, or NULL sibling A valid GtkTreeIter, or NULL
Returns: Iterator for the new row.
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.
Inserts a new row before sibling. If sibling is NULL, then the row will be appended to parent 's children. If parent and sibling are NULL, then the row will be appended to the toplevel. If both sibling and parent are set, then parent must be the parent of sibling. When sibling is set, parent is optionalParameters: parent A valid TreeIter, or NULL sibling A valid TreeIter, or NULL
Returns: Iterator for the new row.
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 iter is an ancestor of descendant. That is, iter is the parent (or grandparent or great-grandparent) of descendant.Parameters: iter Row to be tested. descendant Descendant row for testing
Returns: True of iter is an ancestor of 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.
Moves iter in this store to the position after position. iter and position should be in the same level. Note that this function only works with unsorted stores.Since: 2.2
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 iter in tree_store to the position before position. iter and position should be in the same level. Note that this function only works with unsorted stores.Since: 2.2
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 iter to the end of the modelSince: 2.2
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 iter in this store to the start of the store.Since: 2.2
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 row to the store. If parent is non-NULL, then it will prepend the new row before the first child of parent, otherwise it will prepend a row to the top level.Parameters: parent A valid TreeIter, or NULL
Returns: Iterator for the new row.
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.
Removes a row from the tree store. After being removed, iter is set to the next valid row at that level, or invalidated if it previously pointed to the last one.Parameters: iter TreeIter representing the row.
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.
This method has not yet been implemented.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.
This method has not yet been implemented.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.
Sets all columns pointed byaIter
to the values stored in
aRow
.
Parameters: aRow
a row with items aIter
a TreeIter
pointing to a row in the tree.
See Also: getRowAt
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.
Set the column in the list to sort on.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.
Set the class used to sort the list according to the values stored in the given DataColumn.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.
Sets a value in the dataStore. The type of the value must match the type set for that dataBlock in the constructor.This does not make the data visible in any of the widgets which use the class - to do that, you have to construct a TreeViewColumn and add it to the TreeView; construct and add a CellRenderer to that; and finally associate the properties of the CellRenderer with the dataBlocks, using the TreeViewColumn method.
Parameters: dataBlock The datablock in which the data should be stored. iter Valid iterator for the data row in which the value is to be set. These can be gotten using methods such as appendRow. value The value to be set.
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.
Sets a value in the dataStore. The type of the value must match the type set for that dataBlock in the constructor.This does not make the data visible in any of the widgets which use the class - to do that, you have to construct a TreeViewColumn and add it to the TreeView; construct and add a CellRenderer to that; and finally associate the properties of the CellRenderer with the dataBlocks, using the TreeViewColumn method.
Parameters: dataBlock The datablock in which the data should be stored. iter Valid iterator for the data row in which the value is to be set. These can be gotten using methods such as appendRow. value The value to be set.
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.
Sets a value in the dataStore. The type of the value must match the type set for that dataBlock in the constructor.This does not make the data visible in any of the widgets which use the class - to do that, you have to construct a TreeViewColumn and add it to the TreeView; construct and add a CellRenderer to that; and finally associate the properties of the CellRenderer with the dataBlocks, using the TreeViewColumn method.
Parameters: dataBlock The datablock in which the data should be stored. iter Valid iterator for the data row in which the value is to be set. These can be gotten using methods such as appendRow. value The value to be set.
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.
Sets a value in the dataStore. The type of the value must match the type set for that dataBlock in the constructor.This does not make the data visible in any of the widgets which use the class - to do that, you have to construct a TreeViewColumn and add it to the TreeView; construct and add a CellRenderer to that; and finally associate the properties of the CellRenderer with the dataBlocks, using the TreeViewColumn method.
Parameters: dataBlock The datablock in which the data should be stored. iter Valid iterator for the data row in which the value is to be set. These can be gotten using methods such as appendRow. value The value to be set.
Since: 2.8.5
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.
Sets a value in the dataStore. The type of the value must match the type set for that dataBlock in the constructor.This does not make the data visible in any of the widgets which use the class - to do that, you have to construct a TreeViewColumn and add it to the TreeView; construct and add a CellRenderer to that; and finally associate the properties of the CellRenderer with the dataBlocks, using the TreeViewColumn method.
Parameters: dataBlock
The datablock in which the data should be stored. iter
Valid iterator for the data row in which the value is to be
set. These can be gotten using methods such as
appendRow. value
The long
value to set into this row.
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.
Sets a value in the dataStore. The type of the value must match the type set for that dataBlock in the constructor.This does not make the data visible in any of the widgets which use the class - to do that, you have to construct a TreeViewColumn and add it to the TreeView; construct and add a CellRenderer to that; and finally associate the properties of the CellRenderer with the dataBlocks, using the TreeViewColumn method.
Parameters: dataBlock The datablock in which the data should be stored. iter Valid iterator for the data row in which the value is to be set. These can be gotten using methods such as appendRow. value The value to be set.
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.
Sets a value in the dataStore. The type of the value must match the type set for that dataBlock in the constructor.This does not make the data visible in any of the widgets which use the class - to do that, you have to construct a TreeViewColumn and add it to the TreeView; construct and add a CellRenderer to that; and finally associate the properties of the CellRenderer with the dataBlocks, using the TreeViewColumn method.
Parameters: dataBlock The datablock in which the data should be stored. iter Valid iterator for the data row in which the value is to be set. These can be gotten using methods such as appendRow. value The value to be set.
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.
Sets a value in the dataStore. The type of the value must match the type set for that dataBlock in the constructor.This does not make the data visible in any of the widgets which use the class - to do that, you have to construct a TreeViewColumn and add it to the TreeView; construct and add a CellRenderer to that; and finally associate the properties of the CellRenderer with the dataBlocks, using the TreeViewColumn method.
Parameters: dataBlock The data block in which to store the data, starting at 0. iter Valid iterator for the data row in which the value is to be set. These can be gotten using methods such as appendRow. value The value to be set. This must match the type for that dataBlock, as set in the constructor.
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.
Sets a value in the dataStore. The type of the value must match the type set for that dataBlock in the constructor.This does not make the data visible in any of the widgets which use the class - to do that, you have to construct a TreeViewColumn and add it to the TreeView; construct and add a CellRenderer to that; and finally associate the properties of the CellRenderer with the dataBlocks, using the TreeViewColumn method.
Parameters: dataBlock The data block in which to store the data, starting at 0. iter Valid iterator for the data row in which the value is to be set. These can be gotten using methods such as appendRow. value The value to be set.
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.
Swaps a and b in the same level of tree_store. Note that this function only works with unsorted stores.Since: 2.2