This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.accessibility
interface AccessibleAction

All Known Implementing Classes:
AbstractButton.AccessibleAbstractButton, JButton.AccessibleJButton, JMenuItem.AccessibleJMenuItem, JToggleButton.AccessibleJToggleButton, JCheckBoxMenuItem.AccessibleJCheckBoxMenuItem, JMenu.AccessibleJMenu, JRadioButtonMenuItem.AccessibleJRadioButtonMenuItem, JCheckBox.AccessibleJCheckBox, JRadioButton.AccessibleJRadioButton, AccessibleHyperlink, JEditorPane.JEditorPaneAccessibleHypertextSupport.HTMLLink, Button.AccessibleAWTButton, Checkbox.AccessibleAWTCheckbox, CheckboxMenuItem.AccessibleAWTCheckboxMenuItem, Choice.AccessibleAWTChoice, JComboBox.AccessibleJComboBox, JSpinner.AccessibleJSpinner, JTextComponent.AccessibleJTextComponent, JEditorPane.AccessibleJEditorPane, JTextArea.AccessibleJTextArea, JTextField.AccessibleJTextField, JEditorPane.AccessibleJEditorPaneHTML, JEditorPane.JEditorPaneAccessibleHypertextSupport, JPasswordField.AccessibleJPasswordField, JTree.AccessibleJTree.AccessibleJTreeNode, MenuItem.AccessibleAWTMenuItem, Menu.AccessibleAWTMenu, 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 {@link Accessible}) and then calling the {@link AccessibleContext#getAccessibleAction} method. If the return value is not null, the object supports this interface.


Field Summary
static String CLICK
          An action which causes a component to execute its default action.
static String DECREMENT
          An action which decrements a value.
static String INCREMENT
          An action which increments a value.
static String TOGGLE_EXPAND
          An action which causes a tree node to collapse if expanded and expand if collapsed.
static String TOGGLE_POPUP
          An action which causes a popup to become visible if it is hidden and hidden if it is visible.
 
Method Summary
 boolean

          Performs the specified Action on the object
 int

          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

          Returns a description of the specified action of the object.
 

Field Detail

CLICK

public static final String CLICK
An action which causes a component to execute its default action.

DECREMENT

public static final String DECREMENT
An action which decrements a value.

INCREMENT

public static final String INCREMENT
An action which increments a value.

TOGGLE_EXPAND

public static final String TOGGLE_EXPAND
An action which causes a tree node to collapse if expanded and expand if collapsed.

TOGGLE_POPUP

public static final String TOGGLE_POPUP
An action which causes a popup to become visible if it is hidden and hidden if it is visible.
Method Detail

doAccessibleAction

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

getAccessibleActionCount

public 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

public 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


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.