|
Java™ Platform Standard Ed. 6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.accessibility.AccessibleContext
public abstract class AccessibleContext
AccessibleContext represents the minimum information all accessible objects return. This information includes the accessible name, description, role, and state of the object, as well as information about its parent and children. AccessibleContext also contains methods for obtaining more specific accessibility information about a component. If the component supports them, these methods will return an object that implements one or more of the following interfaces:
AccessibleAction
- the object can perform one or more actions.
This interface provides the standard mechanism for an assistive
technology to determine what those actions are and tell the object
to perform them. Any object that can be manipulated should
support this interface.
AccessibleComponent
- the object has a graphical representation.
This interface provides the standard mechanism for an assistive
technology to determine and set the graphical representation of the
object. Any object that is rendered on the screen should support
this interface.
AccessibleSelection
- the object allows its children to be
selected. This interface provides the standard mechanism for an
assistive technology to determine the currently selected children of the object
as well as modify its selection set. Any object that has children
that can be selected should support this interface.
AccessibleText
- the object presents editable textual information
on the display. This interface provides the standard mechanism for
an assistive technology to access that text via its content, attributes,
and spatial location. Any object that contains editable text should
support this interface.
AccessibleValue
- the object supports a numerical value. This
interface provides the standard mechanism for an assistive technology
to determine and set the current value of the object, as well as obtain its
minimum and maximum values. Any object that supports a numerical value
should support this interface.
Field Summary | |
---|---|
static String |
ACCESSIBLE_ACTION_PROPERTY
Constant used to indicate that the supported set of actions has changed. |
static String |
ACCESSIBLE_ACTIVE_DESCENDANT_PROPERTY
Constant used to determine when the active descendant of a component has changed. |
static String |
ACCESSIBLE_CARET_PROPERTY
Constant used to determine when the accessibleText caret has changed. |
static String |
ACCESSIBLE_CHILD_PROPERTY
Constant used to determine when Accessible children are added/removed from the object. |
static String |
ACCESSIBLE_COMPONENT_BOUNDS_CHANGED
PropertyChangeEvent which indicates that a change has occurred in a component's bounds. |
static String |
ACCESSIBLE_DESCRIPTION_PROPERTY
Constant used to determine when the accessibleDescription property has changed. |
static String |
ACCESSIBLE_HYPERTEXT_OFFSET
Constant used to indicate that a hypertext element has received focus. |
static String |
ACCESSIBLE_INVALIDATE_CHILDREN
PropertyChangeEvent which indicates that a significant change has occurred to the children of a component like a tree or text. |
static String |
ACCESSIBLE_NAME_PROPERTY
Constant used to determine when the accessibleName property has changed. |
static String |
ACCESSIBLE_SELECTION_PROPERTY
Constant used to determine when the accessibleSelection has changed. |
static String |
ACCESSIBLE_STATE_PROPERTY
Constant used to determine when the accessibleStateSet property has changed. |
static 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. |
static 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. |
static 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. |
static String |
ACCESSIBLE_TABLE_MODEL_CHANGED
Constant used to indicate that table data has changed. |
static 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. |
static 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. |
static 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. |
static String |
ACCESSIBLE_TEXT_ATTRIBUTES_CHANGED
PropertyChangeEvent which indicates that text attributes have changed. |
static String |
ACCESSIBLE_TEXT_PROPERTY
PropertyChangeEvent which indicates that text has changed. |
static String |
ACCESSIBLE_VALUE_PROPERTY
Constant used to determine when the accessibleValue property has changed. |
static String |
ACCESSIBLE_VISIBLE_DATA_PROPERTY
Constant used to determine when the visual appearance of the object has changed. |
protected String |
accessibleDescription
A localized String containing the description of the object. |
protected String |
accessibleName
A localized String containing the name of the object. |
protected Accessible |
accessibleParent
The accessible parent of this object. |
Constructor Summary | |
---|---|
AccessibleContext()
|
Method Summary | |
---|---|
void |
addPropertyChangeListener(PropertyChangeListener listener)
Adds a PropertyChangeListener to the listener list. |
void |
firePropertyChange(String propertyName,
Object oldValue,
Object newValue)
Support for reporting bound property changes. |
AccessibleAction |
getAccessibleAction()
Gets the AccessibleAction associated with this object that supports one or more actions. |
abstract Accessible |
getAccessibleChild(int i)
Returns the specified Accessible child of the object. |
abstract int |
getAccessibleChildrenCount()
Returns the number of accessible children of the object. |
AccessibleComponent |
getAccessibleComponent()
Gets the AccessibleComponent associated with this object that has a graphical representation. |
String |
getAccessibleDescription()
Gets the accessibleDescription property of this object. |
AccessibleEditableText |
getAccessibleEditableText()
Gets the AccessibleEditableText associated with this object presenting editable text on the display. |
AccessibleIcon[] |
getAccessibleIcon()
Gets the AccessibleIcons associated with an object that has one or more associated icons |
abstract int |
getAccessibleIndexInParent()
Gets the 0-based index of this object in its accessible parent. |
String |
getAccessibleName()
Gets the accessibleName property of this object. |
Accessible |
getAccessibleParent()
Gets the Accessible parent of this object. |
AccessibleRelationSet |
getAccessibleRelationSet()
Gets the AccessibleRelationSet associated with an object |
abstract AccessibleRole |
getAccessibleRole()
Gets the role of this object. |
AccessibleSelection |
getAccessibleSelection()
Gets the AccessibleSelection associated with this object which allows its Accessible children to be selected. |
abstract AccessibleStateSet |
getAccessibleStateSet()
Gets the state set of this object. |
AccessibleTable |
getAccessibleTable()
Gets the AccessibleTable associated with an object |
AccessibleText |
getAccessibleText()
Gets the AccessibleText associated with this object presenting text on the display. |
AccessibleValue |
getAccessibleValue()
Gets the AccessibleValue associated with this object that supports a Numerical value. |
abstract Locale |
getLocale()
Gets the locale of the component. |
void |
removePropertyChangeListener(PropertyChangeListener listener)
Removes a PropertyChangeListener from the listener list. |
void |
setAccessibleDescription(String s)
Sets the accessible description of this object. |
void |
setAccessibleName(String s)
Sets the localized accessible name of this object. |
void |
setAccessibleParent(Accessible a)
Sets the Accessible parent of this object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String ACCESSIBLE_NAME_PROPERTY
getAccessibleName()
,
addPropertyChangeListener(java.beans.PropertyChangeListener)
,
Constant Field Valuespublic static final String ACCESSIBLE_DESCRIPTION_PROPERTY
getAccessibleDescription()
,
addPropertyChangeListener(java.beans.PropertyChangeListener)
,
Constant Field Valuespublic static final String ACCESSIBLE_STATE_PROPERTY
getAccessibleStateSet()
,
AccessibleState
,
AccessibleStateSet
,
addPropertyChangeListener(java.beans.PropertyChangeListener)
,
Constant Field Valuespublic static final String ACCESSIBLE_VALUE_PROPERTY
getAccessibleValue()
,
addPropertyChangeListener(java.beans.PropertyChangeListener)
,
Constant Field Valuespublic static final String ACCESSIBLE_SELECTION_PROPERTY
getAccessibleSelection()
,
addPropertyChangeListener(java.beans.PropertyChangeListener)
,
Constant Field Valuespublic static final String ACCESSIBLE_CARET_PROPERTY
addPropertyChangeListener(java.beans.PropertyChangeListener)
,
Constant Field Valuespublic static final String ACCESSIBLE_VISIBLE_DATA_PROPERTY
addPropertyChangeListener(java.beans.PropertyChangeListener)
,
Constant Field Valuespublic static final String ACCESSIBLE_CHILD_PROPERTY
addPropertyChangeListener(java.beans.PropertyChangeListener)
,
Constant Field Valuespublic static final String ACCESSIBLE_ACTIVE_DESCENDANT_PROPERTY
addPropertyChangeListener(java.beans.PropertyChangeListener)
,
Constant Field Valuespublic static final String ACCESSIBLE_TABLE_CAPTION_CHANGED
Accessible
,
AccessibleTable
,
Constant Field Valuespublic static final String ACCESSIBLE_TABLE_SUMMARY_CHANGED
Accessible
,
AccessibleTable
,
Constant Field Valuespublic static final String ACCESSIBLE_TABLE_MODEL_CHANGED
AccessibleTable
,
AccessibleTableModelChange
,
Constant Field Valuespublic static final String ACCESSIBLE_TABLE_ROW_HEADER_CHANGED
AccessibleTable
,
AccessibleTableModelChange
,
Constant Field Valuespublic static final String ACCESSIBLE_TABLE_ROW_DESCRIPTION_CHANGED
AccessibleTable
,
Constant Field Valuespublic static final String ACCESSIBLE_TABLE_COLUMN_HEADER_CHANGED
AccessibleTable
,
AccessibleTableModelChange
,
Constant Field Valuespublic static final String ACCESSIBLE_TABLE_COLUMN_DESCRIPTION_CHANGED
AccessibleTable
,
Constant Field Valuespublic static final String ACCESSIBLE_ACTION_PROPERTY
AccessibleAction
,
Constant Field Valuespublic static final String ACCESSIBLE_HYPERTEXT_OFFSET
AccessibleHyperlink
,
Constant Field Valuespublic static final String ACCESSIBLE_TEXT_PROPERTY
getAccessibleText()
,
addPropertyChangeListener(java.beans.PropertyChangeListener)
,
#AccessibleText.AccessibleTextSequence
,
Constant Field Valuespublic static final String ACCESSIBLE_INVALIDATE_CHILDREN
getAccessibleText()
,
addPropertyChangeListener(java.beans.PropertyChangeListener)
,
#AccessibleText.AccessibleTextSequence
,
Constant Field Valuespublic static final String ACCESSIBLE_TEXT_ATTRIBUTES_CHANGED
getAccessibleText()
,
addPropertyChangeListener(java.beans.PropertyChangeListener)
,
#AccessibleText.AccessibleAttributeSequence
,
Constant Field Valuespublic static final String ACCESSIBLE_COMPONENT_BOUNDS_CHANGED
addPropertyChangeListener(java.beans.PropertyChangeListener)
,
Constant Field Valuesprotected Accessible accessibleParent
getAccessibleParent()
,
setAccessibleParent(javax.accessibility.Accessible)
protected String accessibleName
getAccessibleName()
,
setAccessibleName(java.lang.String)
protected String accessibleDescription
getAccessibleDescription()
,
setAccessibleDescription(java.lang.String)
Constructor Detail |
---|
public AccessibleContext()
Method Detail |
---|
public String getAccessibleName()
setAccessibleName(java.lang.String)
public void setAccessibleName(String s)
s
- the new localized name of the object.getAccessibleName()
,
addPropertyChangeListener(java.beans.PropertyChangeListener)
public String getAccessibleDescription()
setAccessibleDescription(java.lang.String)
public void setAccessibleDescription(String s)
s
- the new localized description of the objectsetAccessibleName(java.lang.String)
,
addPropertyChangeListener(java.beans.PropertyChangeListener)
public abstract AccessibleRole getAccessibleRole()
Note that the AccessibleRole class is also extensible, so custom component developers can define their own AccessibleRole's if the set of predefined roles is inadequate.
AccessibleRole
public abstract AccessibleStateSet getAccessibleStateSet()
AccessibleStateSet
,
AccessibleState
,
addPropertyChangeListener(java.beans.PropertyChangeListener)
public Accessible getAccessibleParent()
public void setAccessibleParent(Accessible a)
a
- - Accessible to be set as the parentpublic abstract int getAccessibleIndexInParent()
getAccessibleParent()
,
getAccessibleChildrenCount()
,
getAccessibleChild(int)
public abstract int getAccessibleChildrenCount()
public abstract Accessible getAccessibleChild(int i)
i
- zero-based index of child
getAccessibleChildrenCount()
public abstract Locale getLocale() throws IllegalComponentStateException
IllegalComponentStateException
- If the Component does not have its own locale and has not yet been
added to a containment hierarchy such that the locale can be
determined from the containing parent.public void addPropertyChangeListener(PropertyChangeListener listener)
listener
- The PropertyChangeListener to be addedACCESSIBLE_NAME_PROPERTY
,
ACCESSIBLE_DESCRIPTION_PROPERTY
,
ACCESSIBLE_STATE_PROPERTY
,
ACCESSIBLE_VALUE_PROPERTY
,
ACCESSIBLE_SELECTION_PROPERTY
,
ACCESSIBLE_TEXT_PROPERTY
,
ACCESSIBLE_VISIBLE_DATA_PROPERTY
public void removePropertyChangeListener(PropertyChangeListener listener)
listener
- The PropertyChangeListener to be removedpublic AccessibleAction getAccessibleAction()
AccessibleAction
public AccessibleComponent getAccessibleComponent()
AccessibleComponent
public AccessibleSelection getAccessibleSelection()
AccessibleSelection
public AccessibleText getAccessibleText()
AccessibleText
public AccessibleEditableText getAccessibleEditableText()
AccessibleEditableText
public AccessibleValue getAccessibleValue()
AccessibleValue
public AccessibleIcon[] getAccessibleIcon()
AccessibleIcon
public AccessibleRelationSet getAccessibleRelationSet()
AccessibleRelationSet
public AccessibleTable getAccessibleTable()
AccessibleTable
public void firePropertyChange(String propertyName, Object oldValue, Object newValue)
propertyName
- The programmatic name of the property that
was changed.oldValue
- The old value of the property.newValue
- The new value of the property.PropertyChangeSupport
,
addPropertyChangeListener(java.beans.PropertyChangeListener)
,
removePropertyChangeListener(java.beans.PropertyChangeListener)
,
ACCESSIBLE_NAME_PROPERTY
,
ACCESSIBLE_DESCRIPTION_PROPERTY
,
ACCESSIBLE_STATE_PROPERTY
,
ACCESSIBLE_VALUE_PROPERTY
,
ACCESSIBLE_SELECTION_PROPERTY
,
ACCESSIBLE_TEXT_PROPERTY
,
ACCESSIBLE_VISIBLE_DATA_PROPERTY
|
Java™ Platform Standard Ed. 6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright 2009 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.