1. /*

  2.  * @(#)AccessibleAction.java	1.12 00/02/02

  3.  *

  4.  * Copyright 1997-2000 Sun Microsystems, Inc. All Rights Reserved.

  5.  * 

  6.  * This software is the proprietary information of Sun Microsystems, Inc.  

  7.  * Use is subject to license terms.

  8.  * 

  9.  */

  10. 

  11. package javax.accessibility;

  12. 

  13. /**

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

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

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

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

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

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

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

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

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

  23.  *

  24.  * @see Accessible

  25.  * @see Accessible#getAccessibleContext

  26.  * @see AccessibleContext

  27.  * @see AccessibleContext#getAccessibleAction

  28.  *

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

  30.  * @author	Peter Korn

  31.  * @author      Hans Muller

  32.  * @author      Willie Walker

  33.  */

  34. public interface AccessibleAction {

  35. 

  36.     /**

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

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

  39.      * action of the object.

  40.      *

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

  42.      */

  43.     public int getAccessibleActionCount();

  44. 

  45.     /**

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

  47.      *

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

  49.      * @return a String description of the action

  50.      * @see #getAccessibleActionCount

  51.      */

  52.     public String getAccessibleActionDescription(int i);

  53. 

  54.     /**

  55.      * Performs the specified Action on the object

  56.      *

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

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

  59.      * @see #getAccessibleActionCount

  60.      */

  61.     public boolean doAccessibleAction(int i);

  62. }