nsIAccessibleTable

From MDC

Contents 1 Method overview 2 Attributes 3 Methods 3.1 cellRefAt() 3.1.1 Parameters 3.2 getIndexAt() 3.2.1 Parameters 3.3 getColumnAtIndex() 3.3.1 Parameters 3.4 getRowAtIndex() 3.4.1 Parameters 3.5 getColumnExtentAt() 3.5.1 Parameters 3.6 getRowExtentAt() 3.6.1 Parameters 3.7 getColumnDescription() 3.7.1 Parameters 3.8 getRowDescription() 3.8.1 Parameters 3.9 isColumnSelected() 3.9.1 Parameters 3.10 isRowSelected() 3.10.1 Parameters 3.11 isCellSelected() 3.11.1 Parameters 3.12 getSelectedCells() 3.12.1 Parameters 3.13 getSelectedColumns() 3.13.1 Parameters 3.14 getSelectedRows() 3.14.1 Parameters 3.15 selectRow() 3.15.1 Parameters 3.16 selectColumn() 3.16.1 Parameters 3.17 unselectRow() 3.17.1 Parameters 3.18 unselectColumn() 3.18.1 Parameters 3.19 isProbablyForLayout()

nsIAccessibleTable is defined in accessible/public/nsIAccessibleTable.idl. It is scriptable and unfrozen (hasn't changed since Mozilla 1.8).

Inherits from: nsISupports

[edit] Method overview

nsIAccessible cellRefAt(in long row, in long column);

long getIndexAt(in long row, in long column);

long getColumnAtIndex(in long index);

long getRowAtIndex(in long index);

long getColumnExtentAt(in long row, in long column);

long getRowExtentAt(in long row, in long column);

AString getColumnDescription(in long column);

AString getRowDescription(in long row);

boolean isColumnSelected(in long column);

boolean isRowSelected(in long row);

boolean isCellSelected(in long row, in long column);

void getSelectedCells(out unsigned long cellsSize, [retval, array, size_is(cellsSize)] out long cells);

void getSelectedColumns(out unsigned long columnsSize, [retval, array, size_is(columnsSize)] out long columns);

void getSelectedRows(out unsigned long rowsSize,, [retval, array, size_is(rowsSize)] out long rows);

void selectRow(in long row);

void selectColumn(in long column);

void unselectRow(in long row);

void unselectColumn(in long column);

boolean isProbablyForLayout();

[edit] Attributes

Attribute	Type	Description
caption	nsIAccessible	The table's caption.
summary	AString	The table's summary.
columns	long	The number of columns in the table.
columnHeader	nsIAccessibleTable
rows	long	The number of rows in the table.
rowHeader	nsIAccessibleTable
selectedCellsCount	unsigned long	Returns the total number of selected cells.
selectedColumnsCount	unsigned long	Returns the total number of selected columns.
selectedRowsCount	unsigned long	Returns the total number of selected rows.

[edit] Methods

[edit] cellRefAt()

Returns 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 cellRefAt(
     in long row, 
     in long column
  );

[edit] Parameters

row

The row index for which to retrieve the cell.

column

The column index for which to retrieve the cell.

[edit] getIndexAt()

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

  long getIndexAt(
     in long row, 
     in long column
  );

[edit] Parameters

row

index of the row of the table for which to return the cell index

column

index of the column of the table for which to return the cell index.

[edit] getColumnAtIndex()

Translates the given child index into the corresponding column index.

  long getColumnAtIndex(
     in long index
  );

[edit] Parameters

index

index of the child of the table for which to return the column index.

[edit] getRowAtIndex()

Translates the given child index into the corresponding row index.

  long getRowAtIndex(
     in long index
  );

[edit] Parameters

index

index of the child of the table for which to return the row index.

[edit] getColumnExtentAt()

Returns the number of columns occupied by the accessible object 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
  );

[edit] Parameters

row

Row index of the accessible for which to return the column extent.

column

Column index of the accessible for which to return the column extent.

[edit] getRowExtentAt()

Returns the number of rows occupied by the accessible oject 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
  );

[edit] Parameters

row

Row index of the accessible for which to return the column extent.

column

Column index of the accessible for which to return the column extent.

[edit] getColumnDescription()

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

  AString getColumnDescription(
     in long column
  );

[edit] Parameters

column

The index of the column for which to retrieve the description.

[edit] getRowDescription()

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

  AString getRowDescription(
     in long row
  );

[edit] Parameters

row

The index of the row for which to retrieve the description.

[edit] isColumnSelected()

Returns a boolean value indicating whether the specified column is completely selected.

  boolean isColumnSelected(
     in long column
  );

[edit] Parameters

column

Index of the column for which to determine whether it is selected.

[edit] isRowSelected()

Returns a boolean value indicating whether the specified row is completely selected.

  boolean isRowSelected(
     in long row
  );

[edit] Parameters

row

Index of the row for which to determine whether it is selected.

[edit] isCellSelected()

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

  boolean isCellSelected(
     in long row, 
     in long column
  );

[edit] Parameters

row

Index of the row for the cell to determine whether it is selected.

column

Index of the column for the cell to determine whether it is selected.

[edit] getSelectedCells()

Returns a list of cells indexes currently selected.

  void getSelectedCells(
     out unsigned long cellsSize,
     [retval, array, size_is(cellsSize)] out long cells
  );

[edit] Parameters

cellsSize

Length of array.

cells

Array of indexes of selected cells.

[edit] getSelectedColumns()

Returns a list of column indexes currently selected.

  void getSelectedColumns(
     out unsigned long columnsSize,
     [retval, array, size_is(columnsSize)] out long columns
  );

[edit] Parameters

columnsSize

Length of array.

columns

Array of indexes of selected columns.

[edit] getSelectedRows()

Returns a list of row indexes currently selected.

  void getSelectedRows(
     out unsigned long rowsSize,
     [retval, array, size_is(rowsSize)] out long rows
  );

[edit] Parameters

rowsSize

Length of array.

rows

Array of indexes of selected rows

[edit] selectRow()

Selects a row and unselects all previously selected rows.

  void selectRow(
     in long row
  );

[edit] Parameters

row

Index of the row to be selected.

[edit] selectColumn()

Selects a column and unselects all previously selected columns.

  void selectColumn(
     in long column
  );

[edit] Parameters

column

Index of the column to be selected.

[edit] unselectRow()

Unselects one row, leaving other selected rows selected (if any).

  void unselectRow(
     in long row
  );

[edit] Parameters

row

Index of the row to be selected.

[edit] unselectColumn()

Unselects one column, leaving other selected columns selected (if any).

  void unselectColumn(
     in long column
  );

[edit] Parameters

column

Index of the column to be selected.

[edit] isProbablyForLayout()

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

  boolean isProbablyForLayout();