org.gnu.gtk

Class TreeModelSort

Implemented Interfaces:
TreeSortable

public class TreeModelSort
extends TreeModel
implements TreeSortable

Class for sorting the rows of a base TreeModel. The underlying TreeModel us sorted using a comparison function. The comparison function is set with the setSortMethod(TreeIterComparison,DataColumn) method.

Constructor Summary

TreeModelSort(TreeModel model)
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.

Method Summary

TreePath
convertChildPathToPath(TreePath childPath)
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.
TreePath
convertPathToChildPath(TreePath sortedPath)
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.
TreeModel
getModel()
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.
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.
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.
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.
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.
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.
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.

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

Constructor Details

TreeModelSort

public TreeModelSort(TreeModel model)

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.

Create a new TreeModelSort using the given TreeModel as the underlying data model.

Method Details

convertChildPathToPath

public TreePath convertChildPathToPath(TreePath childPath)

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.

Converts childPath to a path relative to the TreeModelSort. That is, childPath points to a path in the child model. The returned path will point to the same row in the sorted model. If childPath isn't a valid path on the child model, then NULL is returned.
Parameters:
childPath - A TreePath to convert.
Returns:
TreePath, or NULL

convertPathToChildPath

public TreePath convertPathToChildPath(TreePath sortedPath)

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.

Converts sortedPath to a path on the child model of the TreeModelSort. That is, sortedPath points to a location in the TreeModelSort. The returned path will point to the same location in the model not being sorted. If sortedPath does not point to a location in the child model, NULL is returned.
Parameters:
sortedPath - A TreePath to convert.
Returns:
A GtkTreePath, or NULL

getModel

public TreeModel getModel()

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.

Return the underlying data model.

getSortColumn

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 the DataColumn.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.

getSortOrder

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.

getType

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.

handleCompareFunc

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

setSortColumn

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

setSortMethod

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