java.awt
Class Component.AccessibleAWTComponent

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

All Implemented Interfaces:

Serializable, javax.accessibility.AccessibleComponent

Direct Known Subclasses:

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

Enclosing class:

Component

protected abstract class Component.AccessibleAWTComponent
extends javax.accessibility.AccessibleContext
implements Serializable, javax.accessibility.AccessibleComponent

This class provides accessibility support for subclasses of container.

Since:

1.3

See Also:

Serialized Form

Status:

updated to 1.4

Nested Class Summary

protected class	Component.AccessibleAWTComponent.AccessibleAWTComponentHandler Converts component changes into property changes.
protected class	Component.AccessibleAWTComponent.AccessibleAWTFocusHandler Converts focus changes into property changes.

Field Summary

protected ComponentListener	accessibleAWTComponentHandler Converts show/hide events to PropertyChange events, and is registered as a component listener on this component.
protected FocusListener	accessibleAWTFocusHandler Converts focus events to PropertyChange events, and is registered as a focus listener on this component.

Fields inherited from class javax.accessibility.AccessibleContext

ACCESSIBLE_ACTION_PROPERTY, ACCESSIBLE_ACTIVE_DESCENDANT_PROPERTY, ACCESSIBLE_CARET_PROPERTY, ACCESSIBLE_CHILD_PROPERTY, ACCESSIBLE_COMPONENT_BOUNDS_CHANGED, ACCESSIBLE_DESCRIPTION_PROPERTY, ACCESSIBLE_HYPERTEXT_OFFSET, ACCESSIBLE_INVALIDATE_CHILDREN, ACCESSIBLE_NAME_PROPERTY, ACCESSIBLE_SELECTION_PROPERTY, ACCESSIBLE_STATE_PROPERTY, ACCESSIBLE_TABLE_CAPTION_CHANGED, ACCESSIBLE_TABLE_COLUMN_DESCRIPTION_CHANGED, ACCESSIBLE_TABLE_COLUMN_HEADER_CHANGED, ACCESSIBLE_TABLE_MODEL_CHANGED, ACCESSIBLE_TABLE_ROW_DESCRIPTION_CHANGED, ACCESSIBLE_TABLE_ROW_HEADER_CHANGED, ACCESSIBLE_TABLE_SUMMARY_CHANGED, ACCESSIBLE_TEXT_ATTRIBUTES_CHANGED, ACCESSIBLE_TEXT_PROPERTY, ACCESSIBLE_VALUE_PROPERTY, ACCESSIBLE_VISIBLE_DATA_PROPERTY, accessibleDescription, accessibleName, accessibleParent

Constructor Summary

protected

Component.AccessibleAWTComponent() The default constructor.

Method Summary

void	addFocusListener(FocusListener l) Adds a focus listener.
void	addPropertyChangeListener(PropertyChangeListener l) Adds a global property change listener to the accessible component.
boolean	contains(Point p) Tests if the point is contained in this component.
javax.accessibility.Accessible	getAccessibleAt(Point p) Returns the Accessible child at a point relative to the coordinate system of this component, if one exists, or null.
javax.accessibility.Accessible	getAccessibleChild(int i) Returns the ith accessible child.
int	getAccessibleChildrenCount() Returns the number of children of this component which implement Accessible.
javax.accessibility.AccessibleComponent	getAccessibleComponent() Returns this, since it is an accessible component.
String	getAccessibleDescription() Returns a brief description of this accessible context.
int	getAccessibleIndexInParent() Returns the index of this component in its accessible parent.
String	getAccessibleName() Returns the accessible name of this component.
javax.accessibility.Accessible	getAccessibleParent() Returns the parent of this component, if it is accessible.
javax.accessibility.AccessibleRole	getAccessibleRole() Returns the role of this component.
javax.accessibility.AccessibleStateSet	getAccessibleStateSet() Returns a state set describing this component's state.
Color	getBackground() Gets the background color.
Rectangle	getBounds() Gets the bounds of this component, or null if it is not on screen.
Cursor	getCursor() Gets the cursor.
Font	getFont() Gets the font.
FontMetrics	getFontMetrics(Font f) Gets the font metrics for a font.
Color	getForeground() Gets the foreground color.
Locale	getLocale() Returns the locale of this component.
Point	getLocation() Returns the location of this object relative to its parent's coordinate system, or null if it is not showing.
Point	getLocationOnScreen() Returns the location of this object on the screen, or null if it is not showing.
Dimension	getSize() Gets the size of this component, or null if it is not showing.
boolean	isEnabled() Tests if the component is enabled.
boolean	isFocusTraversable() Tests whether this component can accept focus.
boolean	isShowing() Tests if the component is showing.
boolean	isVisible() Test whether the component is visible (not necesarily showing).
void	removeFocusListener(FocusListener l) Removes a focus listener.
void	removePropertyChangeListener(PropertyChangeListener l) Removes a global property change listener from this accessible component.
void	requestFocus() Requests focus for this component.
void	setBackground(Color c) Sets the background color.
void	setBounds(Rectangle r) Sets the bounds of this component.
void	setCursor(Cursor cursor) Sets the cursor.
void	setEnabled(boolean b) Set whether the component is enabled.
void	setFont(Font f) Sets the font.
void	setForeground(Color c) Sets the foreground color.
void	setLocation(Point p) Sets the location of this relative to its parent's coordinate system.
void	setSize(Dimension d) Sets the size of this component.
void	setVisible(boolean b) Sets the visibility of this component.

Methods inherited from class javax.accessibility.AccessibleContext

firePropertyChange, getAccessibleAction, getAccessibleEditableText, getAccessibleIcon, getAccessibleRelationSet, getAccessibleSelection, getAccessibleTable, getAccessibleText, getAccessibleValue, setAccessibleDescription, setAccessibleName, setAccessibleParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

accessibleAWTComponentHandler

protected ComponentListener accessibleAWTComponentHandler

Converts show/hide events to PropertyChange events, and is registered as a component listener on this component.

accessibleAWTFocusHandler

protected FocusListener accessibleAWTFocusHandler

Converts focus events to PropertyChange events, and is registered as a focus listener on this component.

Constructor Detail

Component.AccessibleAWTComponent

protected Component.AccessibleAWTComponent()

The default constructor.

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

Adds a global property change listener to the accessible component.

Overrides:

addPropertyChangeListener in class javax.accessibility.AccessibleContext

Parameters:

l - the listener to add

See Also:

AccessibleContext.ACCESSIBLE_NAME_PROPERTY, AccessibleContext.ACCESSIBLE_DESCRIPTION_PROPERTY, AccessibleContext.ACCESSIBLE_STATE_PROPERTY, AccessibleContext.ACCESSIBLE_VALUE_PROPERTY, AccessibleContext.ACCESSIBLE_SELECTION_PROPERTY, AccessibleContext.ACCESSIBLE_TEXT_PROPERTY, AccessibleContext.ACCESSIBLE_VISIBLE_DATA_PROPERTY

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)

Removes a global property change listener from this accessible component.

Overrides:

removePropertyChangeListener in class javax.accessibility.AccessibleContext

Parameters:

l - the listener to remove

See Also:

AccessibleContext.addPropertyChangeListener(PropertyChangeListener)

getAccessibleName

public String getAccessibleName()

Returns the accessible name of this component. It is almost always wrong to return getName(), since it is not localized. In fact, for things like buttons, this should be the text of the button, not the name of the object. The tooltip text might also be appropriate.

Overrides:

getAccessibleName in class javax.accessibility.AccessibleContext

Returns:

the name

See Also:

AccessibleContext.setAccessibleName(String)

getAccessibleDescription

public String getAccessibleDescription()

Returns a brief description of this accessible context. This should be localized.

Overrides:

getAccessibleDescription in class javax.accessibility.AccessibleContext

Returns:

a description of this component

See Also:

AccessibleContext.setAccessibleDescription(String)

getAccessibleRole

public javax.accessibility.AccessibleRole getAccessibleRole()

Returns the role of this component.

Specified by:

getAccessibleRole in class javax.accessibility.AccessibleContext

Returns:

the accessible role

See Also:

AccessibleRole

getAccessibleStateSet

public javax.accessibility.AccessibleStateSet getAccessibleStateSet()

Returns a state set describing this component's state.

Specified by:

getAccessibleStateSet in class javax.accessibility.AccessibleContext

Returns:

a new state set

See Also:

AccessibleState

getAccessibleParent

public javax.accessibility.Accessible getAccessibleParent()

Returns the parent of this component, if it is accessible.

Overrides:

getAccessibleParent in class javax.accessibility.AccessibleContext

Returns:

the accessible parent

getAccessibleIndexInParent

public int getAccessibleIndexInParent()

Returns the index of this component in its accessible parent.

Specified by:

getAccessibleIndexInParent in class javax.accessibility.AccessibleContext

Returns:

the index, or -1 if the parent is not accessible

See Also:

getAccessibleParent()

getAccessibleChildrenCount

public int getAccessibleChildrenCount()

Returns the number of children of this component which implement Accessible. Subclasses must override this if they can have children.

Specified by:

getAccessibleChildrenCount in class javax.accessibility.AccessibleContext

Returns:

the number of accessible children, default 0

See Also:

AccessibleContext.getAccessibleChild(int)

getAccessibleChild

public javax.accessibility.Accessible getAccessibleChild(int i)

Returns the ith accessible child. Subclasses must override this if they can have children.

Specified by:

getAccessibleChild in class javax.accessibility.AccessibleContext

Parameters:

i - the 0-based index to get

Returns:

the ith accessible child, or null

See Also:

getAccessibleChildrenCount()

getLocale

public Locale getLocale()

Returns the locale of this component.

Specified by:

getLocale in class javax.accessibility.AccessibleContext

Returns:

the locale

Throws:

IllegalComponentStateException - if the locale is unknown

getAccessibleComponent

public javax.accessibility.AccessibleComponent getAccessibleComponent()

Returns this, since it is an accessible component.

Overrides:

getAccessibleComponent in class javax.accessibility.AccessibleContext

Returns:

the accessible component

See Also:

AccessibleComponent

getBackground

public Color getBackground()

Gets the background color.

Specified by:

getBackground in interface javax.accessibility.AccessibleComponent

Returns:

the background color

See Also:

setBackground(Color)

setBackground

public void setBackground(Color c)

Sets the background color.

Specified by:

setBackground in interface javax.accessibility.AccessibleComponent

Parameters:

c - the background color

See Also:

getBackground(), Component.isOpaque()

getForeground

public Color getForeground()

Gets the foreground color.

Specified by:

getForeground in interface javax.accessibility.AccessibleComponent

Returns:

the foreground color

See Also:

setForeground(Color)

setForeground

public void setForeground(Color c)

Sets the foreground color.

Specified by:

setForeground in interface javax.accessibility.AccessibleComponent

Parameters:

c - the foreground color

See Also:

getForeground()

getCursor

public Cursor getCursor()

Gets the cursor.

Specified by:

getCursor in interface javax.accessibility.AccessibleComponent

Returns:

the cursor

See Also:

setCursor(Cursor)

setCursor

public void setCursor(Cursor cursor)

Sets the cursor.

Specified by:

setCursor in interface javax.accessibility.AccessibleComponent

Parameters:

cursor - the cursor

See Also:

getCursor()

getFont

public Font getFont()

Gets the font.

Specified by:

getFont in interface javax.accessibility.AccessibleComponent

Returns:

the font

See Also:

setFont(Font)

setFont

public void setFont(Font f)

Sets the font.

Specified by:

setFont in interface javax.accessibility.AccessibleComponent

Parameters:

f - the font

See Also:

getFont()

getFontMetrics

public FontMetrics getFontMetrics(Font f)

Gets the font metrics for a font.

Specified by:

getFontMetrics in interface javax.accessibility.AccessibleComponent

Parameters:

f - the font to look up

Returns:

its metrics

Throws:

NullPointerException - if f is null

See Also:

getFont()

isEnabled

public boolean isEnabled()

Tests if the component is enabled.

Specified by:

isEnabled in interface javax.accessibility.AccessibleComponent

Returns:

true if the component is enabled

See Also:

setEnabled(boolean), getAccessibleStateSet(), AccessibleState.ENABLED

setEnabled

public void setEnabled(boolean b)

Set whether the component is enabled.

Specified by:

setEnabled in interface javax.accessibility.AccessibleComponent

Parameters:

b - the new enabled status

See Also:

isEnabled()

isVisible

public boolean isVisible()

Test whether the component is visible (not necesarily showing).

Specified by:

isVisible in interface javax.accessibility.AccessibleComponent

Returns:

true if it is visible

See Also:

setVisible(boolean), getAccessibleStateSet(), AccessibleState.VISIBLE

setVisible

public void setVisible(boolean b)

Sets the visibility of this component.

Specified by:

setVisible in interface javax.accessibility.AccessibleComponent

Parameters:

b - the desired visibility

See Also:

isVisible()

isShowing

public boolean isShowing()

Tests if the component is showing.

Specified by:

isShowing in interface javax.accessibility.AccessibleComponent

Returns:

true if this is showing

See Also:

AccessibleComponent.isVisible(), AccessibleComponent.setVisible(boolean), AccessibleContext.getAccessibleStateSet(), AccessibleState.SHOWING

contains

public boolean contains(Point p)

Tests if the point is contained in this component.

Specified by:

contains in interface javax.accessibility.AccessibleComponent

Parameters:

p - the point to check

Returns:

true if it is contained

Throws:

NullPointerException - if p is null

See Also:

AccessibleComponent.getBounds()

getLocationOnScreen

public Point getLocationOnScreen()

Returns the location of this object on the screen, or null if it is not showing.

Specified by:

getLocationOnScreen in interface javax.accessibility.AccessibleComponent

Returns:

the location relative to screen coordinates, if showing

See Also:

getBounds(), getLocation()

getLocation

public Point getLocation()

Returns the location of this object relative to its parent's coordinate system, or null if it is not showing.

Specified by:

getLocation in interface javax.accessibility.AccessibleComponent

Returns:

the location

See Also:

getBounds(), getLocationOnScreen()

setLocation

public void setLocation(Point p)

Sets the location of this relative to its parent's coordinate system.

Specified by:

setLocation in interface javax.accessibility.AccessibleComponent

Parameters:

p - the location

Throws:

NullPointerException - if p is null

See Also:

getLocation()

getBounds

public Rectangle getBounds()

Gets the bounds of this component, or null if it is not on screen.

Specified by:

getBounds in interface javax.accessibility.AccessibleComponent

Returns:

the bounds

See Also:

contains(Point), setBounds(Rectangle)

setBounds

public void setBounds(Rectangle r)

Sets the bounds of this component.

Specified by:

setBounds in interface javax.accessibility.AccessibleComponent

Parameters:

r - the bounds

Throws:

NullPointerException - if r is null

See Also:

getBounds()

getSize

public Dimension getSize()

Gets the size of this component, or null if it is not showing.

Specified by:

getSize in interface javax.accessibility.AccessibleComponent

Returns:

the size

See Also:

setSize(Dimension)

setSize

public void setSize(Dimension d)

Sets the size of this component.

Specified by:

setSize in interface javax.accessibility.AccessibleComponent

Parameters:

d - the size

Throws:

NullPointerException - if d is null

See Also:

getSize()

getAccessibleAt

public javax.accessibility.Accessible getAccessibleAt(Point p)

Returns the Accessible child at a point relative to the coordinate system of this component, if one exists, or null. Since components have no children, subclasses must override this to get anything besides null.

Specified by:

getAccessibleAt in interface javax.accessibility.AccessibleComponent

Parameters:

p - the point to check

Returns:

the accessible child at that point

Throws:

NullPointerException - if p is null

isFocusTraversable

public boolean isFocusTraversable()

Tests whether this component can accept focus.

Specified by:

isFocusTraversable in interface javax.accessibility.AccessibleComponent

Returns:

true if this is focus traversable

See Also:

(), AccessibleState.FOCUSABLE, AccessibleState.FOCUSED

requestFocus

public void requestFocus()

Requests focus for this component.

Specified by:

requestFocus in interface javax.accessibility.AccessibleComponent

See Also:

()

addFocusListener

public void addFocusListener(FocusListener l)

Adds a focus listener.

Specified by:

addFocusListener in interface javax.accessibility.AccessibleComponent

Parameters:

l - the listener to add

See Also:

AccessibleComponent.removeFocusListener(FocusListener)

removeFocusListener

public void removeFocusListener(FocusListener l)

Removes a focus listener.

Specified by:

removeFocusListener in interface javax.accessibility.AccessibleComponent

Parameters:

l - the listener to remove

See Also:

AccessibleComponent.addFocusListener(FocusListener)