javax.swing

Class AbstractButton.AccessibleAbstractButton

Enclosing Class:
AbstractButton
Implemented Interfaces:
AccessibleAction, AccessibleComponent, AccessibleExtendedComponent, AccessibleText, AccessibleValue, Serializable
Known Direct Subclasses:
JButton.AccessibleJButton, JMenuItem.AccessibleJMenuItem, JToggleButton.AccessibleJToggleButton

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 JavaBeansTM has been added to the java.beans package. Please see XMLEncoder.

See Also:
Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent.AccessibleJComponent

JComponent.AccessibleJComponent.AccessibleContainerHandler, JComponent.AccessibleJComponent.AccessibleFocusHandler

Nested classes/interfaces inherited from class java.awt.Container.AccessibleAWTContainer

Container.AccessibleAWTContainer.AccessibleContainerHandler

Nested classes/interfaces inherited from class java.awt.Component.AccessibleAWTComponent

Component.AccessibleAWTComponent.AccessibleAWTComponentHandler, Component.AccessibleAWTComponent.AccessibleAWTFocusHandler

Field Summary

Fields inherited from class javax.swing.JComponent.AccessibleJComponent

accessibleContainerHandler, accessibleFocusHandler

Fields inherited from class java.awt.Container.AccessibleAWTContainer

accessibleContainerHandler

Fields inherited from class java.awt.Component.AccessibleAWTComponent

accessibleAWTComponentHandler, accessibleAWTFocusHandler

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

Fields inherited from interface javax.accessibility.AccessibleAction

DECREMENT, INCREMENT, TOGGLE_EXPAND

Fields inherited from interface javax.accessibility.AccessibleText

CHARACTER, SENTENCE, WORD

Method Summary

boolean
doAccessibleAction(int i)
Perform the specified Action on the object
AccessibleAction
getAccessibleAction()
Get the AccessibleAction associated with this object.
int
getAccessibleActionCount()
Returns the number of Actions available in this object.
String
getAccessibleActionDescription(int i)
Return a description of the specified action of the object.
AccessibleIcon[]
getAccessibleIcon()
Get the AccessibleIcons associated with this object if one or more exist.
AccessibleKeyBinding
getAccessibleKeyBinding()
Returns key bindings associated with this object
String
getAccessibleName()
Returns the accessible name of this object.
AccessibleRelationSet
getAccessibleRelationSet()
Get the AccessibleRelationSet associated with this object if one exists.
AccessibleStateSet
getAccessibleStateSet()
Get the state set of this object.
AccessibleText
getAccessibleText()
AccessibleValue
getAccessibleValue()
Get the AccessibleValue associated with this object.
String
getAfterIndex(int part, int index)
Returns the String after a given index.
String
getAtIndex(int part, int index)
Returns the String at a given index.
String
getBeforeIndex(int part, int index)
Returns the String before a given index.
int
getCaretPosition()
Return the zero-based offset of the caret.
int
getCharCount()
Return the number of characters (valid indicies)
AttributeSet
getCharacterAttribute(int i)
Return the AttributeSet for a given character at a given index
Rectangle
getCharacterBounds(int i)
Determine the bounding box of the character at the given index into the string.
Number
getCurrentAccessibleValue()
Get the value of this object as a Number.
int
getIndexAtPoint(Point p)
Given a point in local coordinates, return the zero-based index of the character under that Point.
Number
getMaximumAccessibleValue()
Get the maximum value of this object as a Number.
Number
getMinimumAccessibleValue()
Get the minimum value of this object as a Number.
String
getSelectedText()
Returns the portion of the text that is selected.
int
getSelectionEnd()
Returns the end offset within the selected text.
int
getSelectionStart()
Returns the start offset within the selected text.
String
getTitledBorderText()
Returns the titled border text
String
getToolTipText()
Returns the tool tip text
boolean
setCurrentAccessibleValue(Number n)
Set the value of this object as a Number.

Methods inherited from class javax.swing.JComponent.AccessibleJComponent

addPropertyChangeListener, getAccessibleChild, getAccessibleChildrenCount, getAccessibleDescription, getAccessibleKeyBinding, getAccessibleName, getAccessibleRole, getAccessibleStateSet, getBorderTitle, getTitledBorderText, getToolTipText, removePropertyChangeListener

Methods inherited from class java.awt.Container.AccessibleAWTContainer

addPropertyChangeListener, getAccessibleAt, getAccessibleChild, getAccessibleChildrenCount

Methods inherited from class java.awt.Component.AccessibleAWTComponent

addFocusListener, addPropertyChangeListener, contains, getAccessibleAt, getAccessibleChild, getAccessibleChildrenCount, getAccessibleComponent, getAccessibleDescription, getAccessibleIndexInParent, getAccessibleName, getAccessibleParent, getAccessibleRole, getAccessibleStateSet, getBackground, getBounds, getCursor, getFont, getFontMetrics, getForeground, getLocale, getLocation, getLocationOnScreen, getSize, isEnabled, isFocusTraversable, isShowing, isVisible, removeFocusListener, removePropertyChangeListener, requestFocus, setBackground, setBounds, setCursor, setEnabled, setFont, setForeground, setLocation, setSize, setVisible

Methods inherited from class javax.accessibility.AccessibleContext

addPropertyChangeListener, firePropertyChange, getAccessibleAction, getAccessibleChild, getAccessibleChildrenCount, getAccessibleComponent, getAccessibleDescription, getAccessibleEditableText, getAccessibleIcon, getAccessibleIndexInParent, getAccessibleName, getAccessibleParent, getAccessibleRelationSet, getAccessibleRole, getAccessibleSelection, getAccessibleStateSet, getAccessibleTable, getAccessibleText, getAccessibleValue, getLocale, removePropertyChangeListener, setAccessibleDescription, setAccessibleName, setAccessibleParent

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

doAccessibleAction

public boolean doAccessibleAction(int i)
Perform the specified Action on the object
Specified by:
doAccessibleAction in interface AccessibleAction
Parameters:
i - zero-based index of actions
Returns:
true if the the action was performed; else false.

getAccessibleAction

public AccessibleAction 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:
getAccessibleAction in interface AccessibleContext
Returns:
this object

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:
getAccessibleActionCount in interface AccessibleAction
Returns:
1, the number of Actions in this object

getAccessibleActionDescription

public String getAccessibleActionDescription(int i)
Return a description of the specified action of the object.
Specified by:
getAccessibleActionDescription in interface AccessibleAction
Parameters:
i - zero-based index of the actions

getAccessibleIcon

public AccessibleIcon[] getAccessibleIcon()
Get the AccessibleIcons associated with this object if one or more exist. Otherwise return null.
Overrides:
getAccessibleIcon in interface AccessibleContext

getAccessibleKeyBinding

public AccessibleKeyBinding getAccessibleKeyBinding()
Returns key bindings associated with this object
Specified by:
getAccessibleKeyBinding in interface AccessibleExtendedComponent
Overrides:
getAccessibleKeyBinding in interface JComponent.AccessibleJComponent
Returns:
the key bindings, if supported, of the object; otherwise, null

getAccessibleName

public String getAccessibleName()
Returns the accessible name of this object.
Overrides:
getAccessibleName in interface JComponent.AccessibleJComponent
Returns:
the localized name of the object -- can be null if this object does not have a name

getAccessibleRelationSet

public AccessibleRelationSet getAccessibleRelationSet()
Get the AccessibleRelationSet associated with this object if one exists. Otherwise return null.
Overrides:
getAccessibleRelationSet in interface AccessibleContext

getAccessibleStateSet

public AccessibleStateSet getAccessibleStateSet()
Get the state set of this object.
Overrides:
getAccessibleStateSet in interface JComponent.AccessibleJComponent
Returns:
an instance of AccessibleState containing the current state of the object

getAccessibleText

public AccessibleText getAccessibleText()
Overrides:
getAccessibleText in interface AccessibleContext

getAccessibleValue

public AccessibleValue 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:
getAccessibleValue in interface AccessibleContext
Returns:
this object

getAfterIndex

public String getAfterIndex(int part,
                            int index)
Returns the String after a given index.
Specified by:
getAfterIndex in interface AccessibleText
Parameters:
part - the AccessibleText.CHARACTER, AccessibleText.WORD, or AccessibleText.SENTENCE to retrieve
index - an index within the text >= 0
Returns:
the letter, word, or sentence, null for an invalid index or part

getAtIndex

public String getAtIndex(int part,
                         int index)
Returns the String at a given index.
Specified by:
getAtIndex in interface AccessibleText
Parameters:
part - the AccessibleText.CHARACTER, AccessibleText.WORD, or AccessibleText.SENTENCE to retrieve
index - an index within the text >= 0
Returns:
the letter, word, or sentence, null for an invalid index or part

getBeforeIndex

public String getBeforeIndex(int part,
                             int index)
Returns the String before a given index.
Specified by:
getBeforeIndex in interface AccessibleText
Parameters:
part - the AccessibleText.CHARACTER, AccessibleText.WORD, or AccessibleText.SENTENCE to retrieve
index - an index within the text >= 0
Returns:
the letter, word, or sentence, null for an invalid index or part

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:
getCaretPosition in interface AccessibleText
Returns:
the zero-based offset of the caret.

getCharCount

public int getCharCount()
Return the number of characters (valid indicies)
Specified by:
getCharCount in interface AccessibleText
Returns:
the number of characters

getCharacterAttribute

public AttributeSet getCharacterAttribute(int i)
Return the AttributeSet for a given character at a given index
Specified by:
getCharacterAttribute in interface AccessibleText
Parameters:
i - the zero-based index into the text
Returns:
the AttributeSet of the character

getCharacterBounds

public Rectangle getCharacterBounds(int i)
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:
getCharacterBounds in interface AccessibleText
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.

getCurrentAccessibleValue

public Number getCurrentAccessibleValue()
Get the value of this object as a Number.
Specified by:
getCurrentAccessibleValue in interface AccessibleValue
Returns:
An Integer of 0 if this isn't selected or an Integer of 1 if this is selected.

getIndexAtPoint

public int getIndexAtPoint(Point p)
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:
getIndexAtPoint in interface AccessibleText
Parameters:
p - the Point in local coordinates
Returns:
the zero-based index of the character under Point p; if Point is invalid returns -1.

getMaximumAccessibleValue

public Number getMaximumAccessibleValue()
Get the maximum value of this object as a Number.
Specified by:
getMaximumAccessibleValue in interface AccessibleValue
Returns:
An Integer of 1.

getMinimumAccessibleValue

public Number getMinimumAccessibleValue()
Get the minimum value of this object as a Number.
Specified by:
getMinimumAccessibleValue in interface AccessibleValue
Returns:
an Integer of 0.

getSelectedText

public String getSelectedText()
Returns the portion of the text that is selected.
Specified by:
getSelectedText in interface AccessibleText
Returns:
the String portion of the text that is selected

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:
getSelectionEnd in interface AccessibleText
Returns:
the index into teh text of the end of the selection

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:
getSelectionStart in interface AccessibleText
Returns:
the index into the text of the start of the selection

getTitledBorderText

public String getTitledBorderText()
Returns the titled border text
Specified by:
getTitledBorderText in interface AccessibleExtendedComponent
Overrides:
getTitledBorderText in interface JComponent.AccessibleJComponent
Returns:
the titled border text, if supported, of the object; otherwise, null

getToolTipText

public String getToolTipText()
Returns the tool tip text
Specified by:
getToolTipText in interface AccessibleExtendedComponent
Overrides:
getToolTipText in interface JComponent.AccessibleJComponent
Returns:
the tool tip text, if supported, of the object; otherwise, null

setCurrentAccessibleValue

public boolean setCurrentAccessibleValue(Number n)
Set the value of this object as a Number.
Specified by:
setCurrentAccessibleValue in interface AccessibleValue
Returns:
True if the value was set.