javax.accessibility
Interface AccessibleTable
java.lang.Object
|
+--javax.accessibility.AccessibleTable
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:Author:- Eric Blake <ebb9@email.byu.edu>
See Also:
getAccessibleAt
public Accessible getAccessibleAt(int r, int c)
Return the cell at the specified row and column, or null if out of bounds.
Parameters:
Returns:
getAccessibleCaption
public Accessible getAccessibleCaption()
Return the caption for the table, or null if unknown.
Returns:
getAccessibleColumnCount
public int getAccessibleColumnCount()
Return the number of columns in the table.
Returns:
getAccessibleColumnDescription
public Accessible getAccessibleColumnDescription(int c)
Return the description of a column, or null if there is none or the index
is out of bounds.
Parameters:
Returns:
getAccessibleColumnExtentAt
public 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:
Returns:
- the column extent at (r,c)
getAccessibleColumnHeader
public AccessibleTable getAccessibleColumnHeader()
Return the column headers as a table.
Returns:
- the column headers, or null if there are none
getAccessibleRowCount
public int getAccessibleRowCount()
Return the number of rows in the table.
Returns:
getAccessibleRowDescription
public Accessible getAccessibleRowDescription(int r)
Return the description of a row, or null if there is none or the index
is out of bounds.
Parameters:
Returns:
getAccessibleRowExtentAt
public 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:
Returns:
getAccessibleRowHeader
public AccessibleTable getAccessibleRowHeader()
Return the row headers as a table.
Returns:
- the row headers, or null if there are none
getAccessibleSummary
public Accessible getAccessibleSummary()
Return the summary description of the table, or null if unknown.
Returns:
getSelectedAccessibleColumns
public int[] getSelectedAccessibleColumns()
Return the selected columns. May be null or empty if there is no
selection.
Returns:
- the indices of selected columns
getSelectedAccessibleRows
public int[] getSelectedAccessibleRows()
Return the selected rows. May be null or empty if there is no selection.
Returns:
- the indices of selected rows
isAccessibleColumnSelected
public boolean isAccessibleColumnSelected(int c)
Return whether the specified column is selected. Returns false if the
index is out of bounds.
Parameters:
Returns:
- true if that column is selected
isAccessibleRowSelected
public boolean isAccessibleRowSelected(int r)
Return whether the specified row is selected. Returns false if the
index is out of bounds.
Parameters:
Returns:
- true if that row is selected
isAccessibleSelected
public 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:
Returns:
- true if that cell is selected
setAccessibleCaption
public void setAccessibleCaption(javax.accessibility.Accessible caption)
Set the table caption.
Parameters:
setAccessibleColumnDescription
public void setAccessibleColumnDescription(int c, javax.accessibility.Accessible description)
Set the description of a column. Does nothing if the index is invalid.
Parameters:
setAccessibleColumnHeader
public void setAccessibleColumnHeader(javax.accessibility.AccessibleTable header)
Set the column headers.
Parameters:
setAccessibleRowDescription
public void setAccessibleRowDescription(int r, javax.accessibility.Accessible description)
Set the description of a row. Does nothing if the index is invalid.
Parameters:
setAccessibleRowHeader
public void setAccessibleRowHeader(javax.accessibility.AccessibleTable header)
Set the row headers.
Parameters:
setAccessibleSummary
public void setAccessibleSummary(javax.accessibility.Accessible summary)
Set the table summary description.
Parameters:
The
AccessibleContext.getAccessibleTable()
method should returnnull
if an object does not implement this interface.