javax.accessibility
Class AccessibleContext
java.lang.Object
|
+--javax.accessibility.AccessibleContext
public abstract class
AccessibleContextextends
Object The minimum information that all accessible objects return. This includes
name, description, role, and state of the object, parents and children,
and any other useful information. If a component supports further details,
it should implement one of the following:
- AccessibleAction - the object can perform actions
- AccessibleComponent - the object has a graphical
representation
- AccessibleSelection - the object allows its children to be
selected
- AccessibleText - the object represents editable text
- AccessibleValue - the object represents a numerical value
Since:Author:- Eric Blake <ebb9@email.byu.edu>
ACCESSIBLE_ACTION_PROPERTY
public static final String ACCESSIBLE_ACTION_PROPERTY
Constant used when supported set of actions has changed. Both the old
and new values are listed in the event.
See Also:
ACCESSIBLE_ACTIVE_DESCENDANT_PROPERTY
public static final String ACCESSIBLE_ACTIVE_DESCENDANT_PROPERTY
Constant used when active descendent of a component has changed. Both
the old and new values are listed in the event.
See Also:
ACCESSIBLE_CARET_PROPERTY
public static final String ACCESSIBLE_CARET_PROPERTY
Constant used when the accessibleText caret has changed. Both the old and
new values are listed in the event.
See Also:
ACCESSIBLE_CHILD_PROPERTY
public static final String ACCESSIBLE_CHILD_PROPERTY
Constant used when children are added or removed. On addition, the new
value of the event holds the new child; on removal, the old value holds
the removed child.
See Also:
ACCESSIBLE_DESCRIPTION_PROPERTY
public static final String ACCESSIBLE_DESCRIPTION_PROPERTY
Constanat used when the accessible description has changed. Both the old
and new values are listed in the event.
See Also:
ACCESSIBLE_HYPERTEXT_OFFSET
public static final String ACCESSIBLE_HYPERTEXT_OFFSET
Constant used when a hypertext element received focus. Both the old
and new values are listed in the event, with -1 indicating that no link
had focus.
See Also:
ACCESSIBLE_NAME_PROPERTY
public static final String ACCESSIBLE_NAME_PROPERTY
Constant used when the accessible name has changed. Both the old and new
values are listed in the event.
See Also:
ACCESSIBLE_SELECTION_PROPERTY
public static final String ACCESSIBLE_SELECTION_PROPERTY
Constant used when the accessibleSelection has changed. Both the old and
new values of the event are reserved for future use.
See Also:
ACCESSIBLE_STATE_PROPERTY
public static final String ACCESSIBLE_STATE_PROPERTY
Constant used when the accessibleStateSet has changed. Both the old and
new values are listed in the event, although either may be null if a
state was disabled at that time.
See Also:
ACCESSIBLE_TABLE_CAPTION_CHANGED
public static final String ACCESSIBLE_TABLE_CAPTION_CHANGED
Constant used when the accessible table caption has changed. Both the
old and new values are listed in the event.
See Also:
ACCESSIBLE_TABLE_COLUMN_DESCRIPTION_CHANGED
public static final String ACCESSIBLE_TABLE_COLUMN_DESCRIPTION_CHANGED
Constant used when the accessible table column description has changed.
Only the new value of the event has meaning.
See Also:
ACCESSIBLE_TABLE_COLUMN_HEADER_CHANGED
public static final String ACCESSIBLE_TABLE_COLUMN_HEADER_CHANGED
Constant used when the accessible table column header has changed. Only
the new value of the event has meaning.
See Also:
ACCESSIBLE_TABLE_MODEL_CHANGED
public static final String ACCESSIBLE_TABLE_MODEL_CHANGED
Constant used when the accessible table model has changed. Only the new
value of the event has meaning.
See Also:
ACCESSIBLE_TABLE_ROW_DESCRIPTION_CHANGED
public static final String ACCESSIBLE_TABLE_ROW_DESCRIPTION_CHANGED
Constant used when the accessible table row description has changed. Only
the new value of the event has meaning.
See Also:
ACCESSIBLE_TABLE_ROW_HEADER_CHANGED
public static final String ACCESSIBLE_TABLE_ROW_HEADER_CHANGED
Constant used when the accessible table row header has changed. Only the
new value of the event has meaning.
See Also:
ACCESSIBLE_TABLE_SUMMARY_CHANGED
public static final String ACCESSIBLE_TABLE_SUMMARY_CHANGED
Constant used when the accessible table summary has changed. Both the
old and new values are listed in the event.
See Also:
ACCESSIBLE_TEXT_PROPERTY
public static final String ACCESSIBLE_TEXT_PROPERTY
Constant used when the accessibleText has changed. Both the old and new
values of the event are reserved for future use.
See Also:
ACCESSIBLE_VALUE_PROPERTY
public static final String ACCESSIBLE_VALUE_PROPERTY
Constant used when the accessibleValue has changed. Both the old and new
values are listed in the event.
See Also:
ACCESSIBLE_VISIBLE_DATA_PROPERTY
public static final String ACCESSIBLE_VISIBLE_DATA_PROPERTY
Constant used when the visible data has changed. Both the old and new
values of the event are reserved for future use.
See Also:
accessibleDescription
protected String accessibleDescription
A localized string describing this object.
See Also:
accessibleName
protected String accessibleName
A localized string naming this object.
See Also:
accessibleParent
protected Accessible accessibleParent
The accessible parent of this object.
See Also:
AccessibleContext
public AccessibleContext()
Default constructor.
addPropertyChangeListener
public void addPropertyChangeListener(java.beans.PropertyChangeListener l)
Add a PropertyChangeListener to the listener list. This listener will
be notified of all property changes to the accessible object.
Parameters:
See Also:
firePropertyChange
public void firePropertyChange(java.lang.String name, java.lang.Object oldValue, java.lang.Object newValue)
Fire an event to report property changes. This is intended for use by
the accessible objects, not general application programs. If oldValue and
newValue differ, and the listenter list is not empty, a PropertyChange
event is fired to each listener.
Parameters:
See Also:
getAccessibleAction
public AccessibleAction getAccessibleAction()
Get any supported accessible actions. The default implementation returns
null.
Returns:
- the supported action, or null
See Also:
getAccessibleChild
public Accessible getAccessibleChild(int i)
Returns the specified accessible chile.
Parameters:
Returns:
- the child, or null if out of bounds
See Also:
getAccessibleChildrenCount
public int getAccessibleChildrenCount()
Returns the number of accessible children of this object.
Returns:
- the number of accessible children
See Also:
getAccessibleComponent
public AccessibleComponent getAccessibleComponent()
Get any supported accessible compoent. The default implementation returns
null.
Returns:
- the supported component, or null
See Also:
getAccessibleDescription
public String getAccessibleDescription()
Get the localized description of the object. For example, a 'Cancel'
button may be described as "Ignore changes and close dialog box" in
en_US.
Returns:
- the accessible object's description, or null if there is none
See Also:
getAccessibleEditableText
public AccessibleEditableText getAccessibleEditableText()
Get any supported accessible editable text. The default implementation
returns null.
Returns:
- the supported editable text, or null
See Also:
getAccessibleIcon
public AccessibleIcon[] getAccessibleIcon()
Get all supported accessible icons. The default implementation returns
null.
Returns:
- the supported icons, or null
See Also:
getAccessibleIndexInParent
public int getAccessibleIndexInParent()
Gets the index of this object within its accessible parent.
Returns:
- the 0-based index, or -1 if there is no accessible parent
See Also:
getAccessibleName
public String getAccessibleName()
Get the localized name of the object. For example, a label may just
return the text of the label, while an entry field for city may return
"city" in en_US.
Returns:
- the accessible object's name, or null if it is unnamed
See Also:
getAccessibleParent
public Accessible getAccessibleParent()
Return the accessible parent of this object.
Returns:
- the accessible parent, or null if there is none
getAccessibleRelationSet
public AccessibleRelationSet getAccessibleRelationSet()
Get any supported accessible relation set. The default implementation
returns null.
Returns:
- the supported relation set, or null
See Also:
getAccessibleRole
public AccessibleRole getAccessibleRole()
Gets the role of this object. For example, a button serves the role of
AccessibleRole.PUSH_BUTTON. This allows assistive technologies to funnel
similar objects into the same assistance classes. Note that the class
is extensible, to define new roles if necessary.
Returns:
See Also:
getAccessibleSelection
public AccessibleSelection getAccessibleSelection()
Get any supported accessible selection. The default implementation returns
null.
Returns:
- the supported selection, or null
See Also:
getAccessibleStateSet
public AccessibleStateSet getAccessibleStateSet()
Gets the state set of this object. A change in the state of the object
will fire a PropertyChangeEvent for ACCESSIBLE_STATE_PROPERTY.
Returns:
- the current state of the object
See Also:
getAccessibleTable
public AccessibleTable getAccessibleTable()
Get any supported accessible table. The default implementation returns
null.
Returns:
- the supported table, or null
See Also:
getAccessibleText
public AccessibleText getAccessibleText()
Get any supported accessible text. The default implementation returns
null.
Returns:
- the supported text, or null
See Also:
getAccessibleValue
public AccessibleValue getAccessibleValue()
Get any supported accessible value. The default implementation returns
null.
Returns:
- the supported value, or null
See Also:
getLocale
public Locale getLocale()
Gets the component locale, deferring to the parent if one is not declared.
Returns:
Throws:
removePropertyChangeListener
public void removePropertyChangeListener(java.beans.PropertyChangeListener l)
Remove a PropertyChangeListener from the listener list.
Parameters:
See Also:
setAccessibleDescription
public void setAccessibleDescription(java.lang.String s)
Set the localized name of the object. This will fire a
PropertyChangeEvent with ACCESSIBLE_DESCRIPTION_PROPERTY.
Parameters:
See Also:
setAccessibleName
public void setAccessibleName(java.lang.String s)
Set the localized name of the object. This will fire a
PropertyChangeEvent with ACCESSIBLE_NAME_PROPERTY.
Parameters:
See Also:
setAccessibleParent
public void setAccessibleParent(javax.accessibility.Accessible a)
Sets the accessible parent of this object. This should only be used when
the current parent object should not be the accessible parent; only the
parent of the accessible child should call this method.
Parameters: