FileDocCategorySizeDatePackage
AccessibleAction.javaAPI DocJava SE 5 API2577Fri Aug 26 14:57:28 BST 2005javax.accessibility

AccessibleAction

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.
see
Accessible
see
Accessible#getAccessibleContext
see
AccessibleContext
see
AccessibleContext#getAccessibleAction
version
1.17 04/15/04
author
Peter Korn
author
Hans Muller
author
Willie Walker
author
Lynn Monsanto

Fields Summary
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
INCREMENT
An action which increments a value.
public static final String
DECREMENT
An action which decrements a value.
Constructors Summary
Methods Summary
public booleandoAccessibleAction(int i)
Performs the specified Action on the object

param
i zero-based index of actions
return
true if the action was performed; otherwise false.
see
#getAccessibleActionCount

public intgetAccessibleActionCount()
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.

return
the zero-based number of Actions in this object

public java.lang.StringgetAccessibleActionDescription(int i)
Returns a description of the specified action of the object.

param
i zero-based index of the actions
return
a String description of the action
see
#getAccessibleActionCount