LibreOffice
LibreOffice 5.0 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
SortableGridDataModel Service Reference

provides a default implementation of a XSortableGridData. More...

import "SortableGridDataModel.idl";

Inheritance diagram for SortableGridDataModel:
XSortableMutableGridDataModel XMutableGridDataModel XSortableGridData XGridDataModel XComponent XCloneable XInterface XInterface

Public Member Functions

 create ([in] XMutableGridDataModel DelegatorModel) raises ( ::com::sun::star::lang::IllegalArgumentException )
 creates a new instance of the SortableGridDataModel More...
 
 createWithCollator ([in] XMutableGridDataModel DelegatorModel,[in]::com::sun::star::i18n::XCollator Collator) raises ( ::com::sun::star::lang::IllegalArgumentException )
 creates a new instance of the ScortableDefaultGridDataModel, passing a collator to be used for string comparison. More...
 

Additional Inherited Members

- Exported Interfaces inherited from XSortableMutableGridDataModel
interface XMutableGridDataModel
 provides access to the basic functionality of a grid data model, plus functions to modify it. More...
 
interface XSortableGridData
 provides means to sort the data represented by the model. More...
 
- Public Attributes inherited from XGridDataModel
long RowCount
 denotes the number of rows for which the model can provide data More...
 
long ColumnCount
 denotes the number of columns for which the model can provide data More...
 

Detailed Description

provides a default implementation of a XSortableGridData.

This service must be created with a secondary grid data model, which all actual data requests are delegated to. But before providing this data to the service's own clients, it is sorted, according to the sort order defined via the XSortableGridData interface.

The service implementation is able to compare the default scalar types, plus strings.

For determining the data type of a column which the data should be sorted by, the first non-VOID data encountered in this column is taken into account. Further read requests to this column will assume that all non-VOID data is of the same type.

Consequently, you cannot use this service with data sets containing heterogeneous data in a given column.

All requests made via the XMutableGridDataModel are delegated to the XMutableGridDataModel instance passed in the service constructor.

Note that changing the data might result in the sort order being destroyed. If you want to ensure that the data represented by the model is still sorted after your modifications, you should call XSortableGridData::sortByColumn(), again.

Member Function Documentation

create ( [in] XMutableGridDataModel  DelegatorModel)
raises (::com::sun::star::lang::IllegalArgumentException
)

creates a new instance of the SortableGridDataModel

For string comparison, a default com::sun::star::i18n::Collator, based on the system's locale, will be used.

Parameters
DelegatorModelthe data model to which read requests are delegated.
Exceptions
com::sun::star::lang::IllegalArgumentExceptionif the given DelegatorModel is NULL
createWithCollator ( [in] XMutableGridDataModel  DelegatorModel,
[in] ::com::sun::star::i18n::XCollator  Collator 
)
raises (::com::sun::star::lang::IllegalArgumentException
)

creates a new instance of the ScortableDefaultGridDataModel, passing a collator to be used for string comparison.

Parameters
DelegatorModelis the data model to which read requests are delegated
Collatoris the collator to be used for string comparison
Exceptions
com::sun::star::lang::IllegalArgumentExceptionif the given DelegatorModel is NULL

The documentation for this service was generated from the following file: