Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

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

interface XGridDataModel
Base Interfaces
XGridDataModel
┣ ::com::sun::star::lang::XComponent
┗ ::com::sun::star::util::XCloneable
::com::sun::star::lang::XComponent
Description
implements life time control for the component
::com::sun::star::util::XCloneable
Description
allows cloning the complete data model
Description
An instance of this interface is used by the UnoControlGrid to retrieve the content data that is displayed in the actual control. If you do not need your own model implementation, you can also use the DefaultGridDataModel.
Since
OOo 3.3
Methods' Summary
getCellData retrieves the data for a given cell  
getCellToolTip retrieves the tool tip to be displayed when the mouse hovers over a given cell  
getRowHeading retrieves the heading of a given row  
getRowData retrieves the data for a complete row  
Attributes' Summary
RowCount denotes the number of rows for which the model can provide data  
ColumnCount denotes the number of columns for which the model can provide data  
Methods' Details
getCellData
any
getCellData( [in] long  Column,
[in] long  RowIndex )
raises( ::com::sun::star::lang::IndexOutOfBoundsException );
Description
retrieves the data for a given cell
Throws
::com::sun::star::lang::IndexOutOfBoundsException if the column or row index do not denote a valid cell position.
getCellToolTip
any
getCellToolTip( [in] long  Column,
[in] long  RowIndex )
raises( ::com::sun::star::lang::IndexOutOfBoundsException );
Description
retrieves the tool tip to be displayed when the mouse hovers over a given cell

At the moment, only string tool tips are supported.

If void is returned here, the cell's content will be displayed as tip, but only if it does not fit into the cell.

Throws
::com::sun::star::lang::IndexOutOfBoundsException if the column or row index do not denote a valid cell position.
getRowHeading
any
getRowHeading( [in] long  RowIndex )
raises( ::com::sun::star::lang::IndexOutOfBoundsException );
Description
retrieves the heading of a given row

A grid control will usually paint a row's title in the header column of the respective row.

At the moment, only strings are supported as row headings.

Throws
::com::sun::star::lang::IndexOutOfBoundsException if the given index does not denote a valid row.
getRowData
sequence< any >
getRowData( [in] long  RowIndex )
raises( ::com::sun::star::lang::IndexOutOfBoundsException );
Description
retrieves the data for a complete row

This method is provided for performance and convenience reasons, it delivers the same result as subsequent calls to getCellData would.

Parameter Row
the index of the row whose data should is to be retrieved. @raises ::com::sun::star::lang::IndexOutOfBoundsException of the given row index does not denote a valid row.
Attributes' Details
RowCount
[ readonly ] long RowCount;
Description
denotes the number of rows for which the model can provide data
ColumnCount
[ readonly ] long ColumnCount;
Description
denotes the number of columns for which the model can provide data
Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

The ASF

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

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