javax.accessibility
Class AccessibleContext
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:
clone , equals , extends Object> getClass , finalize , hashCode , notify , notifyAll , toString , wait , wait , wait |
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.
- "accessibleActionProperty"
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.
- "AccessibleActiveDescendant"
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.
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.
ACCESSIBLE_COMPONENT_BOUNDS_CHANGED
public static final String ACCESSIBLE_COMPONENT_BOUNDS_CHANGED
Constant used when a component's bounds have changed. The old and
new bounds are given in the event.
- "accessibleComponentBoundsChanged"
ACCESSIBLE_DESCRIPTION_PROPERTY
public static final String ACCESSIBLE_DESCRIPTION_PROPERTY
Constant used when the accessible description has changed. Both the old
and new values are listed in the event.
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.
- "AccessibleHypertextOffset"
ACCESSIBLE_INVALIDATE_CHILDREN
public static final String ACCESSIBLE_INVALIDATE_CHILDREN
Constant used when the state of child objects changes. The old
value in the event is always null, and the new value is the component
whose children have changed.
- "accessibleInvalidateChildren"
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.
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.
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.
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.
- "accessibleTableCaptionChanged"
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.
- "accessibleTableColumnDescriptionChanged"
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.
- "accessibleTableColumnHeaderChanged"
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.
- "accessibleTableModelChanged"
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.
- "accessibleTableRowDescriptionChanged"
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.
- "accessibleTableRowHeaderChanged"
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.
- "accessibleTableSummaryChanged"
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.
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.
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.
firePropertyChange
public void firePropertyChange(String name,
Object oldValue,
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.
name
- the property nameoldValue
- the prior valuenewValue
- the updated value
getAccessibleChild
public abstract Accessible getAccessibleChild(int i)
Returns the specified accessible chile.
i
- the 0-based index to get
- the child, or null if out of bounds
getAccessibleChildrenCount
public abstract int getAccessibleChildrenCount()
Returns the number of accessible children of this object.
- the number of accessible children
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.
- the accessible object's description, or null if there is none
getAccessibleIcon
public AccessibleIcon[] getAccessibleIcon()
Get all supported accessible icons. The default implementation returns
null.
- the supported icons, or null
getAccessibleIndexInParent
public abstract int getAccessibleIndexInParent()
Gets the index of this object within its accessible parent.
- the 0-based index, or -1 if there is no accessible parent
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.
- the accessible object's name, or null if it is unnamed
getAccessibleParent
public Accessible getAccessibleParent()
Return the accessible parent of this object.
- the accessible parent, or null if there is none
getAccessibleRelationSet
public AccessibleRelationSet getAccessibleRelationSet()
Get any supported accessible relation set. The default implementation
returns an empty AccessibleRelationSet.
- the supported relation set, or
null
getAccessibleRole
public abstract 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.
getAccessibleStateSet
public abstract 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.
- the current state of the object
getAccessibleTable
public AccessibleTable getAccessibleTable()
Get any supported accessible table. The default implementation returns
null.
- the supported table, or null
getAccessibleText
public AccessibleText getAccessibleText()
Get any supported accessible text. The default implementation returns
null.
- the supported text, or null
getAccessibleValue
public AccessibleValue getAccessibleValue()
Get any supported accessible value. The default implementation returns
null.
- the supported value, or null
getLocale
public abstract Locale getLocale()
Gets the component locale, deferring to the parent if one is not declared.
setAccessibleDescription
public void setAccessibleDescription(String s)
Set the localized name of the object. This will fire a
PropertyChangeEvent with ACCESSIBLE_DESCRIPTION_PROPERTY.
setAccessibleName
public void setAccessibleName(String s)
Set the localized name of the object. This will fire a
PropertyChangeEvent with ACCESSIBLE_NAME_PROPERTY.
setAccessibleParent
public void setAccessibleParent(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.
AccessibleContext.java -- the context of an accessible object
Copyright (C) 2002 Free Software Foundation
This file is part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.
Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module. An independent module is a module which is not derived from
or based on this library. If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so. If you do not wish to do so, delete this
exception statement from your version.