javax.accessibility
Interface AccessibleTable

All Known Subinterfaces:
AccessibleExtendedTable
All Known Implementing Classes:
JTable.AccessibleJTable

public interface AccessibleTable

Objects which present information in a 2-dimensional table should implement this interface. Accessibility software can use the implementations of this interface to navigate and change the attributes of the table.

The AccessibleContext.getAccessibleTable() method should return null if an object does not implement this interface.

Since:
1.2
See Also:
Accessible, AccessibleContext, AccessibleContext.getAccessibleTable()

Method Summary
 Accessible getAccessibleAt(int r, int c)
          Return the cell at the specified row and column, or null if out of bounds.
 Accessible getAccessibleCaption()
          Return the caption for the table, or null if unknown.
 int getAccessibleColumnCount()
          Return the number of columns in the table.
 Accessible getAccessibleColumnDescription(int c)
          Return the description of a column, or null if there is none or the index is out of bounds.
 int getAccessibleColumnExtentAt(int r, int c)
          Returns the number of merged columns occupied at the specified row and column, or 0 if out of bounds.
 AccessibleTable getAccessibleColumnHeader()
          Return the column headers as a table.
 int getAccessibleRowCount()
          Return the number of rows in the table.
 Accessible getAccessibleRowDescription(int r)
          Return the description of a row, or null if there is none or the index is out of bounds.
 int getAccessibleRowExtentAt(int r, int c)
          Returns the number of merged rows occupied at the specified row and column, or 0 if out of bounds.
 AccessibleTable getAccessibleRowHeader()
          Return the row headers as a table.
 Accessible getAccessibleSummary()
          Return the summary description of the table, or null if unknown.
 int[] getSelectedAccessibleColumns()
          Return the selected columns.
 int[] getSelectedAccessibleRows()
          Return the selected rows.
 boolean isAccessibleColumnSelected(int c)
          Return whether the specified column is selected.
 boolean isAccessibleRowSelected(int r)
          Return whether the specified row is selected.
 boolean isAccessibleSelected(int r, int c)
          Return whether the cell at the specified location is selected.
 void setAccessibleCaption(Accessible caption)
          Set the table caption.
 void setAccessibleColumnDescription(int c, Accessible description)
          Set the description of a column.
 void setAccessibleColumnHeader(AccessibleTable header)
          Set the column headers.
 void setAccessibleRowDescription(int r, Accessible description)
          Set the description of a row.
 void setAccessibleRowHeader(AccessibleTable header)
          Set the row headers.
 void setAccessibleSummary(Accessible summary)
          Set the table summary description.
 

Method Detail

getAccessibleCaption

Accessible getAccessibleCaption()
Return the caption for the table, or null if unknown.

Returns:
the table caption

setAccessibleCaption

void setAccessibleCaption(Accessible caption)
Set the table caption.

Parameters:
caption - the new caption

getAccessibleSummary

Accessible getAccessibleSummary()
Return the summary description of the table, or null if unknown.

Returns:
the summary description

setAccessibleSummary

void setAccessibleSummary(Accessible summary)
Set the table summary description.

Parameters:
summary - the new summary

getAccessibleRowCount

int getAccessibleRowCount()
Return the number of rows in the table.

Returns:
the row count

getAccessibleColumnCount

int getAccessibleColumnCount()
Return the number of columns in the table.

Returns:
the column count

getAccessibleAt

Accessible getAccessibleAt(int r,
                           int c)
Return the cell at the specified row and column, or null if out of bounds.

Parameters:
r - the 0-based row index
c - the 0-based column index
Returns:
the cell at (r,c)

getAccessibleRowExtentAt

int getAccessibleRowExtentAt(int r,
                             int c)
Returns the number of merged rows occupied at the specified row and column, or 0 if out of bounds.

Parameters:
r - the 0-based row index
c - the 0-based column index
Returns:
the row extent at (r,c)

getAccessibleColumnExtentAt

int getAccessibleColumnExtentAt(int r,
                                int c)
Returns the number of merged columns occupied at the specified row and column, or 0 if out of bounds.

Parameters:
r - the 0-based row index
c - the 0-based column index
Returns:
the column extent at (r,c)

getAccessibleRowHeader

AccessibleTable getAccessibleRowHeader()
Return the row headers as a table.

Returns:
the row headers, or null if there are none

setAccessibleRowHeader

void setAccessibleRowHeader(AccessibleTable header)
Set the row headers.

Parameters:
header - the new row header

getAccessibleColumnHeader

AccessibleTable getAccessibleColumnHeader()
Return the column headers as a table.

Returns:
the column headers, or null if there are none

setAccessibleColumnHeader

void setAccessibleColumnHeader(AccessibleTable header)
Set the column headers.

Parameters:
header - the new column header

getAccessibleRowDescription

Accessible getAccessibleRowDescription(int r)
Return the description of a row, or null if there is none or the index is out of bounds.

Parameters:
r - the 0-based row index
Returns:
the description

setAccessibleRowDescription

void setAccessibleRowDescription(int r,
                                 Accessible description)
Set the description of a row. Does nothing if the index is invalid.

Parameters:
r - the 0-based row index
description - the new description

getAccessibleColumnDescription

Accessible getAccessibleColumnDescription(int c)
Return the description of a column, or null if there is none or the index is out of bounds.

Parameters:
c - the 0-based column index
Returns:
the description

setAccessibleColumnDescription

void setAccessibleColumnDescription(int c,
                                    Accessible description)
Set the description of a column. Does nothing if the index is invalid.

Parameters:
c - the 0-based column index
description - the new description

isAccessibleSelected

boolean isAccessibleSelected(int r,
                             int c)
Return whether the cell at the specified location is selected. Returns false if the index is out of bounds.

Parameters:
r - the 0-based row index
c - the 0-based column index
Returns:
true if that cell is selected

isAccessibleRowSelected

boolean isAccessibleRowSelected(int r)
Return whether the specified row is selected. Returns false if the index is out of bounds.

Parameters:
r - the 0-based row index
Returns:
true if that row is selected

isAccessibleColumnSelected

boolean isAccessibleColumnSelected(int c)
Return whether the specified column is selected. Returns false if the index is out of bounds.

Parameters:
c - the 0-based column index
Returns:
true if that column is selected

getSelectedAccessibleRows

int[] getSelectedAccessibleRows()
Return the selected rows. May be null or empty if there is no selection.

Returns:
the indices of selected rows

getSelectedAccessibleColumns

int[] getSelectedAccessibleColumns()
Return the selected columns. May be null or empty if there is no selection.

Returns:
the indices of selected columns