javax.swing
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^TM has been added to the java.beans package. Please see {@link java.beans.XMLEncoder}.

AbstractButton.AccessibleAbstractButton

protected AbstractButton.AccessibleAbstractButton()

doAccessibleAction

public boolean doAccessibleAction(int i)

Perform the specified Action on the object

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 class 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.

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.

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 class AccessibleContext

getAccessibleKeyBinding

public AccessibleKeyBinding getAccessibleKeyBinding()

Returns key bindings associated with this object

Overrides:

getAccessibleKeyBinding in class 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 class 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 class AccessibleContext

getAccessibleStateSet

public AccessibleStateSet getAccessibleStateSet()

Get the state set of this object.

Overrides:

getAccessibleStateSet in class JComponent.AccessibleJComponent

Returns:

an instance of AccessibleState containing the current state of the object

getAccessibleText

public AccessibleText getAccessibleText()

Overrides:

getAccessibleText in class 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 class AccessibleContext

Returns:

this object

getAfterIndex

public String getAfterIndex(int part,
                            int index)

Returns the String after a given index.

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.

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.

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).

Returns:

the zero-based offset of the caret.

getCharacterAttribute

public AttributeSet getCharacterAttribute(int i)

Return the AttributeSet for a given character at a given index

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.

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)

Returns:

the number of characters

getCurrentAccessibleValue

public Number getCurrentAccessibleValue()

Get the value of this object as a Number.

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.

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.

Returns:

An Integer of 1.

getMinimumAccessibleValue

public Number getMinimumAccessibleValue()

Get the minimum value of this object as a Number.

Returns:

an Integer of 0.

getSelectedText

public String getSelectedText()

Returns the portion of the text that is selected.

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.

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.

Returns:

the index into the text of the start of the selection

getTitledBorderText

public String getTitledBorderText()

Returns the titled border text

Overrides:

getTitledBorderText in class JComponent.AccessibleJComponent

Returns:

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

getToolTipText

public String getToolTipText()

Returns the tool tip text

Overrides:

getToolTipText in class 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.

Parameters:

n

Returns:

True if the value was set.