AbstractButton.AccessibleAbstractButton (Java 2 Platform SE 5.0) (original) (raw)

javax.swing

Class AbstractButton.AccessibleAbstractButton

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

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.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.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 class javax.accessibility.AccessibleContext

Fields inherited from interface javax.accessibility.AccessibleAction
DECREMENT, INCREMENT, TOGGLE_EXPAND

Fields inherited from interface javax.accessibility.AccessibleText
CHARACTER, SENTENCE, WORD

Constructor Summary
protected	AbstractButton.AccessibleAbstractButton()

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() Gets the AccessibleText associated with this object presenting text on the display.
AccessibleValue	getAccessibleValue() Get the AccessibleValue associated with this object.
String	[getAfterIndex](../../javax/swing/AbstractButton.AccessibleAbstractButton.html#getAfterIndex%28int, int%29)(int part, int index) Returns the String after a given index.
String	[getAtIndex](../../javax/swing/AbstractButton.AccessibleAbstractButton.html#getAtIndex%28int, int%29)(int part, int index) Returns the String at a given index.
String	[getBeforeIndex](../../javax/swing/AbstractButton.AccessibleAbstractButton.html#getBeforeIndex%28int, int%29)(int part, int index) Returns the String before a given index.
int	getCaretPosition() Return the zero-based offset of the caret.
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.
int	getCharCount() Return the number of characters (valid indicies)
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, getAccessibleRole, getBorderTitle, removePropertyChangeListener

Methods inherited from class java.awt.Container.AccessibleAWTContainer
getAccessibleAt

Methods inherited from class java.awt.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, setVisible

Methods inherited from class java.awt.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, setVisible

Methods inherited from class javax.accessibility.AccessibleContext
[firePropertyChange](../../javax/accessibility/AccessibleContext.html#firePropertyChange%28java.lang.String, java.lang.Object, java.lang.Object%29), getAccessibleEditableText, getAccessibleSelection, getAccessibleTable, setAccessibleDescription, setAccessibleName, setAccessibleParent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../java/lang/Object.html#wait%28long, int%29)

Methods inherited from interface javax.accessibility.AccessibleComponent
addFocusListener, contains, getAccessibleAt, getBackground, getBounds, getCursor, getFont, getFontMetrics, getForeground, getLocation, getLocationOnScreen, getSize, isEnabled, isFocusTraversable, isShowing, isVisible, removeFocusListener, requestFocus, setBackground, setBounds, setCursor, setEnabled, setFont, setForeground, setLocation, setSize, setVisible

Constructor Detail

AbstractButton.AccessibleAbstractButton

protected AbstractButton.AccessibleAbstractButton()

Method Detail

getAccessibleName

public String getAccessibleName()

Returns the accessible name of this object.

Overrides:

[getAccessibleName](../../javax/swing/JComponent.AccessibleJComponent.html#getAccessibleName%28%29) in class [JComponent.AccessibleJComponent](../../javax/swing/JComponent.AccessibleJComponent.html "class in javax.swing")

Returns:

the localized name of the object -- can be null if this object does not have a name

getAccessibleIcon

public AccessibleIcon[] getAccessibleIcon()

Get the AccessibleIcons associated with this object if one or more exist. Otherwise return null.

Overrides:

[getAccessibleIcon](../../javax/accessibility/AccessibleContext.html#getAccessibleIcon%28%29) in class [AccessibleContext](../../javax/accessibility/AccessibleContext.html "class in javax.accessibility")

Returns:

an array of AccessibleIcon if supported by object; otherwise return null

See Also:

AccessibleIcon

getAccessibleStateSet

public AccessibleStateSet getAccessibleStateSet()

Get the state set of this object.

Overrides:

[getAccessibleStateSet](../../javax/swing/JComponent.AccessibleJComponent.html#getAccessibleStateSet%28%29) in class [JComponent.AccessibleJComponent](../../javax/swing/JComponent.AccessibleJComponent.html "class in javax.swing")

Returns:

an instance of AccessibleState containing the current state of the object

See Also:

AccessibleState

getAccessibleRelationSet

public AccessibleRelationSet getAccessibleRelationSet()

Get the AccessibleRelationSet associated with this object if one exists. Otherwise return null.

Overrides:

[getAccessibleRelationSet](../../javax/accessibility/AccessibleContext.html#getAccessibleRelationSet%28%29) in class [AccessibleContext](../../javax/accessibility/AccessibleContext.html "class in javax.accessibility")

Returns:

an AccessibleRelationSet if supported by object; otherwise return null

See Also:

AccessibleRelation

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](../../javax/accessibility/AccessibleContext.html#getAccessibleAction%28%29) in class [AccessibleContext](../../javax/accessibility/AccessibleContext.html "class in javax.accessibility")

Returns:

this object

See Also:

AccessibleAction

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](../../javax/accessibility/AccessibleContext.html#getAccessibleValue%28%29) in class [AccessibleContext](../../javax/accessibility/AccessibleContext.html "class in javax.accessibility")

Returns:

this object

See Also:

AccessibleValue

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](../../javax/accessibility/AccessibleAction.html#getAccessibleActionCount%28%29) in interface [AccessibleAction](../../javax/accessibility/AccessibleAction.html "interface in javax.accessibility")

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](../../javax/accessibility/AccessibleAction.html#getAccessibleActionDescription%28int%29) in interface [AccessibleAction](../../javax/accessibility/AccessibleAction.html "interface in javax.accessibility")

Parameters:

i - zero-based index of the actions

Returns:

a String description of the action

doAccessibleAction

public boolean doAccessibleAction(int i)

Perform the specified Action on the object

Specified by:

[doAccessibleAction](../../javax/accessibility/AccessibleAction.html#doAccessibleAction%28int%29) in interface [AccessibleAction](../../javax/accessibility/AccessibleAction.html "interface in javax.accessibility")

Parameters:

i - zero-based index of actions

Returns:

true if the the action was performed; else false.

getCurrentAccessibleValue

public Number getCurrentAccessibleValue()

Get the value of this object as a Number.

Specified by:

[getCurrentAccessibleValue](../../javax/accessibility/AccessibleValue.html#getCurrentAccessibleValue%28%29) in interface [AccessibleValue](../../javax/accessibility/AccessibleValue.html "interface in javax.accessibility")

Returns:

An Integer of 0 if this isn't selected or an Integer of 1 if this is selected.

See Also:

AbstractButton.isSelected()

setCurrentAccessibleValue

public boolean setCurrentAccessibleValue(Number n)

Set the value of this object as a Number.

Specified by:

[setCurrentAccessibleValue](../../javax/accessibility/AccessibleValue.html#setCurrentAccessibleValue%28java.lang.Number%29) in interface [AccessibleValue](../../javax/accessibility/AccessibleValue.html "interface in javax.accessibility")

Returns:

True if the value was set.

getMinimumAccessibleValue

public Number getMinimumAccessibleValue()

Get the minimum value of this object as a Number.

Specified by:

[getMinimumAccessibleValue](../../javax/accessibility/AccessibleValue.html#getMinimumAccessibleValue%28%29) in interface [AccessibleValue](../../javax/accessibility/AccessibleValue.html "interface in javax.accessibility")

Returns:

an Integer of 0.

getMaximumAccessibleValue

public Number getMaximumAccessibleValue()

Get the maximum value of this object as a Number.

Specified by:

[getMaximumAccessibleValue](../../javax/accessibility/AccessibleValue.html#getMaximumAccessibleValue%28%29) in interface [AccessibleValue](../../javax/accessibility/AccessibleValue.html "interface in javax.accessibility")

Returns:

An Integer of 1.

getAccessibleText

public AccessibleText getAccessibleText()

Description copied from class: [AccessibleContext](../../javax/accessibility/AccessibleContext.html#getAccessibleText%28%29)

Gets the AccessibleText associated with this object presenting text on the display.

Overrides:

[getAccessibleText](../../javax/accessibility/AccessibleContext.html#getAccessibleText%28%29) in class [AccessibleContext](../../javax/accessibility/AccessibleContext.html "class in javax.accessibility")

Returns:

AccessibleText if supported by object; else return null

See Also:

AccessibleText

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](../../javax/accessibility/AccessibleText.html#getIndexAtPoint%28java.awt.Point%29) in interface [AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")

Parameters:

p - the Point in local coordinates

Returns:

the zero-based index of the character under Point p; if Point is invalid returns -1.

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](../../javax/accessibility/AccessibleText.html#getCharacterBounds%28int%29) in interface [AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")

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.

getCharCount

public int getCharCount()

Return the number of characters (valid indicies)

Specified by:

[getCharCount](../../javax/accessibility/AccessibleText.html#getCharCount%28%29) in interface [AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")

Returns:

the number of characters

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](../../javax/accessibility/AccessibleText.html#getCaretPosition%28%29) in interface [AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")

Returns:

the zero-based offset of the caret.

getAtIndex

public String getAtIndex(int part, int index)

Returns the String at a given index.

Specified by:

[getAtIndex](../../javax/accessibility/AccessibleText.html#getAtIndex%28int, int%29) in interface [AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")

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

getAfterIndex

public String getAfterIndex(int part, int index)

Returns the String after a given index.

Specified by:

[getAfterIndex](../../javax/accessibility/AccessibleText.html#getAfterIndex%28int, int%29) in interface [AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")

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](../../javax/accessibility/AccessibleText.html#getBeforeIndex%28int, int%29) in interface [AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")

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

getCharacterAttribute

public AttributeSet getCharacterAttribute(int i)

Return the AttributeSet for a given character at a given index

Specified by:

[getCharacterAttribute](../../javax/accessibility/AccessibleText.html#getCharacterAttribute%28int%29) in interface [AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")

Parameters:

i - the zero-based index into the text

Returns:

the AttributeSet of the character

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](../../javax/accessibility/AccessibleText.html#getSelectionStart%28%29) in interface [AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")

Returns:

the index into the text of the start of the selection

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](../../javax/accessibility/AccessibleText.html#getSelectionEnd%28%29) in interface [AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")

Returns:

the index into teh text of the end of the selection

getSelectedText

public String getSelectedText()

Returns the portion of the text that is selected.

Specified by:

[getSelectedText](../../javax/accessibility/AccessibleText.html#getSelectedText%28%29) in interface [AccessibleText](../../javax/accessibility/AccessibleText.html "interface in javax.accessibility")

Returns:

the String portion of the text that is selected

getToolTipText

public String getToolTipText()

Returns the tool tip text

Specified by:

[getToolTipText](../../javax/accessibility/AccessibleExtendedComponent.html#getToolTipText%28%29) in interface [AccessibleExtendedComponent](../../javax/accessibility/AccessibleExtendedComponent.html "interface in javax.accessibility")

Overrides:

[getToolTipText](../../javax/swing/JComponent.AccessibleJComponent.html#getToolTipText%28%29) in class [JComponent.AccessibleJComponent](../../javax/swing/JComponent.AccessibleJComponent.html "class in javax.swing")

Returns:

the tool tip text, if supported, of the object; otherwise, null

getTitledBorderText

public String getTitledBorderText()

Returns the titled border text

Specified by:

[getTitledBorderText](../../javax/accessibility/AccessibleExtendedComponent.html#getTitledBorderText%28%29) in interface [AccessibleExtendedComponent](../../javax/accessibility/AccessibleExtendedComponent.html "interface in javax.accessibility")

Overrides:

[getTitledBorderText](../../javax/swing/JComponent.AccessibleJComponent.html#getTitledBorderText%28%29) in class [JComponent.AccessibleJComponent](../../javax/swing/JComponent.AccessibleJComponent.html "class in javax.swing")

Returns:

the titled border text, if supported, of the object; otherwise, null

getAccessibleKeyBinding

public AccessibleKeyBinding getAccessibleKeyBinding()

Returns key bindings associated with this object

Specified by:

[getAccessibleKeyBinding](../../javax/accessibility/AccessibleExtendedComponent.html#getAccessibleKeyBinding%28%29) in interface [AccessibleExtendedComponent](../../javax/accessibility/AccessibleExtendedComponent.html "interface in javax.accessibility")

Overrides:

[getAccessibleKeyBinding](../../javax/swing/JComponent.AccessibleJComponent.html#getAccessibleKeyBinding%28%29) in class [JComponent.AccessibleJComponent](../../javax/swing/JComponent.AccessibleJComponent.html "class in javax.swing")

Returns:

the key bindings, if supported, of the object; otherwise, null

See Also:

AccessibleKeyBinding

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.