This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.accessibility
interface AccessibleTable

All Known Subinterfaces:
AccessibleExtendedTable

public interface AccessibleTable

Class AccessibleTable describes a user-interface component that presents data in a two-dimensional table format.


Method Summary
 Accessible
getAccessibleAt(int r, int c)

          Returns the Accessible at a specified row and column in the table.
 Accessible

          Returns the caption for the table.
 int

          Returns the number of columns in the table.
 Accessible

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

          Returns the number of columns occupied by the Accessible at a specified row and column in the table.
 AccessibleTable

          Returns the column headers as an AccessibleTable.
 int

          Returns the number of rows in the table.
 Accessible

          Returns the description of the specified row in the table.
 int
getAccessibleRowExtentAt(int r, int c)

          Returns the number of rows occupied by the Accessible at a specified row and column in the table.
 AccessibleTable

          Returns the row headers as an AccessibleTable.
 Accessible

          Returns the summary description of the table.
 int[]

          Returns the selected columns in a table.
 int[]

          Returns the selected rows in a table.
 boolean

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

          Returns a boolean value indicating whether the specified row is selected.
 boolean
isAccessibleSelected(int r, int c)

          Returns a boolean value indicating whether the accessible at a specified row and column is selected.
 void

          Sets the caption for the table.
 void

          Sets the description text of the specified column in the table.
 void

          Sets the column headers.
 void

          Sets the description text of the specified row of the table.
 void

          Sets the row headers.
 void

          Sets the summary description of the table
 

Method Detail

getAccessibleAt

public Accessible getAccessibleAt(int r,
                                  int c)
Returns the Accessible at a specified row and column in the table.

Parameters:
r - zero-based row of the table
c - zero-based column of the table
Returns:
the Accessible at the specified row and column

getAccessibleCaption

public Accessible getAccessibleCaption()
Returns the caption for the table.

Returns:
the caption for the table

getAccessibleColumnCount

public int getAccessibleColumnCount()
Returns the number of columns in the table.

Returns:
the number of columns in the table

getAccessibleColumnDescription

public Accessible getAccessibleColumnDescription(int c)
Returns the description text of the specified column in the table.

Parameters:
c - zero-based column of the table
Returns:
the text description of the column

getAccessibleColumnExtentAt

public int getAccessibleColumnExtentAt(int r,
                                       int c)
Returns the number of columns occupied by the Accessible at a specified row and column in the table.

Parameters:
r
c
Returns:
the number of columns occupied by the Accessible at a given specified row and column

getAccessibleColumnHeader

public AccessibleTable getAccessibleColumnHeader()
Returns the column headers as an AccessibleTable.

Returns:
an AccessibleTable representing the column headers

getAccessibleRowCount

public int getAccessibleRowCount()
Returns the number of rows in the table.

Returns:
the number of rows in the table

getAccessibleRowDescription

public Accessible getAccessibleRowDescription(int r)
Returns the description of the specified row in the table.

Parameters:
r - zero-based row of the table
Returns:
the description of the row

getAccessibleRowExtentAt

public int getAccessibleRowExtentAt(int r,
                                    int c)
Returns the number of rows occupied by the Accessible at a specified row and column in the table.

Parameters:
r
c
Returns:
the number of rows occupied by the Accessible at a given specified (row, column)

getAccessibleRowHeader

public AccessibleTable getAccessibleRowHeader()
Returns the row headers as an AccessibleTable.

Returns:
an AccessibleTable representing the row headers

getAccessibleSummary

public Accessible getAccessibleSummary()
Returns the summary description of the table.

Returns:
the summary description of the table

getSelectedAccessibleColumns

public int[] getSelectedAccessibleColumns()
Returns the selected columns in a table.

Returns:
an array of selected columns where each element is a zero-based column of the table

getSelectedAccessibleRows

public int[] getSelectedAccessibleRows()
Returns the selected rows in a table.

Returns:
an array of selected rows where each element is a zero-based row of the table

isAccessibleColumnSelected

public boolean isAccessibleColumnSelected(int c)
Returns a boolean value indicating whether the specified column is selected.

Parameters:
c - zero-based column of the table
Returns:
the boolean value true if the specified column is selected. Otherwise, false.

isAccessibleRowSelected

public boolean isAccessibleRowSelected(int r)
Returns a boolean value indicating whether the specified row is selected.

Parameters:
r - zero-based row of the table
Returns:
the boolean value true if the specified row is selected. Otherwise, false.

isAccessibleSelected

public boolean isAccessibleSelected(int r,
                                    int c)
Returns a boolean value indicating whether the accessible at a specified row and column is selected.

Parameters:
r - zero-based row of the table
c - zero-based column of the table
Returns:
the boolean value true if the accessible at the row and column is selected. Otherwise, the boolean value false

setAccessibleCaption

public void setAccessibleCaption(Accessible a)
Sets the caption for the table.

Parameters:
a - the caption for the table

setAccessibleColumnDescription

public void setAccessibleColumnDescription(int c,
                                           Accessible a)
Sets the description text of the specified column in the table.

Parameters:
c - zero-based column of the table
a - the text description of the column

setAccessibleColumnHeader

public void setAccessibleColumnHeader(AccessibleTable table)
Sets the column headers.

Parameters:
table - an AccessibleTable representing the column headers

setAccessibleRowDescription

public void setAccessibleRowDescription(int r,
                                        Accessible a)
Sets the description text of the specified row of the table.

Parameters:
r - zero-based row of the table
a - the description of the row

setAccessibleRowHeader

public void setAccessibleRowHeader(AccessibleTable table)
Sets the row headers.

Parameters:
table - an AccessibleTable representing the row headers

setAccessibleSummary

public void setAccessibleSummary(Accessible a)
Sets the summary description of the table

Parameters:
a - the summary description of the table


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.