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 ::

interface XGridControl
Description
An interface to a control that displays a tabular data.
Since
OOo 3.3
See also
UnoControlGrid

Methods' Summary
getColumnAtPoint retrieves the column which a given point belongs to  
getRowAtPoint retrieves the row which a given point belongs to  
getCurrentColumn returns the column index of the currently active cell  
getCurrentRow returns the row index of the currently active cell  
goToCell moves the cursor to the given cell  
Methods' Details
getColumnAtPoint
long
getColumnAtPoint( [in] long  X,
[in] long  Y );

Description
retrieves the column which a given point belongs to
Parameter X
the ordinate of the point, in pixel coordinates.
Parameter Y
the abscissa of the point, in pixel coordinates.
Returns
the index of the column which the point lies in, or -1 if no column is under the given point.
getRowAtPoint
long
getRowAtPoint( [in] long  X,
[in] long  Y );

Description
retrieves the row which a given point belongs to
Parameter X
the ordinate of the point, in pixel coordinates.
Parameter Y
the abscissa of the point, in pixel coordinates.
Returns
the index of the row which the point lies in, or -1 if no row is under the given point.
getCurrentColumn
long
getCurrentColumn();

Description
returns the column index of the currently active cell

If the grid control's does not contain any cells (which happens if the grid column model does not contain any columns, or if grid data model does not contain any rows), then -1 is returned.

getCurrentRow
long
getCurrentRow();

Description
returns the row index of the currently active cell

If the grid control's does not contain any cells (which happens if the grid column model does not contain any columns, or if grid data model does not contain any rows), then -1 is returned.

goToCell
void
goToCell( [in] long  ColumnIndex,
[in] long  RowIndex )
raises( ::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::util::VetoException );

Description
moves the cursor to the given cell
Parameter ColumnIndex
the column index of the cell to activate.
Parameter RowIndex
the row index of the cell to activate.
Throws
::com::sun::star::lang::IndexOutOfBoundsException if either ColumnIndex or RowIndex are out of range.
Throws
::com::sun::star::util::VetoException if moving the cursor to another cell is vetoed.
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.