|
|||||||||
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.GObject
org.gnu.gtk.TreeModel
org.gnu.gtk.ListStore
public class ListStore
The ListStore is the gtk Model used for constructing Lists and tables to be
displayed within 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 | |
---|---|
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. |
java.util.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(org.gnu.glib.Handle model,
org.gnu.glib.Handle aIter,
org.gnu.glib.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,
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,
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,
DataColumnObject dataBlock,
java.lang.Object value)
Sets a value in the dataStore. |
void |
setValue(TreeIter iter,
DataColumnPixbuf dataBlock,
Pixbuf 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,
DataColumnString dataBlock,
java.lang.String value)
Sets a value in the data store. |
void |
swapRows(TreeIter a,
TreeIter b)
Swaps a and b in the same level of tree_store. |
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 |
Methods inherited from class org.gnu.glib.Struct |
---|
equals, getHandle, getNullHandle, hashCode |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.gnu.gtk.TreeSortable |
---|
getHandle |
Constructor Detail |
---|
public ListStore(DataColumn[] dataColumns)
dataColumns
- a list of dataColumns for the store. These should be created
as private variables of the required type - they will be
needed later.Method Detail |
---|
public void addRow(DataRow aRow)
DataColumn
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.
aRow
- a row to be added to the listpublic void addRowAt(DataRow aRow, int aPosition)
DataColumn
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.
aRow
- a row to be added to the listpublic DataRow getRowAt(TreeIter aIter)
aIter
. There
are several ways you can get a TreeIter
to pass; for
example: using methods like getIter
and
getFirstIter()
, or from a TreeSelection
.
aIter
- the iter pointing to the row
DataRow
filled with the values of the row.TreeModel.getIter(String)
,
TreeModel.getIter(TreePath)
,
TreeModel.getFirstIter()
,
TreeSelection
public void setRowAt(DataRow aRow, TreeIter aIter)
aIter
to the values stored in
aRow
.
aRow
- a row with itemsaIter
- a TreeIter
pointing to a row in the tree.getRowAt(TreeIter)
public void setColumnTypes(DataColumn[] dataColumns)
dataColumns
- the data columns to be setpublic DataColumn getDataColumn(int aCol)
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.
aCol
- the column index
public java.util.List getAllDataColumns()
List
with the types for every column as a
DataColumn
object.
DataColumn
'spublic void setValue(TreeIter iter, DataColumnString dataBlock, java.lang.String value)
TreeViewColumn
.
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.public void setValue(TreeIter iter, DataColumnStockItem dataBlock, GtkStockItem value)
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.addAttributeMapping(CellRenderer, CellRendererAttribute,
DataColumn)
method.
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.public void setValue(TreeIter iter, DataColumnIconSize dataBlock, IconSize value)
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.addAttributeMapping(CellRenderer, CellRendererAttribute,
DataColumn)
method.
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.public void setValue(TreeIter iter, DataColumnInt dataBlock, int value)
TreeViewColumn
.
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.public void setValue(TreeIter iter, DataColumnLong dataBlock, long value)
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.addAttributeMapping(CellRenderer, CellRendererAttribute,
DataColumn)
method.
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(TreeIter)
.value
- The long
value to set into this row.public void setValue(TreeIter iter, DataColumnBoolean dataBlock, boolean value)
TreeViewColumn
.
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.public void setValue(TreeIter iter, DataColumnDouble dataBlock, double value)
TreeViewColumn
.
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.public void setValue(TreeIter iter, DataColumnObject dataBlock, java.lang.Object value)
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.public void setValue(TreeIter iter, DataColumnPixbuf dataBlock, Pixbuf value)
This does not make the data visible in any of the widgets which use the class
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.public boolean removeRow(TreeIter iter)
iter
is set to be the next valid row, or invalidated if it
pointed to the last row in this store.
iter
- iterator for the row to be removed.
public TreeIter insertRow(int position)
position
. If position is larger than
the number of rows on the list, then the new row will be appended to the
list.
position
- The position to place the new row, starting at 0.
public TreeIter insertRowBefore(TreeIter sibling)
sibling
-
public TreeIter insertRowAfter(TreeIter sibling)
sibling
-
public TreeIter prependRow()
public TreeIter appendRow()
public void clear()
public static Type getType()
public void setSortColumn(DataColumn column, SortType order)
setSortColumn
in interface TreeSortable
public DataColumn getSortColumn()
DataColumn.equals(org.gnu.gtk.DataColumn)
method.
getSortColumn
in interface TreeSortable
public SortType getSortOrder()
getSortOrder
in interface TreeSortable
public void setSortMethod(TreeIterComparison method, DataColumn column)
setSortMethod
in interface TreeSortable
public int handleCompareFunc(org.gnu.glib.Handle model, org.gnu.glib.Handle aIter, org.gnu.glib.Handle bIter, int col)
handleCompareFunc
in interface TreeSortable
public void setDragDestListener(TreeDragDestListener listener)
setDragDestListener
in interface TreeDragDest
public void setDragSourceListener(TreeDragSourceListener listener)
setDragSourceListener
in interface TreeDragSource
public void swapRows(TreeIter a, TreeIter b)
public void moveRowToEnd(TreeIter iter)
public void moveRowAfter(TreeIter iter, TreeIter position)
public void moveRowToStart(TreeIter iter)
public void moveRowBefore(TreeIter iter, TreeIter position)
public boolean isIterValid(TreeIter iter)
public void reorder(int[] newOrder)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |