Source for javax.accessibility.AccessibleAction

   1: /* AccessibleAction.java -- aids in accessibly performing actions
   2:    Copyright (C) 2000, 2002, 2005  Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.accessibility;
  40: 
  41: /**
  42:  * If an object implements this interface then it must be able to perform one
  43:  * or more actions. Accessibility software can use the implementations of this
  44:  * interface to discover and perform actions on an object.
  45:  *
  46:  * <p>The <code>AccessibleContext.getAccessibleAction()</code> method should
  47:  * return <code>null</code> if an object does not implement this interface.
  48:  *
  49:  * @author Eric Blake (ebb9@email.byu.edu)
  50:  * @see Accessible
  51:  * @see AccessibleContext
  52:  * @see AccessibleContext#getAccessibleAction()
  53:  * @since 1.2
  54:  * @status updated to 1.4
  55:  */
  56: public interface AccessibleAction
  57: {
  58: 
  59:   /**
  60:    * The name of an action which decrements a value.
  61:    *
  62:    * @since 1.5
  63:    */
  64:   static final String DECREMENT = "decrement";
  65: 
  66:   /**
  67:    * The name of an action which increments a value.
  68:    *
  69:    * @since 1.5
  70:    */
  71:   static final String INCREMENT = "increment";
  72: 
  73:   /**
  74:    * The name of an action which toggles the expansion of a tree node.
  75:    *
  76:    * @since 1.5
  77:    */
  78:   static final String TOGGLE_EXPAND = "toggle expand";
  79: 
  80:   /**
  81:    * Get the number possible actions for this object, with the zeroth
  82:    * representing the default action.
  83:    *
  84:    * @return the 0-based number of actions
  85:    */
  86:   int getAccessibleActionCount();
  87: 
  88:   /**
  89:    * Get a description for the specified action. Returns null if out of
  90:    * bounds.
  91:    *
  92:    * @param i the action to describe, 0-based
  93:    * @return description of the action
  94:    */
  95:   String getAccessibleActionDescription(int i);
  96: 
  97:   /**
  98:    * Perform the specified action. Does nothing if out of bounds.
  99:    *
 100:    * @param i the action to perform, 0-based
 101:    * @return true if the action was performed
 102:    */
 103:   boolean doAccessibleAction(int i);
 104: } // interface AccessibleAction