org.gnu.gtk
public class ListStore extends TreeModel implements TreeSortable, TreeDragSource, TreeDragDest
The list store has a number of DataColumns, 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 | |
---|---|
ListStore(DataColumn[] dataColumns)
Constructs a new ListStore object for storing data in a list style
manner. |
Method Summary | |
---|---|
void | addRow(DataRow aRow)
Adds a row to the list. |
void | addRowAt(DataRow aRow, int aPosition)
Adds a row to the list, at the specified position. |
TreeIter | appendRow()
Appends a new row to the store
|
void | clear()
Removes all rows from the list store. |
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 . |
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(int position)
Creates a new row at position . |
TreeIter | insertRowAfter(TreeIter sibling)
Inserts a new row after sibling. |
TreeIter | insertRowBefore(TreeIter sibling)
Inserts a new row before sibling. |
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 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()
Prepends a new row to list_store. |
boolean | removeRow(TreeIter iter)
Removes the given row from the list store. |
void | reorder(int[] newOrder) |
void | setColumnTypes(DataColumn[] dataColumns)
This function is meant primarily for GObjects that inherit from
ListStore, and should only be used when constructing a new ListStore. |
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 data store. |
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 data store. |
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 data store. |
void | setValue(TreeIter iter, DataColumnDouble dataBlock, double value)
Sets a value in the data store. |
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. |
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.
{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
{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
Returns: Iterator for the new row
List
with the types for every column as a
DataColumn
object.
Returns: the list of DataColumn
's
aCol
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
aIter
. 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
Returns: A DataColumn object representing the currently sorted column or null if there is no column currently sorted.
Returns: A SortType object defining the current sorting order of the store or null if there is no current sort order.
position
. 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
Parameters: sibling
Returns: Iterator for the new row.
Parameters: sibling
Returns: Iterator for the new row
Since: 2.2
Since: 2.2
Since: 2.2
Since: 2.2
Returns: Iterator for the new row
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.
Parameters: dataColumns the data columns to be set
aIter
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
Parameters: iter A valid iterator which specifies the row in which the data should be set. Iterators can be gained by using methods such as appendRow. 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.
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.
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.
Parameters: iter A valid iterator which specifies the row in which the data should be set. Iterators can be gained by using methods such as appendRow. 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.
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
ListStore. value
The long
value to set into this row.
Since: 2.8.5
Parameters: iter A valid iterator which specifies the row in which the data should be set. Iterators can be gained by using methods such as appendRow. 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.
Parameters: iter A valid iterator which specifies the row in which the data should be set. Iterators can be gained by using methods such as appendRow. dataBlock The data block to store the value in. value The value to store.
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.
This does not make the data visible in any of the widgets which use the class
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. This must match the type for that dataBlock, as set in the constructor.
Since: 2.2