Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
GObject
org.gnu.gtk.TreeModel
org.gnu.gtk.ListStore
TreeView
widgets. For full details of what objects
are needed to construct lists and tables, please see the TreeView
description.
The list store has a number of DataColumn
s, or data 'columns'
associated with it. These do not correspond to the organisation of
the output into columns. The data store can in fact be used with any number
of treeView widgets, each displaying a different part of the data. In these
Java bindings, we will try to use the term dataBlock for the data in the
ListStore and Column to refer to the columns to be displayed. The data to be
displayed is set in the TreeViewColumn
objects, by associating
properties of CellRenderer
's with the data block used in this
object.
Constructor Summary | |
|
Method Summary | |
void | |
void | |
TreeIter |
|
void |
|
List |
|
DataColumn |
|
DataRow | |
DataColumn |
|
SortType |
|
static Type |
|
int |
|
TreeIter |
|
TreeIter |
|
TreeIter |
|
boolean |
|
void |
|
void |
|
void |
|
void |
|
TreeIter |
|
boolean | |
void |
|
void |
|
void |
|
void |
|
void | |
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
Methods inherited from class org.gnu.gtk.TreeModel | |
addListener , getColumnCount , getDataBlockCount , getEventListenerClass , getEventType , getFirstIter , getIter , getIter , getType , getValue , getValue , getValue , getValue , getValue , getValue , getValue , getValue , getValue , removeListener |
public ListStore(DataColumn[] dataColumns)
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 ListStore object for storing data in a list style manner. The data is stored in a set of numbered data blocks, each one of which can then be displayed in a column by setting the appropriate attribute mapping of the CellRenderers.
- Parameters:
dataColumns
- a list of dataColumns for the store. These should be created as private variables of the required type - they will be needed later.
public void addRow(DataRow aRow)
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 list. This method can be used to easily add data to the list. Each item in the DataRow must match theDataColumn
type specified in the constructor of ListStore. 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
public void addRowAt(DataRow aRow, int aPosition)
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 list, at the specified position. This method can be used to easily add data to the list. Each item in the DataRow must match theDataColumn
type specified in the constructor of ListStore. 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
public TreeIter appendRow()
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 the store
- Returns:
- Iterator for the new row
public void clear()
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 rows from the list store.
public List getAllDataColumns()
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 aDataColumn
object.
- Returns:
- the list of
DataColumn
's
public DataColumn getDataColumn(int aCol)
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 aDataColumn
. This is similar to callinggetType(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
public DataRow getRowAt(TreeIter aIter)
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 aTreeIter
to pass; for example: using methods likegetIter
andgetFirstIter()
, or from aTreeSelection
.
- Parameters:
aIter
- the iter pointing to the row
- Returns:
- a
DataRow
filled with the values of the row.
public DataColumn getSortColumn()
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 theDataColumn.equals(DataColumn)
method.
- Specified by:
- getSortColumn in interface TreeSortable
- Returns:
- A DataColumn object representing the currently sorted column or null if there is no column currently sorted.
public SortType getSortOrder()
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.
- Specified by:
- getSortOrder in interface TreeSortable
- Returns:
- A SortType object defining the current sorting order of the store or null if there is no current sort order.
public static Type getType()
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.
public int handleCompareFunc(Handle model, Handle aIter, Handle bIter, int col)
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.
- Specified by:
- handleCompareFunc in interface TreeSortable
public TreeIter insertRow(int position)
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 atposition
. If position is larger than the number of rows on the list, then the new row will be appended to the list.
- Parameters:
position
- The position to place the new row, starting at 0.
- Returns:
- Iterator for the new row
public TreeIter insertRowAfter(TreeIter sibling)
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 list. iter will be changed to point to this new row.
- Parameters:
sibling
-
- Returns:
- Iterator for the new row.
public TreeIter insertRowBefore(TreeIter sibling)
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 the end of the list. iter will be changed to point to this new row.
- Parameters:
sibling
-
- Returns:
- Iterator for the new row
public void moveRowAfter(TreeIter iter, TreeIter position)
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. The iter and position should be in the same level. Note that this function only works with unsorted stores.
- Since:
- 2.2
public void moveRowBefore(TreeIter iter, TreeIter position)
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 store to the position before position. The iter and position should be in the same level. Note that this function only works with unsorted stores.
- Since:
- 2.2
public void moveRowToEnd(TreeIter iter)
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 model
- Since:
- 2.2
public void moveRowToStart(TreeIter iter)
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
public TreeIter prependRow()
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 list_store. The iter will be changed to point to this new row. The row will be empty after this function is called.
- Returns:
- Iterator for the new row
public boolean removeRow(TreeIter iter)
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 the given row from the list store. After being removed,iter
is set to be the next valid row, or invalidated if it pointed to the last row in this store.
- Parameters:
iter
- iterator for the row to be removed.
- Returns:
- TRUE if iter is valid, FALSE if not.
public void reorder(int[] newOrder)
public void setColumnTypes(DataColumn[] dataColumns)
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 function is meant primarily for GObjects that inherit from ListStore, and should only be used when constructing a new ListStore. It will not function after a row has been added, or a method on the TreeModel interface is called.
- Parameters:
dataColumns
- the data columns to be set
public void setDragDestListener(TreeDragDestListener listener)
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.
- Specified by:
- setDragDestListener in interface TreeDragDest
public void setDragSourceListener(TreeDragSourceListener listener)
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.
- Specified by:
- setDragSourceListener in interface TreeDragSource
public void setRowAt(DataRow aRow, TreeIter aIter)
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 inaRow
.
- Parameters:
aRow
- a row with itemsaIter
- aTreeIter
pointing to a row in the tree.
- See Also:
getRowAt(TreeIter)
public void setSortColumn(DataColumn column, SortType 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.
Set the column in the list to sort on.
- Specified by:
- setSortColumn in interface TreeSortable
public void setSortMethod(TreeIterComparison method, DataColumn column)
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.
- Specified by:
- setSortMethod in interface TreeSortable
public void setValue(TreeIter iter, DataColumnBoolean dataBlock, boolean value)
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 data store. To display the data in the widget, you need to associate the datablock with the renderer, using methods of theTreeViewColumn
.
- Parameters:
iter
- A valid iterator which specifies the row in which the data should be set. Iterators can be gained by using methods such asappendRow()
.dataBlock
- The data block to store the value in.value
- The value to store. This must be of the same type for the column as that set in the constructor to the ListStore.
public void setValue(TreeIter iter, DataColumnDouble dataBlock, double value)
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 data store. To display the data in the widget, you need to associate the datablock with the renderer, using methods of theTreeViewColumn
.
- Parameters:
iter
- A valid iterator which specifies the row in which the data should be set. Iterators can be gained by using methods such asappendRow()
.dataBlock
- The data block to store the value in.value
- The value to store.
public void setValue(TreeIter iter, DataColumnIconSize dataBlock, IconSize value)
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 aTreeViewColumn
and add it to theTreeView
; construct and add aCellRenderer
to that; and finally associate the properties of the CellRenderer with the dataBlocks, using theTreeViewColumn.addAttributeMapping(CellRenderer,CellRendererAttribute,DataColumn)
method.
- Parameters:
iter
- Valid iterator for the data row in which the value is to be set. These can be gotten using methods such asappendRow()
.dataBlock
- The datablock in which the data should be stored.value
- The value to be set.
public void setValue(TreeIter iter, DataColumnInt dataBlock, int value)
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 data store. To display the data in the widget, you need to associate the datablock with the renderer, using methods of theTreeViewColumn
.
- Parameters:
iter
- A valid iterator which specifies the row in which the data should be set. Iterators can be gained by using methods such asappendRow()
.dataBlock
- The data block to store the value in.value
- The value to store. This must be of the same type for the column as that set in the constructor to the ListStore.
public void setValue(TreeIter iter, DataColumnLong dataBlock, long value)
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 aTreeViewColumn
and add it to theTreeView
; construct and add aCellRenderer
to that; and finally associate the properties of the CellRenderer with the dataBlocks, using theTreeViewColumn.addAttributeMapping(CellRenderer,CellRendererAttribute,DataColumn)
method.
- Parameters:
iter
- Valid iterator for the data row in which the value is to be set. These can be gotten using methods such asappendRow(TreeIter)
.dataBlock
- The datablock in which the data should be stored.value
- Thelong
value to set into this row.
- Since:
- 2.8.5
public void setValue(TreeIter iter, DataColumnObject dataBlock, Object value)
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.
- Parameters:
iter
- Valid iterator for the data row in which the value is to be set. These can be gotten using methods such asappendRow()
.dataBlock
- The datablock in which the data should be stored.value
- The value to be set.
public void setValue(TreeIter iter, DataColumnPixbuf dataBlock, Pixbuf value)
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
- Parameters:
iter
- Valid iterator for the data row in which the value is to be set. These can be gotten using methods such asappendRow()
.dataBlock
- The datablock in which the data should be stored.value
- The value to be set. This must match the type for that dataBlock, as set in the constructor.
public void setValue(TreeIter iter, DataColumnStockItem dataBlock, GtkStockItem value)
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 aTreeViewColumn
and add it to theTreeView
; construct and add aCellRenderer
to that; and finally associate the properties of the CellRenderer with the dataBlocks, using theTreeViewColumn.addAttributeMapping(CellRenderer,CellRendererAttribute,DataColumn)
method.
- Parameters:
iter
- Valid iterator for the data row in which the value is to be set. These can be gotten using methods such asappendRow()
.dataBlock
- The datablock in which the data should be stored.value
- The value to be set.
public void setValue(TreeIter iter, DataColumnString dataBlock, String value)
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 data store. To display the data in the widget, you need to associate the datablock with the renderer, using methods of theTreeViewColumn
.
- Parameters:
iter
- A valid iterator which specifies the row in which the data should be set. Iterators can be gained by using methods such asappendRow()
.dataBlock
- The data block to store the value in.value
- The value to store. This must be of the same type for the column as that set in the constructor to the ListStore.
public void swapRows(TreeIter a, TreeIter b)
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