Class Component.AccessibleAWTComponent
java.lang.Object
javax.accessibility.AccessibleContext
java.awt.Component.AccessibleAWTComponent
- All Implemented Interfaces:
Serializable
,AccessibleComponent
- Direct Known 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
- Enclosing class:
Component
protected abstract class Component.AccessibleAWTComponent
extends AccessibleContext
implements Serializable, AccessibleComponent
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.
- Since:
- 1.3
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionprotected class
Fire PropertyChange listener, if one is registered, when shown/hidden..protected class
Fire PropertyChange listener, if one is registered, when focus events happen -
Field Summary
Modifier and TypeFieldDescriptionprotected ComponentListener
A component listener to track show/hide/resize events and convert them to PropertyChange events.protected FocusListener
A listener to track focus events and convert them to PropertyChange events.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
ModifierConstructorDescriptionprotected
Though the class is abstract, this should be called by all sub-classes. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds the specified focus listener to receive focus events from this component.void
Adds aPropertyChangeListener
to the listener list.boolean
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.Returns theAccessible
child, if one exists, contained at the local coordinatePoint
.getAccessibleChild
(int i) Returns the nthAccessible
child of the object.int
Returns the number of accessible children in the object.Gets theAccessibleComponent
associated with this object if one exists.Gets the accessible description of this object.int
Gets the index of this object in its accessible parent.Gets the accessible name of this object.Gets theAccessible
parent of this object.Gets the role of this object.Gets the state of this object.Gets the background color of this object.Gets the bounds of this object in the form of a Rectangle object.Gets theCursor
of this object.getFont()
Gets theFont
of this object.Gets theFontMetrics
of this object.Gets the foreground color of this object.Returns the locale of this object.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 the location of the object on the screen.getSize()
Returns the size of this object in the form of aDimension
object.boolean
Determines if the object is enabled.boolean
Returns whether this object can accept focus or not.boolean
Determines if the object is showing.boolean
Determines if the object is visible.void
Removes the specified focus listener so it no longer receives focus events from this component.void
Remove a PropertyChangeListener from the listener list.void
Requests focus for this object.void
Sets the background color of this object.void
Sets the bounds of this object in the form of aRectangle
object.void
Sets theCursor
of this object.void
setEnabled
(boolean b) Sets the enabled state of the object.void
Sets theFont
of this object.void
Sets the foreground color of this object.void
setLocation
(Point p) Sets the location of the object relative to the parent.void
Resizes this object so that it has width and height.void
setVisible
(boolean b) Sets the visible state of the object.Methods inherited from class javax.accessibility.AccessibleContext
firePropertyChange, getAccessibleAction, getAccessibleEditableText, getAccessibleIcon, getAccessibleRelationSet, getAccessibleSelection, getAccessibleTable, getAccessibleText, getAccessibleValue, setAccessibleDescription, setAccessibleName, setAccessibleParent
-
Field Details
-
accessibleAWTComponentHandler
A component listener to track show/hide/resize events and convert them to PropertyChange events. -
accessibleAWTFocusHandler
A listener to track focus events and convert them to PropertyChange events.
-
-
Constructor Details
-
AccessibleAWTComponent
protected AccessibleAWTComponent()Though the class is abstract, this should be called by all sub-classes.
-
-
Method Details
-
addPropertyChangeListener
Adds aPropertyChangeListener
to the listener list.- Overrides:
addPropertyChangeListener
in classAccessibleContext
- Parameters:
listener
- the property change listener to be added- See Also:
-
removePropertyChangeListener
Remove a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties.- Overrides:
removePropertyChangeListener
in classAccessibleContext
- Parameters:
listener
- The PropertyChangeListener to be removed
-
getAccessibleName
Gets the accessible name of this object. This should almost never returnjava.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.- Overrides:
getAccessibleName
in classAccessibleContext
- Returns:
- the localized name of the object -- can be
null
if this object does not have a name - See Also:
-
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).- Overrides:
getAccessibleDescription
in classAccessibleContext
- Returns:
- the localized description of the object -- can be
null
if this object does not have a description - See Also:
-
getAccessibleRole
Gets the role of this object.- Specified by:
getAccessibleRole
in classAccessibleContext
- Returns:
- an instance of
AccessibleRole
describing the role of the object - See Also:
-
getAccessibleStateSet
Gets the state of this object.- Specified by:
getAccessibleStateSet
in classAccessibleContext
- Returns:
- an instance of
AccessibleStateSet
containing the current state set of the object - See Also:
-
getAccessibleParent
Gets theAccessible
parent of this object. If the parent of this object implementsAccessible
, this method should simply returngetParent
.- Overrides:
getAccessibleParent
in classAccessibleContext
- Returns:
- the
Accessible
parent of this object -- can benull
if this object does not have anAccessible
parent
-
getAccessibleIndexInParent
public int getAccessibleIndexInParent()Gets the index of this object in its accessible parent.- Specified by:
getAccessibleIndexInParent
in classAccessibleContext
- Returns:
- the index of this object in its parent; or -1 if this object does not have an accessible parent
- See Also:
-
getAccessibleChildrenCount
public int getAccessibleChildrenCount()Returns the number of accessible children in the object. If all of the children of this object implementAccessible
, then this method should return the number of children of this object.- Specified by:
getAccessibleChildrenCount
in classAccessibleContext
- Returns:
- the number of accessible children in the object
-
getAccessibleChild
Returns the nthAccessible
child of the object.- Specified by:
getAccessibleChild
in classAccessibleContext
- Parameters:
i
- zero-based index of child- Returns:
- the nth
Accessible
child of the object - See Also:
-
getLocale
Returns the locale of this object.- Specified by:
getLocale
in classAccessibleContext
- Returns:
- the locale of this object
-
getAccessibleComponent
Gets theAccessibleComponent
associated with this object if one exists. Otherwise returnnull
.- Overrides:
getAccessibleComponent
in classAccessibleContext
- Returns:
- the component
- See Also:
-
getBackground
Gets the background color of this object.- Specified by:
getBackground
in interfaceAccessibleComponent
- Returns:
- the background color, if supported, of the object;
otherwise,
null
- See Also:
-
setBackground
Sets the background color of this object. (For transparency, seeisOpaque
.)- Specified by:
setBackground
in interfaceAccessibleComponent
- Parameters:
c
- the newColor
for the background- See Also:
-
getForeground
Gets the foreground color of this object.- Specified by:
getForeground
in interfaceAccessibleComponent
- Returns:
- the foreground color, if supported, of the object;
otherwise,
null
- See Also:
-
setForeground
Sets the foreground color of this object.- Specified by:
setForeground
in interfaceAccessibleComponent
- Parameters:
c
- the newColor
for the foreground- See Also:
-
getCursor
Gets theCursor
of this object.- Specified by:
getCursor
in interfaceAccessibleComponent
- Returns:
- the
Cursor
, if supported, of the object; otherwise,null
- See Also:
-
setCursor
Sets theCursor
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.
- Specified by:
setCursor
in interfaceAccessibleComponent
- Parameters:
cursor
- the newCursor
for the object- See Also:
-
getFont
Gets theFont
of this object.- Specified by:
getFont
in interfaceAccessibleComponent
- Returns:
- the
Font
, if supported, for the object; otherwise,null
- See Also:
-
setFont
Sets theFont
of this object.- Specified by:
setFont
in interfaceAccessibleComponent
- Parameters:
f
- the newFont
for the object- See Also:
-
getFontMetrics
Gets theFontMetrics
of this object.- Specified by:
getFontMetrics
in interfaceAccessibleComponent
- Parameters:
f
- theFont
- Returns:
- the
FontMetrics
, if supported, the object; otherwise,null
- See Also:
-
isEnabled
public boolean isEnabled()Determines if the object is enabled.- Specified by:
isEnabled
in interfaceAccessibleComponent
- Returns:
- true if object is enabled; otherwise, false
- See Also:
-
setEnabled
public void setEnabled(boolean b) Sets the enabled state of the object.- Specified by:
setEnabled
in interfaceAccessibleComponent
- Parameters:
b
- if true, enables this object; otherwise, disables it- See Also:
-
isVisible
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, useisShowing
.- Specified by:
isVisible
in interfaceAccessibleComponent
- Returns:
- true if object is visible; otherwise, false
- See Also:
-
setVisible
public void setVisible(boolean b) Sets the visible state of the object.- Specified by:
setVisible
in interfaceAccessibleComponent
- Parameters:
b
- if true, shows this object; otherwise, hides it- See Also:
-
isShowing
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).- Specified by:
isShowing
in interfaceAccessibleComponent
- Returns:
- true if object is showing; otherwise, false
-
contains
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.- Specified by:
contains
in interfaceAccessibleComponent
- Parameters:
p
- thePoint
relative to the coordinate system of the object- Returns:
- true if object contains
Point
; otherwise false - See Also:
-
getLocationOnScreen
Returns the location of the object on the screen.- Specified by:
getLocationOnScreen
in interfaceAccessibleComponent
- Returns:
- location of object on screen -- can be
null
if this object is not on the screen - See Also:
-
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.- Specified by:
getLocation
in interfaceAccessibleComponent
- 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 - See Also:
-
setLocation
Sets the location of the object relative to the parent.- Specified by:
setLocation
in interfaceAccessibleComponent
- Parameters:
p
- the coordinates of the object- See Also:
-
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.- Specified by:
getBounds
in interfaceAccessibleComponent
- Returns:
- a rectangle indicating this component's bounds;
null
if this object is not on the screen - See Also:
-
setBounds
Sets the bounds of this object in the form of aRectangle
object. The bounds specify this object's width, height, and location relative to its parent.- Specified by:
setBounds
in interfaceAccessibleComponent
- Parameters:
r
- a rectangle indicating this component's bounds- See Also:
-
getSize
Returns the size of this object in the form of aDimension
object. The height field of theDimension
object contains this object's height, and the width field of theDimension
object contains this object's width.- Specified by:
getSize
in interfaceAccessibleComponent
- Returns:
- a
Dimension
object that indicates the size of this component;null
if this object is not on the screen - See Also:
-
setSize
Resizes this object so that it has width and height.- Specified by:
setSize
in interfaceAccessibleComponent
- Parameters:
d
- the dimension specifying the new size of the object- See Also:
-
getAccessibleAt
Returns theAccessible
child, if one exists, contained at the local coordinatePoint
. Otherwise returnsnull
.- Specified by:
getAccessibleAt
in interfaceAccessibleComponent
- Parameters:
p
- the point defining the top-left corner of theAccessible
, given in the coordinate space of the object's parent- Returns:
- the
Accessible
, if it exists, at the specified location; elsenull
-
isFocusTraversable
public boolean isFocusTraversable()Returns whether this object can accept focus or not.- Specified by:
isFocusTraversable
in interfaceAccessibleComponent
- Returns:
- true if object can accept focus; otherwise false
- See Also:
-
requestFocus
public void requestFocus()Requests focus for this object.- Specified by:
requestFocus
in interfaceAccessibleComponent
- See Also:
-
addFocusListener
Adds the specified focus listener to receive focus events from this component.- Specified by:
addFocusListener
in interfaceAccessibleComponent
- Parameters:
l
- the focus listener- See Also:
-
removeFocusListener
Removes the specified focus listener so it no longer receives focus events from this component.- Specified by:
removeFocusListener
in interfaceAccessibleComponent
- Parameters:
l
- the focus listener- See Also:
-