APIdia Launch Partner
Top Description Fields Methods
javax.accessibility

public Interface AccessibleAction

Known Direct Implementers
javax.accessibility.AccessibleHyperlink, javax.swing.AbstractButton.AccessibleAbstractButton, javax.swing.JComboBox.AccessibleJComboBox, javax.swing.JList.AccessibleJList.AccessibleJListChild, javax.swing.JSlider.AccessibleJSlider, javax.swing.JSpinner.AccessibleJSpinner, javax.swing.JTree.AccessibleJTree.AccessibleJTreeNode, javax.swing.text.JTextComponent.AccessibleJTextComponent, java.awt.Button.AccessibleAWTButton, java.awt.CheckboxMenuItem.AccessibleAWTCheckboxMenuItem, java.awt.Choice.AccessibleAWTChoice, java.awt.MenuItem.AccessibleAWTMenuItem, java.awt.Checkbox.AccessibleAWTCheckbox

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) and then calling the AccessibleContext#getAccessibleAction method. If the return value is not null, the object supports this interface.
Authors
Peter Korn, Hans Muller, Willie Walker, Lynn Monsanto
See Also
Accessible, Accessible#getAccessibleContext, AccessibleContext, AccessibleContext#getAccessibleAction

Field Summary

Modifier and TypeField and Description
public static final String
CLICK

An action which causes a component to execute its default action.

public static final String
DECREMENT

An action which decrements a value.

public static final String
INCREMENT

An action which increments a value.

public static final String
TOGGLE_EXPAND

An action which causes a tree node to collapse if expanded and expand if collapsed.

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 Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if the action was performed; otherwise false
doAccessibleAction
(int
zero-based index of actions
i
)

Performs the specified action on the object.

public int

Returns:

the zero-based number of actions in this object
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.

public String

Returns:

a String description of the action
getAccessibleActionDescription
(int
zero-based index of the actions
i
)

Returns a description of the specified action of the object.

Field Detail

CLICKback to summary
public static final String CLICK

An action which causes a component to execute its default action.

Since
1.6
DECREMENTback to summary
public static final String DECREMENT

An action which decrements a value.

Since
1.5
INCREMENTback to summary
public static final String INCREMENT

An action which increments a value.

Since
1.5
TOGGLE_EXPANDback to summary
public static final String TOGGLE_EXPAND

An action which causes a tree node to collapse if expanded and expand if collapsed.

Since
1.5
TOGGLE_POPUPback to summary
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.

Since
1.6

Method Detail

doAccessibleActionback to summary
public boolean doAccessibleAction(int i)

Performs the specified action on the object.

Parameters
i:int

zero-based index of actions

Returns:boolean

true if the action was performed; otherwise false

See Also
getAccessibleActionCount
getAccessibleActionCountback to summary
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:int

the zero-based number of actions in this object

getAccessibleActionDescriptionback to summary
public String getAccessibleActionDescription(int i)

Returns a description of the specified action of the object.

Parameters
i:int

zero-based index of the actions

Returns:String

a String description of the action

See Also
getAccessibleActionCount