nsISupports
Last changed in Gecko 2.0 (Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1)Method overview
nsIAccessible getCellAt(in long rowIndex, in long columnIndex); Renamed from cellRefAt in Gecko 1.9.2 |
long getCellIndexAt(in long rowIndex, in long columnIndex); Renamed from getIndexAt in Gecko 1.9.2 |
AString getColumnDescription(in long columnIndex); |
long getColumnExtentAt(in long row, in long column); |
long getColumnIndexAt(in long cellIndex); Renamed from getColumnAtIndex in Gecko 1.9.2 |
void getRowAndColumnIndicesAt(in long cellIndex, out long rowIndex, out long columnIndex); |
AString getRowDescription(in long rowIndex); |
long getRowExtentAt(in long row, in long column); |
long getRowIndexAt(in long cellIndex); Renamed from getRowAtIndex in Gecko 1.9.2 |
void getSelectedCellIndices(out unsigned long cellsArraySize, [retval, array, size_is(cellsArraySize)] out long cellsArray); Renamed from getSelectedCells in Gecko 1.9.2 |
void getSelectedColumnIndices(out unsigned long columnsArraySize, [retval, array, size_is(columnsArraySize)] out long columnsArray); Renamed from getSelectedColumns in Gecko 1.9.2 |
void getSelectedRowIndices(out unsigned long rowsArraySize, [retval, array, size_is(rowsArraySize)] out long rowsArray); Renamed from getSelectedRows in Gecko 1.9.2 |
boolean isCellSelected(in long rowIndex, in long columnIndex); |
boolean isColumnSelected(in long columnIndex); |
boolean isProbablyForLayout(); |
boolean isRowSelected(in long rowIndex); |
void selectColumn(in long columnIndex); |
void selectRow(in long rowIndex); |
void unselectColumn(in long columnIndex); |
void unselectRow(in long rowIndex); |
Attributes
Attribute | Type | Description |
caption |
| The caption accessible for the table. For example, html:caption element of html:table element. Read only. |
columnCount | long | The number of columns in the table. Read only. Renamed from columns in Gecko 1.9.2 |
columnHeader |
| Read only. Obsolete since Gecko 1.9.2 |
rowCount | long | The number of rows in the table. Read only. Renamed from rows in Gecko 1.9.2 |
rowHeader |
| Read only. Obsolete since Gecko 1.9.2 |
selectedCellCount | unsigned long | The total number of selected cells. Read only. Renamed from selectedCellsCount in Gecko 1.9.2 |
selectedCells |
| An array of selected cells. Read only. |
selectedColumnCount | unsigned long | The total number of selected columns. Read only. Renamed from selectedColumnsCount in Gecko 1.9.2 |
selectedRowCount | unsigned long | The total number of selected rows. Read only. Renamed from selectedRowsCount in Gecko 1.9.2 |
summary | AString | The summary description for the table. For example, @summary attribute on html:table element. Read only. |
Methods
getCellAt()
Return the accessible object at the specified row and column in the table. If both row and column index are valid then the corresponding accessible object is returned that represents the requested cell regardless of whether the cell is currently visible (on the screen).
nsIAccessible getCellAt( in long rowIndex, in long columnIndex );
Parameters
rowIndex
- The row index of the cell.
columnIndex
- The column index of the cell.
Return value
An nsIAccessible
object.
getCellIndexAt()
Translate the given row and column indices into the corresponding cell index.
long getCellIndexAt( in long rowIndex, in long columnIndex );
Parameters
rowIndex
- The row index of the cell.
columnIndex
- The column index of the cell.
Return value
A cell index.
getColumnDescription()
Return the description text of the specified column in the table.
AString getColumnDescription( in long columnIndex );
Parameters
columnIndex
- The column index.
Return value
The column description.
getColumnExtentAt()
Return the number of columns
occupied by the accessible cell at the specified row and column in the table. The result differs from 1 if the specified cell spans multiple columns
.
long getColumnExtentAt( in long row, in long column );
Parameters
row
- The row index of the cell.
column
- The column index of the cell.
Return value
The number of columns the cell spans.
getColumnIndexAt()
Return the index of the column containg the given cell index.
long getColumnIndexAt( in long cellIndex );
Parameters
cellIndex
- The cell index.
Return value
The column index.
getRowAndColumnIndicesAt()
Translate the given cell index into the corresponding row and column indices.
void getRowAndColumnIndicesAt( in long cellIndex, out long rowIndex, out long columnIndex );
Parameters
cellIndex
- Cell index to return row and column indices for.
rowIndex
- Row index at the given cell index.
columnIndex
- Column index at the given cell index.
getRowDescription()
Return the description text of the specified row in the table.
AString getRowDescription( in long rowIndex );
Parameters
rowIndex
- The row index.
Return value
The row description
getRowExtentAt()
Return the number of rows
occupied by the accessible cell at the specified row and column in the table. The result differs from 1 if the specified cell spans multiple rows
.
long getRowExtentAt( in long row, in long column );
Parameters
row
- Row index of the cell.
column
- Column index of the cell.
Return value
The number of rows the cell spans.
getRowIndexAt()
Return the index of the row containg the given cell index.
long getRowIndexAt( in long cellIndex );
Parameters
cellIndex
- The cell index.
Return value
The row index.
getSelectedCellIndices()
Renamed from getSelectedCells
in Gecko 1.9.2
Return an array of cell indices currently selected.
void getSelectedCellIndices( out unsigned long cellsArraySize, [retval, array, size_is(cellsArraySize)] out long cellsArray );
Parameters
cellsArraySize
- Length of array.
cellsArray
- Array of indexes of selected cells.
getSelectedColumnIndices()
Return an array of column indices currently selected.
void getSelectedColumnIndices( out unsigned long columnsArraySize, [retval, array, size_is(columnsArraySize)] out long columnsArray );
Parameters
columnsArraySize
- Length of array.
columnsArray
- Array of indices of selected
columns
.
getSelectedRowIndices()
Return an array of row indices currently selected.
void getSelectedRowIndices( out unsigned long rowsArraySize, [retval, array, size_is(rowsArraySize)] out long rowsArray );
Parameters
rowsArraySize
- Length of array.
rowsArray
- Array of indices of selected
rows
.
isCellSelected()
Return a boolean value indicating whether the specified cell is selected.
boolean isCellSelected( in long rowIndex, in long columnIndex );
Parameters
rowIndex
- The row index of the cell.
columnIndex
- The column index of the cell.
Return value
true
if the cell is selected, false
if the cell is not selected.
isColumnSelected()
Return a boolean value indicating whether the specified column is selected, that is all cells within the column are selected.
boolean isColumnSelected( in long columnIndex );
Parameters
columnIndex
- The column index.
Return value
true
if the column is selected, false
if the column is not selected.
isProbablyForLayout()
Use heuristics to determine if table is most likely used for layout.
boolean isProbablyForLayout();
Parameters
None.
Return value
true
if the table is probably for layout, false
if the table is probably not for layout.
isRowSelected()
Return a boolean value indicating whether the specified row is selected, that is all cells within the row are selected.
boolean isRowSelected( in long rowIndex );
Parameters
rowIndex
- The row index.
Return value
true
if the row is selected, false
if the row is not selected.
selectColumn()
Select a column and unselects all previously selected columns
.
void selectColumn( in long columnIndex );
Parameters
columnIndex
- The index of the column to select.
selectRow()
Select a row and unselects all previously selected rows
.
void selectRow( in long rowIndex );
Parameters
rowIndex
- The index of the row to select.
unselectColumn()
Unselect the given column, leaving other selected columns
selected (if any).
void unselectColumn( in long columnIndex );
Parameters
columnIndex
- The index of the column to unselect.
unselectRow()
Unselect the given row, leaving other selected rows
selected (if any).
void unselectRow( in long rowIndex );
Parameters
rowIndex
- The index of the row to unselect.