From Apache OpenOffice Wiki
Jump to: navigation, search

The com.sun.star.accessibility.XAccessibleTable interface represents two-dimensional tables of data. The Calc application is one example of its implementation. It grants access to individual cells or groups of cells.

Global information about a table can be accessed with two functions: getAccessibleCaption() returns the caption and getAccessibleSummary() returns a summary describing the content of a table.

A table is organized in horizontal rows and vertical columns. The number of rows and columns - and indirectly the number of cells - can be determined by calling the functions getAccessibleRowCount() and getAccessibleColumnCount(). Here, in contrast to the general rule of only giving access to visible objects, all cells are represented by a table. This exception is necessary to stay consistent with Java tables.

Information on rows and columns is returned by the getAccessibleRowDescription() and getAccessibleColumnDescription() functions. Note that both functions return objects implementing the com.sun.star.accessibility.XAccessibleTable interface themselves. The headers of rows and columns can be retrieved by calling getAccessibleRowHeaders() and getAccessibleColumnHeaders().

To obtain a reference to a certain cell specified by its row and column indices, use getAccessibleCellAt(). A table cell may span multiple rows and columns. You can determine the number of rows and columns that a cell spans with the getAccessibleRowExtentAt() and getAccessibleColumnExtentAt() functions.

Selections in tables can have two different forms. You can have a multi-selection of rectangular areas of single or multiple cells, or you can select whole rows and columns. The function isAccessibleSelected() determines whether a single cell that spans a position specified by a row and a column index is selected. To determine whether certain rows or columns are selected, use the isAccessibleRowSelected() and isAccessibleColumnSelected() functions. Finally, the functions getSelectedAccessibleRows() and getSelectedAccessibleColumns() each return a sequence of indices of the currently selected row and columns.

There are three functions that can be used to switch between cell indices and row and column indices. Cell indices are the same as the child indices used by the getAccessibleChildCount() and getAccessibleChild() functions of the com.sun.star.accessibility.XAccessibleContext interface. Row and column indices have been used previously, and specify each cell by stating its row and column. The getAccessibleIndex() function returns the corresponding cell index for a given row and column index. The getAccessibleRow() and getAccessibleColumn() functions return the corresponding row and column index, respectively, for a given cell index.

Content on this page is licensed under the Public Documentation License (PDL).
Personal tools
In other languages