1. /*

  2.  * @(#)AccessibleAction.java	1.14 03/01/23

  3.  *

  4.  * Copyright 2003 Sun Microsystems, Inc. All rights reserved.

  5.  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.

  6.  */

  7. 

  8. package javax.accessibility;

  9. 

  10. /**

  11.  * The AccessibleAction interface should be supported by any object 

  12.  * that can perform one or more actions.  This interface

  13.  * provides the standard mechanism for an assistive technology to determine 

  14.  * what those actions are as well as tell the object to perform them.

  15.  * Any object that can be manipulated should support this

  16.  * interface.  Applications can determine if an object supports the 

  17.  * AccessibleAction interface by first obtaining its AccessibleContext (see

  18.  * {@link Accessible}) and then calling the {@link AccessibleContext#getAccessibleAction}

  19.  * method.  If the return value is not null, the object supports this interface.

  20.  *

  21.  * @see Accessible

  22.  * @see Accessible#getAccessibleContext

  23.  * @see AccessibleContext

  24.  * @see AccessibleContext#getAccessibleAction

  25.  *

  26.  * @version     1.3 02/04/98 11:12:57

  27.  * @author	Peter Korn

  28.  * @author      Hans Muller

  29.  * @author      Willie Walker

  30.  */

  31. public interface AccessibleAction {

  32. 

  33.     /**

  34.      * Returns the number of accessible actions available in this object

  35.      * If there are more than one, the first one is considered the "default"

  36.      * action of the object.

  37.      *

  38.      * @return the zero-based number of Actions in this object

  39.      */

  40.     public int getAccessibleActionCount();

  41. 

  42.     /**

  43.      * Returns a description of the specified action of the object.

  44.      *

  45.      * @param i zero-based index of the actions

  46.      * @return a String description of the action

  47.      * @see #getAccessibleActionCount

  48.      */

  49.     public String getAccessibleActionDescription(int i);

  50. 

  51.     /**

  52.      * Performs the specified Action on the object

  53.      *

  54.      * @param i zero-based index of actions

  55.      * @return true if the action was performed; otherwise false.

  56.      * @see #getAccessibleActionCount

  57.      */

  58.     public boolean doAccessibleAction(int i);

  59. }