javax.accessibility
Interface AccessibleAction

All Known Implementing Classes:
AbstractButton.AccessibleAbstractButton, AccessibleHyperlink, Button.AccessibleAWTButton, Checkbox.AccessibleAWTCheckbox, CheckboxMenuItem.AccessibleAWTCheckboxMenuItem, Choice.AccessibleAWTChoice, JButton.AccessibleJButton, JCheckBox.AccessibleJCheckBox, JCheckBoxMenuItem.AccessibleJCheckBoxMenuItem, JComboBox.AccessibleJComboBox, JEditorPane.AccessibleJEditorPane, JEditorPane.AccessibleJEditorPaneHTML, JEditorPane.JEditorPaneAccessibleHypertextSupport, JEditorPane.JEditorPaneAccessibleHypertextSupport.HTMLLink, JMenu.AccessibleJMenu, JMenuItem.AccessibleJMenuItem, JPasswordField.AccessibleJPasswordField, JRadioButton.AccessibleJRadioButton, JRadioButtonMenuItem.AccessibleJRadioButtonMenuItem, JTextArea.AccessibleJTextArea, JTextComponent.AccessibleJTextComponent, JTextField.AccessibleJTextField, JToggleButton.AccessibleJToggleButton, JTree.AccessibleJTree.AccessibleJTreeNode, Menu.AccessibleAWTMenu, MenuItem.AccessibleAWTMenuItem, PopupMenu.AccessibleAWTPopupMenu

public interface AccessibleAction

If an object implements this interface then it must be able to perform one or more actions. Accessibility software can use the implementations of this interface to discover and perform actions on an object.

The AccessibleContext.getAccessibleAction() method should return null if an object does not implement this interface.

Since:
1.2
See Also:
Accessible, AccessibleContext, AccessibleContext.getAccessibleAction()

Field Summary
static String DECREMENT
          The name of an action which decrements a value.
static String INCREMENT
          The name of an action which increments a value.
static String TOGGLE_EXPAND
          The name of an action which toggles the expansion of a tree node.
 
Method Summary
 boolean doAccessibleAction(int i)
          Perform the specified action.
 int getAccessibleActionCount()
          Get the number possible actions for this object, with the zeroth representing the default action.
 String getAccessibleActionDescription(int i)
          Get a description for the specified action.
 

Field Detail

DECREMENT

static final String DECREMENT
The name of an action which decrements a value.

Since:
1.5
See Also:
Constant Field Values

INCREMENT

static final String INCREMENT
The name of an action which increments a value.

Since:
1.5
See Also:
Constant Field Values

TOGGLE_EXPAND

static final String TOGGLE_EXPAND
The name of an action which toggles the expansion of a tree node.

Since:
1.5
See Also:
Constant Field Values
Method Detail

getAccessibleActionCount

int getAccessibleActionCount()
Get the number possible actions for this object, with the zeroth representing the default action.

Returns:
the 0-based number of actions

getAccessibleActionDescription

String getAccessibleActionDescription(int i)
Get a description for the specified action. Returns null if out of bounds.

Parameters:
i - the action to describe, 0-based
Returns:
description of the action

doAccessibleAction

boolean doAccessibleAction(int i)
Perform the specified action. Does nothing if out of bounds.

Parameters:
i - the action to perform, 0-based
Returns:
true if the action was performed