public interface

AccessibleAction

javax.accessibility.AccessibleAction
Known Indirect Subclasses

Class Overview

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 getAccessibleAction() method. If the return value is not null, the object supports this interface.

Summary

Fields
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.
Public Methods
abstract boolean doAccessibleAction(int i)
Performs the specified Action on the object
abstract 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.
abstract String getAccessibleActionDescription(int i)
Returns a description of the specified action of the object.

Fields

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.

Public Methods

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

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

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