public abstract class

JComponent.AccessibleJComponent

extends Container.AccessibleAWTContainer
implements AccessibleExtendedComponent

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

Known Direct Subclasses

AbstractButton.AccessibleAbstractButton, JColorChooser.AccessibleJColorChooser, JComboBox.AccessibleJComboBox, JDesktopPane.AccessibleJDesktopPane, JFileChooser.AccessibleJFileChooser, JInternalFrame.AccessibleJInternalFrame, JInternalFrame.JDesktopIcon.AccessibleJDesktopIcon, JLabel.AccessibleJLabel, JLayeredPane.AccessibleJLayeredPane, JList.AccessibleJList, JMenuBar.AccessibleJMenuBar, JOptionPane.AccessibleJOptionPane, JPanel.AccessibleJPanel, JPopupMenu.AccessibleJPopupMenu, JProgressBar.AccessibleJProgressBar, and 17 others.

Known Indirect Subclasses

JButton.AccessibleJButton, JCheckBox.AccessibleJCheckBox, JCheckBoxMenuItem.AccessibleJCheckBoxMenuItem, JEditorPane.AccessibleJEditorPane, JEditorPane.AccessibleJEditorPaneHTML, JEditorPane.JEditorPaneAccessibleHypertextSupport, JMenu.AccessibleJMenu, JMenuItem.AccessibleJMenuItem, JPasswordField.AccessibleJPasswordField, JRadioButton.AccessibleJRadioButton, JRadioButtonMenuItem.AccessibleJRadioButtonMenuItem, JTextArea.AccessibleJTextArea, JTextField.AccessibleJTextField, JToggleButton.AccessibleJToggleButton

Class Overview

Inner class of JComponent used to provide default support for accessibility. This class is not meant to be used directly by application developers, but is instead meant only to be subclassed by component developers.

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 JavaBeans^TM has been added to the java.beans package. Please see XMLEncoder.

Summary

Nested Classes
class	JComponent.AccessibleJComponent.AccessibleContainerHandler	Fire PropertyChange listener, if one is registered, when children added/removed.
class	JComponent.AccessibleJComponent.AccessibleFocusHandler	Fire PropertyChange listener, if one is registered, when focus events happen

[Expand]

Inherited Constants

From class javax.accessibility.AccessibleContext

String	ACCESSIBLE_ACTION_PROPERTY	Constant used to indicate that the supported set of actions has changed.
String	ACCESSIBLE_ACTIVE_DESCENDANT_PROPERTY	Constant used to determine when the active descendant of a component has changed.
String	ACCESSIBLE_CARET_PROPERTY	Constant used to determine when the accessibleText caret has changed.
String	ACCESSIBLE_CHILD_PROPERTY	Constant used to determine when Accessible children are added/removed from the object.
String	ACCESSIBLE_COMPONENT_BOUNDS_CHANGED	PropertyChangeEvent which indicates that a change has occurred in a component's bounds.
String	ACCESSIBLE_DESCRIPTION_PROPERTY	Constant used to determine when the accessibleDescription property has changed.
String	ACCESSIBLE_HYPERTEXT_OFFSET	Constant used to indicate that a hypertext element has received focus.
String	ACCESSIBLE_INVALIDATE_CHILDREN	PropertyChangeEvent which indicates that a significant change has occurred to the children of a component like a tree or text.
String	ACCESSIBLE_NAME_PROPERTY	Constant used to determine when the accessibleName property has changed.
String	ACCESSIBLE_SELECTION_PROPERTY	Constant used to determine when the accessibleSelection has changed.
String	ACCESSIBLE_STATE_PROPERTY	Constant used to determine when the accessibleStateSet property has changed.
String	ACCESSIBLE_TABLE_CAPTION_CHANGED	Constant used to indicate that the table caption has changed The old value in the PropertyChangeEvent will be an Accessible representing the previous table caption and the new value will be an Accessible representing the new table caption.
String	ACCESSIBLE_TABLE_COLUMN_DESCRIPTION_CHANGED	Constant used to indicate that the column description has changed The old value in the PropertyChangeEvent will be null and the new value will be an Integer representing the column index.
String	ACCESSIBLE_TABLE_COLUMN_HEADER_CHANGED	Constant used to indicate that the column header has changed The old value in the PropertyChangeEvent will be null and the new value will be an AccessibleTableModelChange representing the header change.
String	ACCESSIBLE_TABLE_MODEL_CHANGED	Constant used to indicate that table data has changed.
String	ACCESSIBLE_TABLE_ROW_DESCRIPTION_CHANGED	Constant used to indicate that the row description has changed The old value in the PropertyChangeEvent will be null and the new value will be an Integer representing the row index.
String	ACCESSIBLE_TABLE_ROW_HEADER_CHANGED	Constant used to indicate that the row header has changed The old value in the PropertyChangeEvent will be null and the new value will be an AccessibleTableModelChange representing the header change.
String	ACCESSIBLE_TABLE_SUMMARY_CHANGED	Constant used to indicate that the table summary has changed The old value in the PropertyChangeEvent will be an Accessible representing the previous table summary and the new value will be an Accessible representing the new table summary.
String	ACCESSIBLE_TEXT_ATTRIBUTES_CHANGED	PropertyChangeEvent which indicates that text attributes have changed.
String	ACCESSIBLE_TEXT_PROPERTY	PropertyChangeEvent which indicates that text has changed.
String	ACCESSIBLE_VALUE_PROPERTY	Constant used to determine when the accessibleValue property has changed.
String	ACCESSIBLE_VISIBLE_DATA_PROPERTY	Constant used to determine when the visual appearance of the object has changed.

Fields
protected ContainerListener	accessibleContainerHandler
protected FocusListener	accessibleFocusHandler

[Expand]

Inherited Fields

From class java.awt.Container.AccessibleAWTContainer

From class java.awt.Component.AccessibleAWTComponent

From class javax.accessibility.AccessibleContext

Protected Constructors
	JComponent.AccessibleJComponent() Though the class is abstract, this should be called by all sub-classes.

Public Methods
void	addPropertyChangeListener(PropertyChangeListener listener) Adds a PropertyChangeListener to the listener list.
Accessible	getAccessibleChild(int i) Returns the nth Accessible child of the object.
int	getAccessibleChildrenCount() Returns the number of accessible children in the object.
String	getAccessibleDescription() Gets the accessible description of this object.
AccessibleKeyBinding	getAccessibleKeyBinding() Returns key bindings associated with this object
String	getAccessibleName() Gets the accessible name of this object.
AccessibleRole	getAccessibleRole() Gets the role of this object.
AccessibleStateSet	getAccessibleStateSet() Gets the state of this object.
String	getTitledBorderText() Returns the titled border text
String	getToolTipText() Returns the tool tip text
void	removePropertyChangeListener(PropertyChangeListener listener) Removes a PropertyChangeListener from the listener list.

Protected Methods
String	getBorderTitle(Border b) Recursively search through the border hierarchy (if it exists) for a TitledBorder with a non-null title.

[Expand]

Inherited Methods

From class java.awt.Container.AccessibleAWTContainer

From class java.awt.Component.AccessibleAWTComponent

From class javax.accessibility.AccessibleContext

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

From interface javax.accessibility.AccessibleComponent

abstract void	addFocusListener(FocusListener l) Adds the specified focus listener to receive focus events from this component.
abstract boolean	contains(Point p) Checks whether the specified point is within this object's bounds, where the point's x and y coordinates are defined to be relative to the coordinate system of the object.
abstract Accessible	getAccessibleAt(Point p) Returns the Accessible child, if one exists, contained at the local coordinate Point.
abstract Color	getBackground() Gets the background color of this object.
abstract Rectangle	getBounds() Gets the bounds of this object in the form of a Rectangle object.
abstract Cursor	getCursor() Gets the Cursor of this object.
abstract Font	getFont() Gets the Font of this object.
abstract FontMetrics	getFontMetrics(Font f) Gets the FontMetrics of this object.
abstract Color	getForeground() Gets the foreground color of this object.
abstract Point	getLocation() Gets the location of the object relative to the parent in the form of a point specifying the object's top-left corner in the screen's coordinate space.
abstract Point	getLocationOnScreen() Returns the location of the object on the screen.
abstract Dimension	getSize() Returns the size of this object in the form of a Dimension object.
abstract boolean	isEnabled() Determines if the object is enabled.
abstract boolean	isFocusTraversable() Returns whether this object can accept focus or not.
abstract boolean	isShowing() Determines if the object is showing.
abstract boolean	isVisible() Determines if the object is visible.
abstract void	removeFocusListener(FocusListener l) Removes the specified focus listener so it no longer receives focus events from this component.
abstract void	requestFocus() Requests focus for this object.
abstract void	setBackground(Color c) Sets the background color of this object.
abstract void	setBounds(Rectangle r) Sets the bounds of this object in the form of a Rectangle object.
abstract void	setCursor(Cursor cursor) Sets the Cursor of this object.
abstract void	setEnabled(boolean b) Sets the enabled state of the object.
abstract void	setFont(Font f) Sets the Font of this object.
abstract void	setForeground(Color c) Sets the foreground color of this object.
abstract void	setLocation(Point p) Sets the location of the object relative to the parent.
abstract void	setSize(Dimension d) Resizes this object so that it has width and height.
abstract void	setVisible(boolean b) Sets the visible state of the object.

From interface javax.accessibility.AccessibleExtendedComponent

Fields

protected ContainerListener accessibleContainerHandler

protected FocusListener accessibleFocusHandler

Protected Constructors

protected JComponent.AccessibleJComponent ()

Though the class is abstract, this should be called by all sub-classes.

Public Methods

public void addPropertyChangeListener (PropertyChangeListener listener)

Adds a PropertyChangeListener to the listener list.

Parameters

listener	the PropertyChangeListener to be added

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, than this method should return the number of children of this object.

Returns

the number of accessible children in the object.

public String getAccessibleDescription ()

Gets the accessible description of this object. This should be a concise, localized description of what this object is - what is its meaning to the user. If the object has a tooltip, the tooltip text may be an appropriate string to return, assuming it contains a concise description of the object (instead of just the name of the object - for example a "Save" icon on a toolbar that had "save" as the tooltip text shouldn't return the tooltip text as the description, but something like "Saves the current text document" instead).

Returns

the localized description of the object -- can be null if this object does not have a description

public AccessibleKeyBinding getAccessibleKeyBinding ()

Returns key bindings associated with this object

Returns

the key bindings, if supported, of the object; otherwise, null

public String getAccessibleName ()

Gets the accessible name of this object. This should almost never return java.awt.Component.getName(), as that generally isn't a localized name, and doesn't have meaning for the user. If the object is fundamentally a text object (such as a menu item), the accessible name should be the text of the object (for example, "save"). If the object has a tooltip, the tooltip text may also be an appropriate String to return.

Returns

the localized name of the object -- can be null if this object does not have a name

public AccessibleRole getAccessibleRole ()

Gets the role of this object.

Returns

an instance of AccessibleRole describing the role of the object

public AccessibleStateSet getAccessibleStateSet ()

Gets the state of this object.

Returns

an instance of AccessibleStateSet containing the current state set of the object

public String getTitledBorderText ()

Returns the titled border text

Returns

the titled border text, if supported, of the object; otherwise, null

public String getToolTipText ()

Returns the tool tip text

Returns

the tool tip text, if supported, of the object; otherwise, null

public void removePropertyChangeListener (PropertyChangeListener listener)

Removes a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties.

Parameters

listener	the PropertyChangeListener to be removed

Protected Methods

protected String getBorderTitle (Border b)

Recursively search through the border hierarchy (if it exists) for a TitledBorder with a non-null title. This does a depth first search on first the inside borders then the outside borders. The assumption is that titles make really pretty inside borders but not very pretty outside borders in compound border situations. It's rather arbitrary, but hopefully decent UI programmers will not create multiple titled borders for the same component.

Interfaces

Classes

Enums

Exceptions

JComponent.AccessibleJComponent

Class Overview

Summary

Fields

protected ContainerListener accessibleContainerHandler

protected FocusListener accessibleFocusHandler

Protected Constructors

protected JComponent.AccessibleJComponent ()

Public Methods

public void addPropertyChangeListener (PropertyChangeListener listener)

Parameters

public Accessible getAccessibleChild (int i)

Parameters

Returns

public int getAccessibleChildrenCount ()

Returns

public String getAccessibleDescription ()

Returns

See Also

public AccessibleKeyBinding getAccessibleKeyBinding ()

Returns

See Also

public String getAccessibleName ()

Returns

See Also

public AccessibleRole getAccessibleRole ()

Returns

See Also

public AccessibleStateSet getAccessibleStateSet ()

Returns

See Also

public String getTitledBorderText ()

Returns

public String getToolTipText ()

Returns

public void removePropertyChangeListener (PropertyChangeListener listener)

Parameters

Protected Methods

protected String getBorderTitle (Border b)