:: com :: sun :: star :: awt :: grid ::

interface XSortableGridData

Methods' Summary
sortByColumn sorts the rows represented by the model by a given column's data.  
removeColumnSort removes any possibly present sorting of the grid data  
getCurrentSortOrder returns the current sort order.  
Methods' Details
sortByColumn
void
sortByColumn( [in] long  ColumnIndex,
[in] boolean  SortAscending )
raises( ::com::sun::star::lang::IndexOutOfBoundsException );

Description
sorts the rows represented by the model by a given column's data.
Parameter ColumnIndex
the index of the column whose data should be used as sort key
Parameter SortAscending
is `TRUE` if the data should be sorted ascending, `FALSE` otherwise.
Throws
::com::sun::star::lang::IndexOutOfBoundsException if ColumnIndex does not denote a valid column.
removeColumnSort
void
removeColumnSort();

Description
removes any possibly present sorting of the grid data
getCurrentSortOrder
::com::sun::star::beans::Pair< string, string >
getCurrentSortOrder();

Description
returns the current sort order.
Returns
a structure describing the current sort order. com::sun::star::beans::Pair::First denotes the column by which the data is sorted, or -1 if the data is currently unsorted. com::sun::star::beans::Pair::Second is `TRUE` if the data is sorted ascending, `FALSE` otherwise.
Top of Page