java.lang.Object
   ↳ javax.accessibility.AccessibleContext
     ↳ java.awt.Component.AccessibleAWTComponent
       ↳ java.awt.Container.AccessibleAWTContainer
         ↳ javax.swing.JComponent.AccessibleJComponent
           ↳ javax.swing.JTable.AccessibleJTable

Class Overview

This class implements accessibility support for the JTable class. It provides an implementation of the Java Accessibility API appropriate to table user-interface elements.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeansTM has been added to the java.beans package. Please see XMLEncoder.

Summary

Nested Classes
class JTable.AccessibleJTable.AccessibleJTableCell The class provides an implementation of the Java Accessibility API appropriate to table cells. 
class JTable.AccessibleJTable.AccessibleJTableModelChange  
[Expand]
Inherited Constants
From class javax.accessibility.AccessibleContext
[Expand]
Inherited Fields
From class javax.swing.JComponent.AccessibleJComponent
From class java.awt.Container.AccessibleAWTContainer
From class java.awt.Component.AccessibleAWTComponent
From class javax.accessibility.AccessibleContext
Protected Constructors
JTable.AccessibleJTable()
AccessibleJTable constructor
Public Methods
void addAccessibleSelection(int i)
Adds the specified Accessible child of the object to the object's selection.
void clearAccessibleSelection()
Clears the selection in the object, so that no children in the object are selected.
void columnAdded(TableColumnModelEvent e)
Track changes to the table contents (column insertions)
void columnMarginChanged(ChangeEvent e)
Track changes of a column moving due to margin changes.
void columnMoved(TableColumnModelEvent e)
Track changes of a column repositioning.
void columnRemoved(TableColumnModelEvent e)
Track changes to the table contents (column deletions)
void columnSelectionChanged(ListSelectionEvent e)
Track that the selection model of the TableColumnModel changed.
void editingCanceled(ChangeEvent e)
Invoked when editing is canceled.
void editingStopped(ChangeEvent e)
Track changes to a cell's contents.
Accessible getAccessibleAt(Point p)
Returns the Accessible child, if one exists, contained at the local coordinate Point.
Accessible getAccessibleAt(int r, int c)
Returns the Accessible at a specified row and column in the table.
Accessible getAccessibleCaption()
Returns the caption for the table.
Accessible getAccessibleChild(int i)
Returns the nth Accessible child of the object.
int getAccessibleChildrenCount()
Returns the number of accessible children in the object.
int getAccessibleColumn(int index)
Returns the column number of an index in the table.
int getAccessibleColumnAtIndex(int i)
Returns the column at a given index into the table.
int getAccessibleColumnCount()
Returns the number of columns in the table.
Accessible getAccessibleColumnDescription(int c)
Returns the description of the specified column in the table.
int getAccessibleColumnExtentAt(int r, int c)
Returns the number of columns occupied by the Accessible at a given (row, column).
AccessibleTable getAccessibleColumnHeader()
Returns the column headers as an AccessibleTable.
int getAccessibleIndex(int r, int c)
Returns the index at a row and column in the table.
int getAccessibleIndexAt(int r, int c)
Returns the index at a given (row, column) in the table.
AccessibleRole getAccessibleRole()
Gets the role of this object.
int getAccessibleRow(int index)
Returns the row number of an index in the table.
int getAccessibleRowAtIndex(int i)
Returns the row at a given index into the table.
int getAccessibleRowCount()
Returns the number of rows in the table.
Accessible getAccessibleRowDescription(int r)
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 getAccessibleRowHeader()
Returns the row headers as an AccessibleTable.
AccessibleSelection getAccessibleSelection()
Get the AccessibleSelection associated with this object.
Accessible getAccessibleSelection(int i)
Returns an Accessible representing the specified selected child in the object.
int getAccessibleSelectionCount()
Returns the number of Accessible children currently selected.
Accessible getAccessibleSummary()
Returns the summary description of the table.
AccessibleTable getAccessibleTable()
Gets the AccessibleTable associated with this object.
int[] getSelectedAccessibleColumns()
Returns the selected columns in a table.
int[] getSelectedAccessibleRows()
Returns the selected rows in a table.
boolean isAccessibleChildSelected(int i)
Determines if the current child of this object is selected.
boolean isAccessibleColumnSelected(int c)
Returns a boolean value indicating whether the specified column is selected.
boolean isAccessibleRowSelected(int r)
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 given (row, column) is selected.
void propertyChange(PropertyChangeEvent e)
Track changes to selection model, column model, etc.
void removeAccessibleSelection(int i)
Removes the specified child of the object from the object's selection.
void selectAllAccessibleSelection()
Causes every child of the object to be selected, but only if the JTable supports multiple selections, and if individual cell selection is enabled.
void setAccessibleCaption(Accessible a)
Sets the caption for the table.
void setAccessibleColumnDescription(int c, Accessible a)
Sets the description text of the specified column of the table.
void setAccessibleColumnHeader(AccessibleTable a)
Sets the column headers as an AccessibleTable.
void setAccessibleRowDescription(int r, Accessible a)
Sets the description text of the specified row of the table.
void setAccessibleRowHeader(AccessibleTable a)
Sets the row headers as an AccessibleTable.
void setAccessibleSummary(Accessible a)
Sets the summary description of the table.
void tableChanged(TableModelEvent e)
Track changes to the table contents
void tableRowsDeleted(TableModelEvent e)
Track changes to the table contents (row deletions)
void tableRowsInserted(TableModelEvent e)
Track changes to the table contents (row insertions)
void valueChanged(ListSelectionEvent e)
Track changes to table cell selections
[Expand]
Inherited Methods
From class javax.swing.JComponent.AccessibleJComponent
From class java.awt.Container.AccessibleAWTContainer
From class java.awt.Component.AccessibleAWTComponent
From class javax.accessibility.AccessibleContext
From class java.lang.Object
From interface java.beans.PropertyChangeListener
From interface javax.accessibility.AccessibleComponent
From interface javax.accessibility.AccessibleExtendedComponent
From interface javax.accessibility.AccessibleExtendedTable
From interface javax.accessibility.AccessibleSelection
From interface javax.accessibility.AccessibleTable
From interface javax.swing.event.CellEditorListener
From interface javax.swing.event.ListSelectionListener
From interface javax.swing.event.TableColumnModelListener
From interface javax.swing.event.TableModelListener

Protected Constructors

protected JTable.AccessibleJTable ()

AccessibleJTable constructor

Public Methods

public void addAccessibleSelection (int i)

Adds the specified Accessible child of the object to the object's selection. If the object supports multiple selections, the specified child is added to any existing selection, otherwise it replaces any existing selection in the object. If the specified child is already selected, this method has no effect.

This method only works on JTables which have individual cell selection enabled.

Parameters
i the zero-based index of the child

public void clearAccessibleSelection ()

Clears the selection in the object, so that no children in the object are selected.

public void columnAdded (TableColumnModelEvent e)

Track changes to the table contents (column insertions)

public void columnMarginChanged (ChangeEvent e)

Track changes of a column moving due to margin changes.

public void columnMoved (TableColumnModelEvent e)

Track changes of a column repositioning.

public void columnRemoved (TableColumnModelEvent e)

Track changes to the table contents (column deletions)

public void columnSelectionChanged (ListSelectionEvent e)

Track that the selection model of the TableColumnModel changed.

public void editingCanceled (ChangeEvent e)

Invoked when editing is canceled. The editor object is discarded and the cell is rendered once again.

public void editingStopped (ChangeEvent e)

Track changes to a cell's contents. Invoked when editing is finished. The changes are saved, the editor object is discarded, and the cell is rendered once again.

public Accessible getAccessibleAt (Point p)

Returns the Accessible child, if one exists, contained at the local coordinate Point.

Parameters
p the point defining the top-left corner of the Accessible, given in the coordinate space of the object's parent
Returns
  • the Accessible, if it exists, at the specified location; else null

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

public Accessible getAccessibleCaption ()

Returns the caption for the table.

Returns
  • the caption for the table

public Accessible getAccessibleChild (int i)

Returns the nth Accessible child of the object.

Parameters
i zero-based index of child
Returns
  • the nth Accessible child of the object

public int getAccessibleChildrenCount ()

Returns the number of accessible children in the object. If all of the children of this object implement Accessible, then this method should return the number of children of this object.

Returns
  • the number of accessible children in the object

public int getAccessibleColumn (int index)

Returns the column number of an index in the table.

Parameters
index the zero-based index in the table
Returns
  • the zero-based column of the table if one exists; otherwise -1.

public int getAccessibleColumnAtIndex (int i)

Returns the column at a given index into the table.

Parameters
i zero-based index into the table
Returns
  • the column at a given index

public int getAccessibleColumnCount ()

Returns the number of columns in the table.

Returns
  • the number of columns in the table

public Accessible getAccessibleColumnDescription (int c)

Returns the description of the specified column in the table.

Parameters
c zero-based column of the table
Returns
  • the description of the column

public int getAccessibleColumnExtentAt (int r, int c)

Returns the number of columns occupied by the Accessible at a given (row, column).

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

public AccessibleTable getAccessibleColumnHeader ()

Returns the column headers as an AccessibleTable.

Returns
  • an AccessibleTable representing the column headers, or null if the table header is null

public int getAccessibleIndex (int r, int c)

Returns the index at a row and column in the table.

Parameters
r zero-based row of the table
c zero-based column of the table
Returns
  • the zero-based index in the table if one exists; otherwise -1.

public int getAccessibleIndexAt (int r, int c)

Returns the index at a given (row, column) in the table.

Parameters
r zero-based row of the table
c zero-based column of the table
Returns
  • the index into the table

public AccessibleRole getAccessibleRole ()

Gets the role of this object.

Returns
  • an instance of AccessibleRole describing the role of the object
See Also

public int getAccessibleRow (int index)

Returns the row number of an index in the table.

Parameters
index the zero-based index in the table
Returns
  • the zero-based row of the table if one exists; otherwise -1.

public int getAccessibleRowAtIndex (int i)

Returns the row at a given index into the table.

Parameters
i zero-based index into the table
Returns
  • the row at a given index

public int getAccessibleRowCount ()

Returns the number of rows in the table.

Returns
  • the number of rows in the table

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

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.

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

public AccessibleTable getAccessibleRowHeader ()

Returns the row headers as an AccessibleTable.

Returns
  • an AccessibleTable representing the row headers

public AccessibleSelection getAccessibleSelection ()

Get the AccessibleSelection associated with this object. In the implementation of the Java Accessibility API for this class, return this object, which is responsible for implementing the AccessibleSelection interface on behalf of itself.

Returns
  • this object

public Accessible getAccessibleSelection (int i)

Returns an Accessible representing the specified selected child in the object. If there isn't a selection, or there are fewer children selected than the integer passed in, the return value will be null.

Note that the index represents the i-th selected child, which is different from the i-th child.

Parameters
i the zero-based index of selected children
Returns
  • the i-th selected child

public int getAccessibleSelectionCount ()

Returns the number of Accessible children currently selected. If no children are selected, the return value will be 0.

Returns
  • the number of items currently selected

public Accessible getAccessibleSummary ()

Returns the summary description of the table.

Returns
  • the summary description of the table

public AccessibleTable getAccessibleTable ()

Gets the AccessibleTable associated with this object. In the implementation of the Java Accessibility API for this class, return this object, which is responsible for implementing the AccessibleTables interface on behalf of itself.

Returns
  • this object

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

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

public boolean isAccessibleChildSelected (int i)

Determines if the current child of this object is selected.

Parameters
i the zero-based index of the child in this Accessible object
Returns
  • true if the current child of this object is selected

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

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

public boolean isAccessibleSelected (int r, int c)

Returns a boolean value indicating whether the accessible at a given (row, 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 (row, column) is selected; otherwise, the boolean value false

public void propertyChange (PropertyChangeEvent e)

Track changes to selection model, column model, etc. so as to be able to re-place listeners on those in order to pass on information to the Accessibility PropertyChange mechanism

Parameters
e A PropertyChangeEvent object describing the event source and the property that has changed.

public void removeAccessibleSelection (int i)

Removes the specified child of the object from the object's selection. If the specified item isn't currently selected, this method has no effect.

This method only works on JTables which have individual cell selection enabled.

Parameters
i the zero-based index of the child

public void selectAllAccessibleSelection ()

Causes every child of the object to be selected, but only if the JTable supports multiple selections, and if individual cell selection is enabled.

public void setAccessibleCaption (Accessible a)

Sets the caption for the table.

Parameters
a the caption for the table

public void setAccessibleColumnDescription (int c, Accessible a)

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

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

public void setAccessibleColumnHeader (AccessibleTable a)

Sets the column headers as an AccessibleTable.

Parameters
a an AccessibleTable representing the column headers

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

public void setAccessibleRowHeader (AccessibleTable a)

Sets the row headers as an AccessibleTable.

Parameters
a an AccessibleTable representing the row headers

public void setAccessibleSummary (Accessible a)

Sets the summary description of the table.

Parameters
a the summary description of the table

public void tableChanged (TableModelEvent e)

Track changes to the table contents

public void tableRowsDeleted (TableModelEvent e)

Track changes to the table contents (row deletions)

public void tableRowsInserted (TableModelEvent e)

Track changes to the table contents (row insertions)

public void valueChanged (ListSelectionEvent e)

Track changes to table cell selections

Parameters
e the event that characterizes the change.