javax.accessibility

Interface AccessibleTable

Known Subinterfaces:: AccessibleExtendedTable

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.

getAccessibleAt

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

getAccessibleCaption

public Accessible getAccessibleCaption()

Return the caption for the table, or null if unknown.
Returns:
the table caption

getAccessibleColumnCount

public int getAccessibleColumnCount()

Return the number of columns in the table.
Returns:
the column count

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:
c - the 0-based column index
Returns:
the description

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:
r - the 0-based row index
c - the 0-based column index
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:
the row count

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:
r - the 0-based row index
Returns:
the description

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:
r - the 0-based row index
c - the 0-based column index
Returns:
the row extent at (r,c)

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:
the summary description

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:
c - the 0-based column index
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:
r - the 0-based row index
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:
r - the 0-based row index
c - the 0-based column index
Returns:
true if that cell is selected

setAccessibleCaption

public void setAccessibleCaption(Accessible caption)

Set the table caption.
Parameters:
caption - the new caption

setAccessibleColumnDescription

public 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

setAccessibleColumnHeader

public void setAccessibleColumnHeader(AccessibleTable header)

Set the column headers.
Parameters:
header - the new column header

setAccessibleRowDescription

public 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

setAccessibleRowHeader

public void setAccessibleRowHeader(AccessibleTable header)

Set the row headers.
Parameters:
header - the new row header

setAccessibleSummary

public void setAccessibleSummary(Accessible summary)

Set the table summary description.
Parameters:
summary - the new summary

AccessibleTable.java -- aids in accessibly manipulating tables Copyright (C) 2002, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About	GNU Classpath (0.95)
Prev Class \| Next Class	GNU Classpath (0.95)	Frames \| No Frames
Summary: Nested \| Field \| Method \| Constr	Detail: Nested \| Field \| Method \| Constr