Source for javax.accessibility.AccessibleKeyBinding

   1: /* AccessibleKeyBinding.java -- aids in using keyboard navigation
   2:    Copyright (C) 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:  * Objects which have keyboard bindings for mneumonics or shortcuts should
  43:  * implement this interface.  Accessibility software can use the
  44:  * implementations of this interface to aid the user in using the key
  45:  * bindings.
  46:  *
  47:  * <p>The <code>AccessibleContext.getAccessibleKeyBinding()</code> method
  48:  * should return <code>null</code> if an object does not implement this
  49:  * interface.
  50:  *
  51:  * @author Eric Blake (ebb9@email.byu.edu)
  52:  * @see Accessible
  53:  * @see AccessibleContext
  54:  * @see AccessibleContext#getAccessibleKeyBinding()
  55:  * @since 1.2
  56:  * @status updated to 1.4
  57:  */
  58: public interface AccessibleKeyBinding
  59: {
  60:   /**
  61:    * Returns the count of key bindings for this object.
  62:    *
  63:    * @return the 0-based count, or -1 if there are none
  64:    */
  65:   int getAccessibleKeyBindingCount();
  66: 
  67:   /**
  68:    * Return the numbered key binding, which can then be cast in an
  69:    * implementation dependent way to the appropriate object type. For example,
  70:    * swing uses <code>javax.swing.KeyStroke</code>. This returns null if i
  71:    * is out of bounds.
  72:    *
  73:    * @param i the 0-based index of key bindings
  74:    * @return the key binding
  75:    * @see #getAccessibleKeyBindingCount()
  76:    */
  77:   Object getAccessibleKeyBinding(int i);
  78: } // interface AccessibleKeyBinding