javax.accessibility
Interface AccessibleAction

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

public interface AccessibleAction

The AccessibleAction interface should be supported by any object that can perform one or more actions. This interface provides the standard mechanism for an assistive technology to determine what those actions are as well as tell the object to perform them. Any object that can be manipulated should support this interface. Applications can determine if an object supports the AccessibleAction interface by first obtaining its AccessibleContext (see Accessible sample code for javax.accessibility.Accessible definition code for javax.accessibility.Accessible ) and then calling the AccessibleContext.getAccessibleAction() sample code for javax.accessibility.AccessibleContext.getAccessibleAction() definition code for javax.accessibility.AccessibleContext.getAccessibleAction() method. If the return value is not null, the object supports this interface.

See Also:
Accessible sample code for javax.accessibility.Accessible definition code for javax.accessibility.Accessible , Accessible.getAccessibleContext() sample code for javax.accessibility.Accessible.getAccessibleContext() definition code for javax.accessibility.Accessible.getAccessibleContext() , AccessibleContext sample code for javax.accessibility.AccessibleContext definition code for javax.accessibility.AccessibleContext , AccessibleContext.getAccessibleAction() sample code for javax.accessibility.AccessibleContext.getAccessibleAction() definition code for javax.accessibility.AccessibleContext.getAccessibleAction()

Field Summary
static String sample code for java.lang.String definition code for java.lang.String DECREMENT sample code for javax.accessibility.AccessibleAction.DECREMENT definition code for javax.accessibility.AccessibleAction.DECREMENT
          An action which decrements a value.
static String sample code for java.lang.String definition code for java.lang.String INCREMENT sample code for javax.accessibility.AccessibleAction.INCREMENT definition code for javax.accessibility.AccessibleAction.INCREMENT
          An action which increments a value.
static String sample code for java.lang.String definition code for java.lang.String TOGGLE_EXPAND sample code for javax.accessibility.AccessibleAction.TOGGLE_EXPAND definition code for javax.accessibility.AccessibleAction.TOGGLE_EXPAND
          An action which causes a tree node to collapse if expanded and expand if collapsed.
 
Method Summary
 boolean doAccessibleAction sample code for javax.accessibility.AccessibleAction.doAccessibleAction(int) definition code for javax.accessibility.AccessibleAction.doAccessibleAction(int) (int i)
          Performs the specified Action on the object
 int getAccessibleActionCount sample code for javax.accessibility.AccessibleAction.getAccessibleActionCount() definition code for javax.accessibility.AccessibleAction.getAccessibleActionCount() ()
          Returns the number of accessible actions available in this object If there are more than one, the first one is considered the "default" action of the object.
 String sample code for java.lang.String definition code for java.lang.String getAccessibleActionDescription sample code for javax.accessibility.AccessibleAction.getAccessibleActionDescription(int) definition code for javax.accessibility.AccessibleAction.getAccessibleActionDescription(int) (int i)
          Returns a description of the specified action of the object.
 

Field Detail

TOGGLE_EXPAND sample code for javax.accessibility.AccessibleAction.TOGGLE_EXPAND

static final String sample code for java.lang.String definition code for java.lang.String  TOGGLE_EXPAND
An action which causes a tree node to collapse if expanded and expand if collapsed.

Since:
1.5

INCREMENT sample code for javax.accessibility.AccessibleAction.INCREMENT

static final String sample code for java.lang.String definition code for java.lang.String  INCREMENT
An action which increments a value.

Since:
1.5

DECREMENT sample code for javax.accessibility.AccessibleAction.DECREMENT

static final String sample code for java.lang.String definition code for java.lang.String  DECREMENT
An action which decrements a value.

Since:
1.5
Method Detail

getAccessibleActionCount sample code for javax.accessibility.AccessibleAction.getAccessibleActionCount() definition code for javax.accessibility.AccessibleAction.getAccessibleActionCount()

int getAccessibleActionCount()
Returns the number of accessible actions available in this object If there are more than one, the first one is considered the "default" action of the object.

Returns:
the zero-based number of Actions in this object

getAccessibleActionDescription sample code for javax.accessibility.AccessibleAction.getAccessibleActionDescription(int) definition code for javax.accessibility.AccessibleAction.getAccessibleActionDescription(int)

String sample code for java.lang.String definition code for java.lang.String  getAccessibleActionDescription(int i)
Returns a description of the specified action of the object.

Parameters:
i - zero-based index of the actions
Returns:
a String description of the action
See Also:
getAccessibleActionCount() sample code for javax.accessibility.AccessibleAction.getAccessibleActionCount() definition code for javax.accessibility.AccessibleAction.getAccessibleActionCount()

doAccessibleAction sample code for javax.accessibility.AccessibleAction.doAccessibleAction(int) definition code for javax.accessibility.AccessibleAction.doAccessibleAction(int)

boolean doAccessibleAction(int i)
Performs the specified Action on the object

Parameters:
i - zero-based index of actions
Returns:
true if the action was performed; otherwise false.
See Also:
getAccessibleActionCount() sample code for javax.accessibility.AccessibleAction.getAccessibleActionCount() definition code for javax.accessibility.AccessibleAction.getAccessibleActionCount()