Methods' Details |
getAccessibleRowCount
long
getAccessibleRowCount(); |
|
|
- Description
- Returns the number of used rows in the table.
The implementation, however, may allow the access of columns
beyond this number.
- Returns
-
Returns the number of used rows in the table or 0 for an empty
table.
|
|
getAccessibleColumnCount
long
getAccessibleColumnCount(); |
|
|
- Description
- Returns the number of used columns in the table.
The implementation, however, may allow the access of columns
beyond this number.
- Returns
-
Returns the number of used columns in the table or 0 for an empty
table.
|
|
getAccessibleRowDescription
string
getAccessibleRowDescription( |
[in] long
raises(
|
nRow )
::com::sun::star::lang::IndexOutOfBoundsException ); |
- Description
- Returns the description text of the specified row in the
table.
- Parameter nRow
-
The index of the row for which to retrieve the description.
- Returns
-
Returns the description text of the specified row in the table
if such a description exists. Otherwise an empty string is
returned.
- Throws
- ::com::sun::star::lang::IndexOutOfBoundsException
if the specified row index is not valid, i.e. lies not inside
the valide range of 0 up to
XAccessibleTable::getAccessibleRowCount() - 1.
|
|
getAccessibleColumnDescription
string
getAccessibleColumnDescription( |
[in] long
raises(
|
nColumn )
::com::sun::star::lang::IndexOutOfBoundsException ); |
- Description
- Returns the description text of the specified column in the
table.
- Parameter nColumn
-
The index of the column for which to retrieve the description.
- Returns
-
Returns the description text of the specified row in the table
if such a description exists. Otherwise an empty string is
returned.
- Throws
- ::com::sun::star::lang::IndexOutOfBoundsException
if the specified column index is not valid, i.e. lies not inside
the valide range of 0 up to
XAccessibleTable::getAccessibleColumnCount() - 1.
|
|
getAccessibleRowExtentAt
long
getAccessibleRowExtentAt( |
[in] long
[in] long
raises(
|
nRow,
nColumn )
::com::sun::star::lang::IndexOutOfBoundsException ); |
- Description
- Returns the number of rows occupied by the Accessible at the
specified row and column in the table.
The result differs from 1 if the specified cell spans multiple
rows.
- Parameter nRow
-
Row index of the accessible for which to return the column
extent.
- Parameter nColumn
-
Column index of the accessible for which to return the column
extent.
- Returns
-
Returns the row extent of the specified cell.
- Throws
- ::com::sun::star::lang::IndexOutOfBoundsException
if the specified row index is not valid, i.e. lies not inside
the valide range of 0 up to
XAccessibleTable::getAccessibleRowCount() - 1.
|
|
getAccessibleColumnExtentAt
long
getAccessibleColumnExtentAt( |
[in] long
[in] long
raises(
|
nRow,
nColumn )
::com::sun::star::lang::IndexOutOfBoundsException ); |
- Description
- Returns the number of columns occupied by the Accessible at the
specified row and column in the table.
The result differs from 1 if the specified cell spans multiple
columns.
- Parameter nRow
-
Row index of the accessible for which to return the column
extent.
- Parameter nColumn
-
Column index of the accessible for which to return the column
extent.
- Returns
-
Returns the column extent of the specified.
- Throws
- ::com::sun::star::lang::IndexOutOfBoundsException
if the specified column index is not valid, i.e. lies not inside
the valide range of 0 up to
XAccessibleTable::getAccessibleColumnCount() - 1.
|
|
getAccessibleRowHeaders
- Description
- Returns the row headers as an XAccessibleTable
object.
Content and size of the returned table are implementation
dependent.
- Returns
-
Returns allways a valid reference to an
XAccessibleTable object.
|
|
getAccessibleColumnHeaders
- Description
- Returns the column headers as an XAccessibleTable
object.
Content and size of the returned table are implementation
dependent.
- Returns
-
Returns allways a valid reference to an
XAccessibleTable object.
|
|
getSelectedAccessibleRows
sequence< long >
getSelectedAccessibleRows(); |
|
|
- Description
- Returns a list of the indices of completely selected rows in a
table.
- Returns
-
The returned sequence contains indices of all completely
selected rows in the table. This sequence is in ascending
order. If no row is selected then the sequence is empty.
|
|
getSelectedAccessibleColumns
sequence< long >
getSelectedAccessibleColumns(); |
|
|
- Description
- Returns a list of the indices of completely selected columns in a
table.
- Returns
-
The returned sequence contains indices of all completely
selected columns in the table. This sequence is in ascending
order. If no column is selected then the sequence is empty.
|
|
isAccessibleRowSelected
boolean
isAccessibleRowSelected( |
[in] long
raises(
|
nRow )
::com::sun::star::lang::IndexOutOfBoundsException ); |
- Description
- Returns a boolean value indicating whether the specified row is
completely selected.
- Parameter nRow
-
Index of the row for which to determine whether it is selected.
- Returns
-
Returns true if the specified row is selected completely and
false otherwise.
- Throws
- ::com::sun::star::lang::IndexOutOfBoundsException
if the specified row index is not valid, i.e. lies not inside
the valide range of 0 up to
XAccessibleTable::getAccessibleRowCount() - 1.
|
|
isAccessibleColumnSelected
boolean
isAccessibleColumnSelected( |
[in] long
raises(
|
nColumn )
::com::sun::star::lang::IndexOutOfBoundsException ); |
- Description
- Returns a boolean value indicating whether the specified column
is completely selected.
- Parameter nColumn
-
Index of the column for which to determine whether it is
selected.
- Returns
-
Returns true if the specified column is selected completely
and false otherwise.
- Throws
- ::com::sun::star::lang::IndexOutOfBoundsException
if the specified column index is not valid, i.e. lies not inside
the valide range of 0 up to
XAccessibleTable::getAccessibleColumnCount() - 1.
|
|
getAccessibleCellAt
XAccessible
getAccessibleCellAt( |
[in] long
[in] long
raises(
|
nRow,
nColumn )
::com::sun::star::lang::IndexOutOfBoundsException ); |
- Description
- Returns the XAccessible object at the specified row
and column in the table.
This method has been renamed from the Java name
getAccessibleAt to
XAccessibleTable::getAccessibleCellAt to avoid
ambiguities with the
XAccessibleComponent::getAccessibleAt method when
accessed, for instance, from StarBasic.
- Parameter nRow
-
The row index for which to retrieve the cell.
- Parameter nColumn
-
The column index for which to retrieve the cell.
- Returns
-
If both row and column index are valid then the corresponding
XAccessible object is returned that represents the
requested cell regardless of whether the cell is currently
visible (on the screen).
- Throws
- ::com::sun::star::lang::IndexOutOfBoundsException
if the specified column and/or row index is not valid, i.e. lies not inside
the valide range of 0 up to
XAccessibleTable::getAccessibleColumnCount() - 1.
|
|
getAccessibleCaption
- Description
- Returns the caption for the table.
- Returns
-
If the table has a caption then a reference to it is returned,
else an empty reference is returned.
|
|
getAccessibleSummary
- Description
- Returns the summary description of the table.
- Returns
-
Returns a reference to an implementation dependent
XAccessible object representing the table's summary
or an empty reference if the table does not support a summary.
|
|
isAccessibleSelected
boolean
isAccessibleSelected( |
[in] long
[in] long
raises(
|
nRow,
nColumn )
::com::sun::star::lang::IndexOutOfBoundsException ); |
- Description
- Returns a boolean value indicating whether the accessible at the
specified row and column is selected.
- Parameter nRow
-
Row index of the cell for which to determine if the accessible
object that spans that cell is selected.
- Parameter nColumn
-
Column index of the cell for which to determine if the
accessible object that spans that cell is selected.
- Returns
-
Returns true if the given row and column indices are valid
and the specified accessible object is selected. Otherwise
false is returned.
|
|
getAccessibleIndex
long
getAccessibleIndex( |
[in] long
[in] long
raises(
|
nRow,
nColumn )
::com::sun::star::lang::IndexOutOfBoundsException ); |
- Description
- Returns the child index of the accessible object that spans the
specified cell.
This is the same index that would be returned by calling
XAccessibleContext::getAccessibleIndexInParent for
that accessible object.
- Parameter nRow
-
Row index of the accessible object for which to return the child
index.
- Parameter nColumn
-
Row index of the accessible object for which to return the child
index.
- Returns
-
Child index of the specified accessible object or -1 if one or
both of the given indices is/are invalid.
|
|
getAccessibleRow
long
getAccessibleRow( |
[in] long
raises(
|
nChildIndex )
::com::sun::star::lang::IndexOutOfBoundsException ); |
- Description
- Translate the given child index into the corresponding row
index.
- Parameter nChildIndex
-
Index of the child of the table for which to return the row
index.
- Returns
-
Returns the row index of the cell of the specified child or the
index of the first row if the child spans multiple rows.
- Throws
- ::com::sun::star::lang::IndexOutOfBoundsException
if nChildIndex addresses an invalid row.
|
|
getAccessibleColumn
long
getAccessibleColumn( |
[in] long
raises(
|
nChildIndex )
::com::sun::star::lang::IndexOutOfBoundsException ); |
- Description
- Translate the given child index into the corresponding column
index.
- Parameter nChildIndex
-
Index of the child of the table for which to return the column
index.
- Returns
-
Returns the column index of the cell of the specified child or
the index of the first column if the child spans multiple
columns.
- Throws
- ::com::sun::star::lang::IndexOutOfBoundsException
if nChildIndex addresses an invalid column.
|
|
Copyright © 2003 Sun Microsystems, Inc.