Class AbstractButton.AccessibleAbstractButton
java.lang.Object
javax.accessibility.AccessibleContext
java.awt.Component.AccessibleAWTComponent
java.awt.Container.AccessibleAWTContainer
javax.swing.JComponent.AccessibleJComponent
javax.swing.AbstractButton.AccessibleAbstractButton
- All Implemented Interfaces:
Serializable, AccessibleAction, AccessibleComponent, AccessibleExtendedComponent, AccessibleText, AccessibleValue
- Direct Known Subclasses:
JButton.AccessibleJButton, JMenuItem.AccessibleJMenuItem, JToggleButton.AccessibleJToggleButton
- Enclosing class:
AbstractButton
protected abstract class AbstractButton.AccessibleAbstractButton
extends JComponent.AccessibleJComponent
implements AccessibleAction, AccessibleValue, AccessibleText, AccessibleExtendedComponent
This class implements accessibility support for the
AbstractButton class. It provides an implementation of the
Java Accessibility API appropriate to button and menu item
user-interface elements.
Warning:
Serialized objects of this class will not be compatible with
future Swing releases. The current serialization support is
appropriate for short term storage or RMI between applications running
the same version of Swing. As of 1.4, support for long term storage
of all JavaBeans
has been added to the java.beans package.
Please see XMLEncoder.
- Since:
- 1.4
-
Nested Class Summary
Nested classes/interfaces declared in class JComponent.AccessibleJComponent
JComponent.AccessibleJComponent.AccessibleContainerHandler, JComponent.AccessibleJComponent.AccessibleFocusHandlerModifier and TypeClassDescriptionprotected classFire PropertyChange listener, if one is registered, when children added/removed.protected classDeprecated.This class is no longer used or needed.Nested classes/interfaces declared in class Component.AccessibleAWTComponent
Component.AccessibleAWTComponent.AccessibleAWTComponentHandler, Component.AccessibleAWTComponent.AccessibleAWTFocusHandlerModifier and TypeClassDescriptionprotected classFire PropertyChange listener, if one is registered, when shown/hidden..protected classFire PropertyChange listener, if one is registered, when focus events happen -
Field Summary
Fields declared in class JComponent.AccessibleJComponent
accessibleFocusHandlerFields declared in class Container.AccessibleAWTContainer
accessibleContainerHandlerModifier and TypeFieldDescriptionprotected ContainerListenerThe handler to firePropertyChangewhen children are added or removedFields declared in class Component.AccessibleAWTComponent
accessibleAWTComponentHandler, accessibleAWTFocusHandlerModifier and TypeFieldDescriptionprotected ComponentListenerA component listener to track show/hide/resize events and convert them to PropertyChange events.protected FocusListenerA listener to track focus events and convert them to PropertyChange events.Fields declared in class 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, accessibleParentModifier and TypeFieldDescriptionstatic final StringConstant used to indicate that the supported set of actions has changed.static final StringConstant used to determine when the active descendant of a component has changed.static final StringConstant used to determine when theaccessibleTextcaret has changed.static final StringConstant used to determine whenAccessiblechildren are added/removed from the object.static final StringPropertyChangeEventwhich indicates that a change has occurred in a component's bounds.static final StringConstant used to determine when theAccessibleContext.accessibleDescriptionproperty has changed.static final StringConstant used to indicate that a hypertext element has received focus.static final StringPropertyChangeEventwhich indicates that a significant change has occurred to the children of a component like a tree or text.static final StringConstant used to determine when theAccessibleContext.accessibleNameproperty has changed.static final StringConstant used to determine when theaccessibleSelectionhas changed.static final StringConstant used to determine when theaccessibleStateSetproperty has changed.static final StringConstant used to indicate that the table caption has changed.static final StringConstant used to indicate that the column description has changed.static final StringConstant used to indicate that the column header has changed.static final StringConstant used to indicate that table data has changed.static final StringConstant used to indicate that the row description has changed.static final StringConstant used to indicate that the row header has changed.static final StringConstant used to indicate that the table summary has changed.static final StringPropertyChangeEventwhich indicates that text attributes have changed.static final StringPropertyChangeEventwhich indicates that text has changed.static final StringConstant used to determine when theaccessibleValueproperty has changed.static final StringConstant used to determine when the visual appearance of the object has changed.protected StringA localized String containing the description of the object.protected StringA localized String containing the name of the object.protected AccessibleThe accessible parent of this object.Fields declared in interface AccessibleAction
CLICK, DECREMENT, INCREMENT, TOGGLE_EXPAND, TOGGLE_POPUPModifier and TypeFieldDescriptionstatic final StringAn action which causes a component to execute its default action.static final StringAn action which decrements a value.static final StringAn action which increments a value.static final StringAn action which causes a tree node to collapse if expanded and expand if collapsed.static final StringAn action which causes a popup to become visible if it is hidden and hidden if it is visible.Fields declared in interface AccessibleText
CHARACTER, SENTENCE, WORDModifier and TypeFieldDescriptionstatic final intConstant used to indicate that the part of the text that should be retrieved is a character.static final intConstant used to indicate that the part of the text that should be retrieved is a sentence.static final intConstant used to indicate that the part of the text that should be retrieved is a word. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructor for subclasses to call. -
Method Summary
Modifier and TypeMethodDescriptionbooleandoAccessibleAction(int i) Perform the specified Action on the objectGet the AccessibleAction associated with this object.intReturns the number of Actions available in this object.Return a description of the specified action of the object.Get the AccessibleIcons associated with this object if one or more exist.Returns key bindings associated with this objectReturns the accessible name of this object.Get the AccessibleRelationSet associated with this object if one exists.Get the state set of this object.Get the AccessibleValue associated with this object.getAfterIndex(int part, int index) Returns the String after a given index.getAtIndex(int part, int index) Returns the String at a given index.getBeforeIndex(int part, int index) Returns the String before a given index.intReturn the zero-based offset of the caret.getCharacterAttribute(int i) Return the AttributeSet for a given character at a given indexgetCharacterBounds(int i) Determine the bounding box of the character at the given index into the string.intReturn the number of characters (valid indices)Get the value of this object as a Number.intGiven a point in local coordinates, return the zero-based index of the character under that Point.Get the maximum value of this object as a Number.Get the minimum value of this object as a Number.Returns the portion of the text that is selected.intReturns the end offset within the selected text.intReturns the start offset within the selected text.Returns the titled border textReturns the tool tip textbooleanSet the value of this object as a Number.Methods declared in class JComponent.AccessibleJComponent
addPropertyChangeListener, getAccessibleChild, getAccessibleChildrenCount, getAccessibleDescription, getAccessibleRole, getBorderTitle, removePropertyChangeListenerModifier and TypeMethodDescriptionvoidAdds a PropertyChangeListener to the listener list.getAccessibleChild(int i) Returns the nth Accessible child of the object.intReturns the number of accessible children in the object.Gets the accessible description of this object.Gets the role of this object.protected StringRecursively search through the border hierarchy (if it exists) for a TitledBorder with a non-null title.voidRemoves a PropertyChangeListener from the listener list.Methods declared in class Container.AccessibleAWTContainer
getAccessibleAtModifier and TypeMethodDescriptionReturns theAccessiblechild, if one exists, contained at the local coordinatePoint.Methods declared in class Component.AccessibleAWTComponent
addFocusListener, contains, getAccessibleComponent, getAccessibleIndexInParent, getAccessibleParent, getBackground, getBounds, getCursor, getFont, getFontMetrics, getForeground, getLocale, getLocation, getLocationOnScreen, getSize, isEnabled, isFocusTraversable, isShowing, isVisible, removeFocusListener, requestFocus, setBackground, setBounds, setCursor, setEnabled, setFont, setForeground, setLocation, setSize, setVisibleModifier and TypeMethodDescriptionvoidAdds the specified focus listener to receive focus events from this component.booleanChecks 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.Gets theAccessibleComponentassociated with this object if one exists.intGets the index of this object in its accessible parent.Gets theAccessibleparent of this object.Gets the background color of this object.Gets the bounds of this object in the form of a Rectangle object.Gets theCursorof this object.getFont()Gets theFontof this object.Gets theFontMetricsof 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 aDimensionobject.booleanDetermines if the object is enabled.booleanReturns whether this object can accept focus or not.booleanDetermines if the object is showing.booleanDetermines if the object is visible.voidRemoves the specified focus listener so it no longer receives focus events from this component.voidRequests focus for this object.voidSets the background color of this object.voidSets the bounds of this object in the form of aRectangleobject.voidSets theCursorof this object.voidsetEnabled(boolean b) Sets the enabled state of the object.voidSets theFontof this object.voidSets the foreground color of this object.voidsetLocation(Point p) Sets the location of the object relative to the parent.voidResizes this object so that it has width and height.voidsetVisible(boolean b) Sets the visible state of the object.Methods declared in class AccessibleContext
firePropertyChange, getAccessibleEditableText, getAccessibleSelection, getAccessibleTable, getAccessibleText, setAccessibleDescription, setAccessibleName, setAccessibleParentModifier and TypeMethodDescriptionvoidfirePropertyChange(String propertyName, Object oldValue, Object newValue) Support for reporting bound property changes.Gets theAccessibleEditableTextassociated with this object presenting editable text on the display.Gets theAccessibleSelectionassociated with this object which allows itsAccessiblechildren to be selected.Gets theAccessibleTableassociated with an object.Gets theAccessibleTextassociated with this object presenting text on the display.voidSets the accessible description of this object.voidSets the localized accessible name of this object.voidSets theAccessibleparent of this object.Methods declared in class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitModifier and TypeMethodDescriptionprotected Objectclone()Creates and returns a copy of this object.booleanIndicates whether some other object is "equal to" this one.protected voidfinalize()Deprecated, for removal: This API element is subject to removal in a future version.Finalization is deprecated and subject to removal in a future release.final Class<?> getClass()Returns the runtime class of thisObject.inthashCode()Returns a hash code value for this object.final voidnotify()Wakes up a single thread that is waiting on this object's monitor.final voidWakes up all threads that are waiting on this object's monitor.toString()Returns a string representation of the object.final voidwait()Causes the current thread to wait until it is awakened, typically by being notified or interrupted.final voidwait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.final voidwait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
-
Constructor Details
-
AccessibleAbstractButton
protected AccessibleAbstractButton()Constructor for subclasses to call.
-
-
Method Details
-
getAccessibleName
Returns the accessible name of this object.- Overrides:
getAccessibleNamein classJComponent.AccessibleJComponent- Returns:
- the localized name of the object -- can be
nullif this object does not have a name - See Also:
-
getAccessibleIcon
Get the AccessibleIcons associated with this object if one or more exist. Otherwise return null.- Overrides:
getAccessibleIconin classAccessibleContext- Returns:
- an array of
AccessibleIconif supported by object; otherwise returnnull - Since:
- 1.3
- See Also:
-
getAccessibleStateSet
Get the state set of this object.- Overrides:
getAccessibleStateSetin classJComponent.AccessibleJComponent- Returns:
- an instance of AccessibleState containing the current state of the object
- See Also:
-
getAccessibleRelationSet
Get the AccessibleRelationSet associated with this object if one exists. Otherwise return null.- Overrides:
getAccessibleRelationSetin classAccessibleContext- Returns:
- an
AccessibleRelationSetif supported by object; otherwise returnnull - Since:
- 1.3
- See Also:
-
getAccessibleAction
Get the AccessibleAction associated with this object. In the implementation of the Java Accessibility API for this class, return this object, which is responsible for implementing the AccessibleAction interface on behalf of itself.- Overrides:
getAccessibleActionin classAccessibleContext- Returns:
- this object
- See Also:
-
getAccessibleValue
Get the AccessibleValue associated with this object. In the implementation of the Java Accessibility API for this class, return this object, which is responsible for implementing the AccessibleValue interface on behalf of itself.- Overrides:
getAccessibleValuein classAccessibleContext- Returns:
- this object
- See Also:
-
getAccessibleActionCount
public int getAccessibleActionCount()Returns the number of Actions available in this object. The default behavior of a button is to have one action - toggle the button.- Specified by:
getAccessibleActionCountin interfaceAccessibleAction- Returns:
- 1, the number of Actions in this object
-
getAccessibleActionDescription
Return a description of the specified action of the object.- Specified by:
getAccessibleActionDescriptionin interfaceAccessibleAction- Parameters:
i- zero-based index of the actions- Returns:
- a
Stringdescription of the action - See Also:
-
doAccessibleAction
public boolean doAccessibleAction(int i) Perform the specified Action on the object- Specified by:
doAccessibleActionin interfaceAccessibleAction- Parameters:
i- zero-based index of actions- Returns:
- true if the action was performed; else false.
- See Also:
-
getCurrentAccessibleValue
Get the value of this object as a Number.- Specified by:
getCurrentAccessibleValuein interfaceAccessibleValue- Returns:
- An Integer of 0 if this isn't selected or an Integer of 1 if this is selected.
- See Also:
-
setCurrentAccessibleValue
Set the value of this object as a Number.- Specified by:
setCurrentAccessibleValuein interfaceAccessibleValue- Parameters:
n- the number to use for the value- Returns:
- True if the value was set.
- See Also:
-
getMinimumAccessibleValue
Get the minimum value of this object as a Number.- Specified by:
getMinimumAccessibleValuein interfaceAccessibleValue- Returns:
- an Integer of 0.
- See Also:
-
getMaximumAccessibleValue
Get the maximum value of this object as a Number.- Specified by:
getMaximumAccessibleValuein interfaceAccessibleValue- Returns:
- An Integer of 1.
- See Also:
-
getIndexAtPoint
Given a point in local coordinates, return the zero-based index of the character under that Point. If the point is invalid, this method returns -1. Note: the AbstractButton must have a valid size (e.g. have been added to a parent container whose ancestor container is a valid top-level window) for this method to be able to return a meaningful value.- Specified by:
getIndexAtPointin interfaceAccessibleText- Parameters:
p- the Point in local coordinates- Returns:
- the zero-based index of the character under Point p; if Point is invalid returns -1.
- Since:
- 1.3
-
getCharacterBounds
Determine the bounding box of the character at the given index into the string. The bounds are returned in local coordinates. If the index is invalid an empty rectangle is returned. Note: the AbstractButton must have a valid size (e.g. have been added to a parent container whose ancestor container is a valid top-level window) for this method to be able to return a meaningful value.- Specified by:
getCharacterBoundsin interfaceAccessibleText- Parameters:
i- the index into the String- Returns:
- the screen coordinates of the character's the bounding box, if index is invalid returns an empty rectangle.
- Since:
- 1.3
-
getCharCount
public int getCharCount()Return the number of characters (valid indices)- Specified by:
getCharCountin interfaceAccessibleText- Returns:
- the number of characters
- Since:
- 1.3
-
getCaretPosition
public int getCaretPosition()Return the zero-based offset of the caret. Note: That to the right of the caret will have the same index value as the offset (the caret is between two characters).- Specified by:
getCaretPositionin interfaceAccessibleText- Returns:
- the zero-based offset of the caret.
- Since:
- 1.3
-
getAtIndex
Returns the String at a given index.- Specified by:
getAtIndexin interfaceAccessibleText- Parameters:
part- the AccessibleText.CHARACTER, AccessibleText.WORD, or AccessibleText.SENTENCE to retrieveindex- an index within the text >= 0- Returns:
- the letter, word, or sentence, null for an invalid index or part
- Since:
- 1.3
-
getAfterIndex
Returns the String after a given index.- Specified by:
getAfterIndexin interfaceAccessibleText- Parameters:
part- the AccessibleText.CHARACTER, AccessibleText.WORD, or AccessibleText.SENTENCE to retrieveindex- an index within the text >= 0- Returns:
- the letter, word, or sentence, null for an invalid index or part
- Since:
- 1.3
-
getBeforeIndex
Returns the String before a given index.- Specified by:
getBeforeIndexin interfaceAccessibleText- Parameters:
part- the AccessibleText.CHARACTER, AccessibleText.WORD, or AccessibleText.SENTENCE to retrieveindex- an index within the text >= 0- Returns:
- the letter, word, or sentence, null for an invalid index or part
- Since:
- 1.3
-
getCharacterAttribute
Return the AttributeSet for a given character at a given index- Specified by:
getCharacterAttributein interfaceAccessibleText- Parameters:
i- the zero-based index into the text- Returns:
- the AttributeSet of the character
- Since:
- 1.3
-
getSelectionStart
public int getSelectionStart()Returns the start offset within the selected text. If there is no selection, but there is a caret, the start and end offsets will be the same.- Specified by:
getSelectionStartin interfaceAccessibleText- Returns:
- the index into the text of the start of the selection
- Since:
- 1.3
-
getSelectionEnd
public int getSelectionEnd()Returns the end offset within the selected text. If there is no selection, but there is a caret, the start and end offsets will be the same.- Specified by:
getSelectionEndin interfaceAccessibleText- Returns:
- the index into the text of the end of the selection
- Since:
- 1.3
-
getSelectedText
Returns the portion of the text that is selected.- Specified by:
getSelectedTextin interfaceAccessibleText- Returns:
- the String portion of the text that is selected
- Since:
- 1.3
-
getToolTipText
Returns the tool tip text- Specified by:
getToolTipTextin interfaceAccessibleExtendedComponent- Overrides:
getToolTipTextin classJComponent.AccessibleJComponent- Returns:
- the tool tip text, if supported, of the object; otherwise, null
- Since:
- 1.4
-
getTitledBorderText
Returns the titled border text- Specified by:
getTitledBorderTextin interfaceAccessibleExtendedComponent- Overrides:
getTitledBorderTextin classJComponent.AccessibleJComponent- Returns:
- the titled border text, if supported, of the object; otherwise, null
- Since:
- 1.4
-
getAccessibleKeyBinding
Returns key bindings associated with this object- Specified by:
getAccessibleKeyBindingin interfaceAccessibleExtendedComponent- Overrides:
getAccessibleKeyBindingin classJComponent.AccessibleJComponent- Returns:
- the key bindings, if supported, of the object; otherwise, null
- Since:
- 1.4
- See Also:
-