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

unpublished interface XGridSelection
Usage Restrictions
not published
Description
This interfaces provides access to the selection of row for UnoControlGrid.

Methods' Summary
getMinSelectionIndex Returns the lowest index of the selection.  
getMaxSelectionIndex Returns the highest index of the selection.  
selectAllRows Selects all rows.  
selectRows Selects multiple rows. Previous selections will be removed.  
deselectAllRows Deselects all selected rows.  
deselectRows Deselects selected rows. Selected rows, which aren't in the range remain selected.  
getSelection Returns the indicies of all selected rows.  
isSelectionEmpty Returns whether rows are selected.  
isSelectedIndex Returns whether a specific row is selected.  
selectRow Marks a row as selected.  
addSelectionListener Adds a listener for the GridSelectionEvent posted after the grid changes.  
removeSelectionListener Removes a listener previously added with addSelectionListener().  
Methods' Details
getMinSelectionIndex
long
getMinSelectionIndex();

Description
Returns the lowest index of the selection.
Returns
the lowest index.
getMaxSelectionIndex
long
getMaxSelectionIndex();

Description
Returns the highest index of the selection.
Returns
the highest index.
selectAllRows
[oneway] void
selectAllRows();

Description
Selects all rows.
selectRows
[oneway] void
selectRows( [in] sequence< long >  rangeOfRows );

Description
Selects multiple rows. Previous selections will be removed.
Parameter rangeOfRows
array of rows indexes, which will be selected.
deselectAllRows
[oneway] void
deselectAllRows();

Description
Deselects all selected rows.
deselectRows
[oneway] void
deselectRows( [in] sequence< long >  rangeOfRows );

Description
Deselects selected rows. Selected rows, which aren't in the range remain selected.
Parameter rangeOfRows
array of rows indexes, which will be deselected.
getSelection
sequence< long >
getSelection();

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

Description
Returns whether rows are selected.
Returns
true if rows are selected otherwise false.
isSelectedIndex
boolean
isSelectedIndex( [in] long  index );

Description
Returns whether a specific row is selected.
Parameter the
index of a row.
Returns
true if row are selected otherwise false.
selectRow
[oneway] void
selectRow( [in] long  index );

Description
Marks a row as selected.
Parameter index
the index of a row.
addSelectionListener
[oneway] void
addSelectionListener( [in] XGridSelectionListener  listener );

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

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