protected abstract class

Component.AccessibleAWTComponent

extends AccessibleContext
implements Serializable AccessibleComponent

java.lang.Object
↳	javax.accessibility.AccessibleContext
	↳	java.awt.Component.AccessibleAWTComponent

Known Direct Subclasses

Box.Filler.AccessibleBoxFiller, Button.AccessibleAWTButton, Canvas.AccessibleAWTCanvas, Checkbox.AccessibleAWTCheckbox, Choice.AccessibleAWTChoice, Container.AccessibleAWTContainer, Label.AccessibleAWTLabel, List.AccessibleAWTList, List.AccessibleAWTList.AccessibleAWTListChild, Scrollbar.AccessibleAWTScrollBar, TextComponent.AccessibleAWTTextComponent

Known Indirect Subclasses

AbstractButton.AccessibleAbstractButton, Applet.AccessibleApplet, Box.AccessibleBox, CellRendererPane.AccessibleCellRendererPane, Dialog.AccessibleAWTDialog, Frame.AccessibleAWTFrame, JApplet.AccessibleJApplet, JButton.AccessibleJButton, JCheckBox.AccessibleJCheckBox, JCheckBoxMenuItem.AccessibleJCheckBoxMenuItem, JColorChooser.AccessibleJColorChooser, JComboBox.AccessibleJComboBox, JComponent.AccessibleJComponent, JDesktopPane.AccessibleJDesktopPane, JDialog.AccessibleJDialog, and 46 others.

Class Overview

Inner class of Component 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.

The class used to obtain the accessible role for this object.

Summary

Nested Classes
class	Component.AccessibleAWTComponent.AccessibleAWTComponentHandler	Fire PropertyChange listener, if one is registered, when shown/hidden..
class	Component.AccessibleAWTComponent.AccessibleAWTFocusHandler	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 ComponentListener	accessibleAWTComponentHandler
protected FocusListener	accessibleAWTFocusHandler

[Expand]

Inherited Fields

From class javax.accessibility.AccessibleContext

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

Public Methods
void	addFocusListener(FocusListener l) Adds the specified focus listener to receive focus events from this component.
void	addPropertyChangeListener(PropertyChangeListener listener) Adds a `PropertyChangeListener` to the listener list.
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.
Accessible	getAccessibleAt(Point p) Returns the `Accessible` child, if one exists, contained at the local coordinate `Point`.
Accessible	getAccessibleChild(int i) Returns the nth `Accessible` child of the object.
int	getAccessibleChildrenCount() Returns the number of accessible children in the object.
AccessibleComponent	getAccessibleComponent() Gets the `AccessibleComponent` associated with this object if one exists.
String	getAccessibleDescription() Gets the accessible description of this object.
int	getAccessibleIndexInParent() Gets the index of this object in its accessible parent.
String	getAccessibleName() Gets the accessible name of this object.
Accessible	getAccessibleParent() Gets the `Accessible` parent of this object.
AccessibleRole	getAccessibleRole() Gets the role of this object.
AccessibleStateSet	getAccessibleStateSet() Gets the state of this object.
Color	getBackground() Gets the background color of this object.
Rectangle	getBounds() Gets the bounds of this object in the form of a Rectangle object.
Cursor	getCursor() Gets the `Cursor` of this object.
Font	getFont() Gets the `Font` of this object.
FontMetrics	getFontMetrics(Font f) Gets the `FontMetrics` of this object.
Color	getForeground() Gets the foreground color of this object.
Locale	getLocale() Returns the locale of this object.
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.
Point	getLocationOnScreen() Returns the location of the object on the screen.
Dimension	getSize() Returns the size of this object in the form of a `Dimension` object.
boolean	isEnabled() Determines if the object is enabled.
boolean	isFocusTraversable() Returns whether this object can accept focus or not.
boolean	isShowing() Determines if the object is showing.
boolean	isVisible() Determines if the object is visible.
void	removeFocusListener(FocusListener l) Removes the specified focus listener so it no longer receives focus events from this component.
void	removePropertyChangeListener(PropertyChangeListener listener) Remove a PropertyChangeListener from the listener list.
void	requestFocus() Requests focus for this object.
void	setBackground(Color c) Sets the background color of this object.
void	setBounds(Rectangle r) Sets the bounds of this object in the form of a `Rectangle` object.
void	setCursor(Cursor cursor) Sets the `Cursor` of this object.
void	setEnabled(boolean b) Sets the enabled state of the object.
void	setFont(Font f) Sets the `Font` of this object.
void	setForeground(Color c) Sets the foreground color of this object.
void	setLocation(Point p) Sets the location of the object relative to the parent.
void	setSize(Dimension d) Resizes this object so that it has width and height.
void	setVisible(boolean b) Sets the visible state of the object.

[Expand]

Inherited Methods

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.

Fields

protected ComponentListener accessibleAWTComponentHandler

protected FocusListener accessibleAWTFocusHandler

Protected Constructors

protected Component.AccessibleAWTComponent ()

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

Public Methods

public void addFocusListener (FocusListener l)

Adds the specified focus listener to receive focus events from this component.

Parameters

l	the focus listener

public void addPropertyChangeListener (PropertyChangeListener listener)

Adds a PropertyChangeListener to the listener list.

Parameters

listener	the property change listener to be added

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

Parameters

p	the `Point` relative to the coordinate system of the object

Returns

true if object contains Point; otherwise false

public Accessible getAccessibleAt (Point p)

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

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 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 AccessibleComponent getAccessibleComponent ()

Gets the AccessibleComponent associated with this object if one exists. Otherwise return null.

Returns

the component

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 - e.g. 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 int getAccessibleIndexInParent ()

Gets the index of this object in its accessible parent.

Returns

the index of this object in its parent; or -1 if this object does not have an accessible parent

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 (e.g. a menu item), the accessible name should be the text of the object (e.g. "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 Accessible getAccessibleParent ()

Gets the Accessible parent of this object. If the parent of this object implements Accessible, this method should simply return getParent.

Returns

the Accessible parent of this object -- can be null if this object does not have an Accessible parent

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 Color getBackground ()

Gets the background color of this object.

Returns

the background color, if supported, of the object; otherwise, null

public Rectangle getBounds ()

Gets the bounds of this object in the form of a Rectangle object. The bounds specify this object's width, height, and location relative to its parent.

Returns

a rectangle indicating this component's bounds; null if this object is not on the screen

public Cursor getCursor ()

Gets the Cursor of this object.

Returns

the Cursor, if supported, of the object; otherwise, null

public Font getFont ()

Gets the Font of this object.

Returns

the Font, if supported, for the object; otherwise, null

public FontMetrics getFontMetrics (Font f)

Gets the FontMetrics of this object.

Parameters

f	the `Font`

Returns

the FontMetrics, if supported, the object; otherwise, null

public Color getForeground ()

Gets the foreground color of this object.

Returns

the foreground color, if supported, of the object; otherwise, null

public Locale getLocale ()

Returns the locale of this object.

Returns

the locale of this object

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

Returns

an instance of Point representing the top-left corner of the object's bounds in the coordinate space of the screen; null if this object or its parent are not on the screen

public Point getLocationOnScreen ()

Returns the location of the object on the screen.

Returns

location of object on screen -- can be null if this object is not on the screen

public Dimension getSize ()

Returns the size of this object in the form of a Dimension object. The height field of the Dimension object contains this objects's height, and the width field of the Dimension object contains this object's width.

Returns

a Dimension object that indicates the size of this component; null if this object is not on the screen

public boolean isEnabled ()

Determines if the object is enabled.

Returns

true if object is enabled; otherwise, false

public boolean isFocusTraversable ()

Returns whether this object can accept focus or not.

Returns

true if object can accept focus; otherwise false

public boolean isShowing ()

Determines if the object is showing. This is determined by checking the visibility of the object and ancestors of the object. Note: this will return true even if the object is obscured by another (for example, it happens to be underneath a menu that was pulled down).

Returns

true if object is showing; otherwise, false

public boolean isVisible ()

Determines if the object is visible. Note: this means that the object intends to be visible; however, it may not in fact be showing on the screen because one of the objects that this object is contained by is not visible. To determine if an object is showing on the screen, use isShowing.

Returns

true if object is visible; otherwise, false

public void removeFocusListener (FocusListener l)

Removes the specified focus listener so it no longer receives focus events from this component.

Parameters

l	the focus listener

public void removePropertyChangeListener (PropertyChangeListener listener)

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

Parameters

listener	The PropertyChangeListener to be removed

public void requestFocus ()

Requests focus for this object.

public void setBackground (Color c)

Sets the background color of this object. (For transparency, see isOpaque.)

Parameters

c	the new `Color` for the background

public void setBounds (Rectangle r)

Sets the bounds of this object in the form of a Rectangle object. The bounds specify this object's width, height, and location relative to its parent.

Parameters

r	a rectangle indicating this component's bounds

public void setCursor (Cursor cursor)

Sets the Cursor of this object.

The method may have no visual effect if the Java platform implementation and/or the native system do not support changing the mouse cursor shape.

Parameters

cursor	the new `Cursor` for the object

public void setEnabled (boolean b)

Sets the enabled state of the object.

Parameters

b	if true, enables this object; otherwise, disables it

public void setFont (Font f)

Sets the Font of this object.

Parameters

f	the new `Font` for the object

public void setForeground (Color c)

Sets the foreground color of this object.

Parameters

c	the new `Color` for the foreground

public void setLocation (Point p)

Sets the location of the object relative to the parent.

Parameters

p	the coordinates of the object

public void setSize (Dimension d)

Resizes this object so that it has width and height.

Parameters

d	- the dimension specifying the new size of the object

public void setVisible (boolean b)

Sets the visible state of the object.

Parameters

b	if true, shows this object; otherwise, hides it

Interfaces

Classes

Enums

Exceptions

Errors

Component.AccessibleAWTComponent

Class Overview

Summary

Fields

protected ComponentListener accessibleAWTComponentHandler

protected FocusListener accessibleAWTFocusHandler

Protected Constructors

protected Component.AccessibleAWTComponent ()

Public Methods

public void addFocusListener (FocusListener l)

Parameters

public void addPropertyChangeListener (PropertyChangeListener listener)

Parameters

public boolean contains (Point p)

Parameters

Returns

public Accessible getAccessibleAt (Point p)

Parameters

Returns

public Accessible getAccessibleChild (int i)

Parameters

Returns

public int getAccessibleChildrenCount ()

Returns

public AccessibleComponent getAccessibleComponent ()

Returns

public String getAccessibleDescription ()

Returns

See Also

public int getAccessibleIndexInParent ()

Returns

See Also

public String getAccessibleName ()

Returns

See Also

public Accessible getAccessibleParent ()

Returns

public AccessibleRole getAccessibleRole ()

Returns

See Also

public AccessibleStateSet getAccessibleStateSet ()

Returns

See Also

public Color getBackground ()

Returns

public Rectangle getBounds ()

Returns

public Cursor getCursor ()

Returns

public Font getFont ()

Returns

public FontMetrics getFontMetrics (Font f)

Parameters

Returns

See Also

public Color getForeground ()

Returns

public Locale getLocale ()

Returns

public Point getLocation ()

Returns

public Point getLocationOnScreen ()

Returns

public Dimension getSize ()

Returns

public boolean isEnabled ()

Returns

public boolean isFocusTraversable ()

Returns

public boolean isShowing ()

Returns

public boolean isVisible ()

Returns

public void removeFocusListener (FocusListener l)

Parameters