Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.10

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

interface XGridRowSelection
Description
This interfaces provides access to the selection of row for UnoControlGrid.
Since
OOo 3.4

Methods' Summary
selectAllRows Selects all rows.  
selectRow selects a given row  
deselectAllRows Deselects all selected rows.  
deselectRow removes the selection for a given row  
getSelectedRows Returns the indicies of all selected rows.  
hasSelectedRows Returns whether rows are selected.  
isRowSelected Returns whether a specific row is selected.  
addSelectionListener Adds a listener for the GridSelectionEvent posted after the grid changes.  
removeSelectionListener Removes a listener previously added with addSelectionListener().  
Methods' Details
selectAllRows
void
selectAllRows();

Description
Selects all rows.
selectRow
void
selectRow( [in] long  RowIndex )
raises( ::com::sun::star::lang::IndexOutOfBoundsException );

Description
selects a given row
Parameter RowIndex
denotes the index of the row to select @raises ::com::sun::star::lang::IndexOutOfBoundsException if RowIndex does not denote a valid row index
deselectAllRows
void
deselectAllRows();

Description
Deselects all selected rows.
deselectRow
void
deselectRow( [in] long  RowIndex )
raises( ::com::sun::star::lang::IndexOutOfBoundsException );

Description
removes the selection for a given row
Parameter RowIndex
denotes the index of the row to deselect
getSelectedRows
sequence< long >
getSelectedRows();

Description
Returns the indicies of all selected rows.
Returns
a sequence of indicies.
hasSelectedRows
boolean
hasSelectedRows();

Description
Returns whether rows are selected.
Returns
true if and only if at least one row is selected.
isRowSelected
boolean
isRowSelected( [in] long  RowIndex );

Description
Returns whether a specific row is selected.
Parameter RowIndex
the index of a row. If the value does not denote a valid row index, i.e. is smaller than 0 or greater than the number of rows, this is silently ignored, and false is returned.
Returns
true if and only if there is a row with the given index, and it is selected currently.
addSelectionListener
void
addSelectionListener( [in] XGridSelectionListener  listener );

Description
Adds a listener for the GridSelectionEvent posted after the grid changes.
Parameter listener
the listener to add.
removeSelectionListener
void
removeSelectionListener( [in] XGridSelectionListener  listener );

Description
Removes a listener previously added with addSelectionListener().
Parameter listener
the listener to remove.
Top of Page

Apache Software Foundation

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

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