Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

unpublished interface XSortableGridData
Usage Restrictions
not published
Description
allows to sort the data represented by a XGridDataModel

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

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.