nsIAccessibleTable Interface Reference

import "nsIAccessibleTable.idl";

Collaboration diagram for nsIAccessibleTable:

List of all members.

Public Member Functions
nsIAccessible	getCellAt (in long rowIndex, in long columnIndex)
	Return the accessible object at the specified row and column in the table.
long	getCellIndexAt (in long rowIndex, in long columnIndex)
	Translate the given row and column indices into the corresponding cell index.
long	getColumnIndexAt (in long cellIndex)
	Translate the given cell index into the corresponding column index.
long	getRowIndexAt (in long cellIndex)
	Translate the given cell index into the corresponding row index.
long	getColumnExtentAt (in long row, in long column)
	Return the number of columns occupied by the accessible cell at the specified row and column in the table.
long	getRowExtentAt (in long row, in long column)
	Return the number of rows occupied by the accessible cell at the specified row and column in the table.
AString	getColumnDescription (in long columnIndex)
	Return the description text of the specified column in the table.
AString	getRowDescription (in long rowIndex)
	Return the description text of the specified row in the table.
boolean	isColumnSelected (in long columnIndex)
	Return a boolean value indicating whether the specified column is selected, i.e.
boolean	isRowSelected (in long rowIndex)
	Return a boolean value indicating whether the specified row is selected, i.e.
boolean	isCellSelected (in long rowIndex, in long columnIndex)
	Return a boolean value indicating whether the specified cell is selected.
void	getSelectedCellIndices (out unsigned long cellsArraySize,[retval, array, size_is(cellsArraySize)] out long cellsArray)
	Return an array of cell indices currently selected.
void	getSelectedColumnIndices (out unsigned long columnsArraySize,[retval, array, size_is(columnsArraySize)] out long columnsArray)
	Return an array of column indices currently selected.
void	getSelectedRowIndices (out unsigned long rowsArraySize,[retval, array, size_is(rowsArraySize)] out long rowsArray)
	Return an array of row indices currently selected.
void	selectRow (in long rowIndex)
	Select a row and unselects all previously selected rows.
void	selectColumn (in long columnIndex)
	Select a column and unselects all previously selected columns.
void	unselectRow (in long rowIndex)
	Unselect the given row, leaving other selected rows selected (if any).
void	unselectColumn (in long columnIndex)
	Unselect the given column, leaving other selected columns selected (if any).
boolean	isProbablyForLayout ()
	Use heuristics to determine if table is most likely used for layout.
Public Attributes
readonly attribute nsIAccessible	caption
	Return the caption accessible for the table.
readonly attribute AString	summary
	Return summary description for the table.
readonly attribute long	columnCount
	Return columns count in the table.
readonly attribute long	rowCount
	Return rows count in the table.
readonly attribute unsigned long	selectedCellCount
	Return the total number of selected cells.
readonly attribute unsigned long	selectedColumnCount
	Return the total number of selected columns.
readonly attribute unsigned long	selectedRowCount
	Return the total number of selected rows.
readonly attribute nsIArray	selectedCells
	Return an array of selected cells.

---

Member Function Documentation

nsIAccessible nsIAccessibleTable::getCellAt	(	in long	rowIndex,
		in long	columnIndex
	)

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).

Parameters:

	rowIndex	[in] the row index to retrieve the cell at
	columnIndex	[in] the column index to retrieve the cell at

long nsIAccessibleTable::getCellIndexAt	(	in long	rowIndex,
		in long	columnIndex
	)

Translate the given row and column indices into the corresponding cell index.

Parameters:

	rowIndex	[in] the row index to return cell index at
	columnIndex	[in] the column index to return cell index at

AString nsIAccessibleTable::getColumnDescription

(

in long

columnIndex

)

Return the description text of the specified column in the table.

Parameters:

columnIndex

[in] the column index to retrieve description for

long nsIAccessibleTable::getColumnExtentAt	(	in long	row,
		in long	column
	)

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.

Parameters:

	row	[in] row index of the cell to return the column extent for
	column	[in] column index of the cell to return the column extent for

long nsIAccessibleTable::getColumnIndexAt

(

in long

cellIndex

)

Translate the given cell index into the corresponding column index.

Parameters:

cellIndex

[in] index of the table cell to return column index for

AString nsIAccessibleTable::getRowDescription

(

in long

rowIndex

)

Return the description text of the specified row in the table.

Parameters:

rowIndex

[in] the row index to retrieve description for

long nsIAccessibleTable::getRowExtentAt	(	in long	row,
		in long	column
	)

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.

Parameters:

	row	[in] row index of the cell to return the column extent for
	column	[in] column index of the cell to return the column extent for

long nsIAccessibleTable::getRowIndexAt

(

in long

cellIndex

)

Translate the given cell index into the corresponding row index.

Parameters:

cellIndex

[in] index of the table cell to return row index for

void nsIAccessibleTable::getSelectedCellIndices	(	out unsigned long	cellsArraySize,
		[retval, array, size_is(cellsArraySize)] out long	cellsArray
	)

Return an array of cell indices currently selected.

Parameters:

	cellsArraySize	[in] length of array
	cellsArray	[in] array of indexes of selected cells

void nsIAccessibleTable::getSelectedColumnIndices	(	out unsigned long	columnsArraySize,
		[retval, array, size_is(columnsArraySize)] out long	columnsArray
	)

Return an array of column indices currently selected.

Parameters:

	columnsArraySize	[in] length of array
	columnsArray	[in] array of indices of selected columns

void nsIAccessibleTable::getSelectedRowIndices	(	out unsigned long	rowsArraySize,
		[retval, array, size_is(rowsArraySize)] out long	rowsArray
	)

Return an array of row indices currently selected.

Parameters:

	rowsArraySize	[in] Length of array
	rowsArray	[in] array of indices of selected rows

boolean nsIAccessibleTable::isCellSelected	(	in long	rowIndex,
		in long	columnIndex
	)

Return a boolean value indicating whether the specified cell is selected.

Parameters:

	rowIndex	[in] the row index of the cell
	columnIndex	[in] the column index of the cell

boolean nsIAccessibleTable::isColumnSelected

(

in long

columnIndex

)

Return a boolean value indicating whether the specified column is selected, i.e.

all cells within the column are selected.

Parameters:

columnIndex

[in] the column index to determine if it's selected

boolean nsIAccessibleTable::isProbablyForLayout

(

)

Use heuristics to determine if table is most likely used for layout.

boolean nsIAccessibleTable::isRowSelected

(

in long

rowIndex

)

Return a boolean value indicating whether the specified row is selected, i.e.

all cells within the row are selected.

Parameters:

rowIndex

[in] the row index to determine whether it's selected

void nsIAccessibleTable::selectColumn

(

in long

columnIndex

)

Select a column and unselects all previously selected columns.

Parameters:

columnIndex

[in] the column index to select

void nsIAccessibleTable::selectRow

(

in long

rowIndex

)

Select a row and unselects all previously selected rows.

Parameters:

rowIndex

[in] the row index to select

void nsIAccessibleTable::unselectColumn

(

in long

columnIndex

)

Unselect the given column, leaving other selected columns selected (if any).

Parameters:

columnIndex

[in] the column index to select

void nsIAccessibleTable::unselectRow

(

in long

rowIndex

)

Unselect the given row, leaving other selected rows selected (if any).

Parameters:

rowIndex

[in] the row index to select

---

Member Data Documentation

readonly attribute nsIAccessible nsIAccessibleTable::caption

Return the caption accessible for the table.

For example, html:caption element of html:table element.

readonly attribute long nsIAccessibleTable::columnCount

Return columns count in the table.

readonly attribute long nsIAccessibleTable::rowCount

Return rows count in the table.

readonly attribute unsigned long nsIAccessibleTable::selectedCellCount

Return the total number of selected cells.

readonly attribute nsIArray nsIAccessibleTable::selectedCells

Return an array of selected cells.

readonly attribute unsigned long nsIAccessibleTable::selectedColumnCount

Return the total number of selected columns.

readonly attribute unsigned long nsIAccessibleTable::selectedRowCount

Return the total number of selected rows.

readonly attribute AString nsIAccessibleTable::summary

Return summary description for the table.

For example, attribute on html:table element.

---

The documentation for this interface was generated from the following file:

• nsIAccessibleTable.idl