15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  22  * CA 95054 USA or visit www.sun.com if you need additional information or
  23  * have any questions.
  24  */
  25 
  26 package javax.accessibility;
  27 
  28 /**
  29  * The AccessibleKeyBinding interface should be supported by any object
  30  * that has a keyboard bindings such as a keyboard mnemonic and/or keyboard
  31  * shortcut which can be used to select the object.  This interface provides
  32  * the standard mechanism for an assistive technology to determine the
  33  * key bindings which exist for this object.
  34  * Any object that has such key bindings should support this
  35  * interface.  Applications can determine if an object supports the
  36  * AccessibleKeyBinding interface by first obtaining its AccessibleContext
  37  * (see @link Accessible} and then calling the
  38  * {@link AccessibleContext#getAccessibleKeyBinding} method.  If the return
  39  * value is not null, the object supports this interface.
  40  *
  41  * @see Accessible
  42  * @see Accessible#getAccessibleContext
  43  * @see AccessibleContext
  44  * @see AccessibleContext#getAccessibleKeyBinding
  45  *
  46  * @author      Lynn Monsanto
  47  * @since 1.4
  48  */
  49 public interface AccessibleKeyBinding {
  50 
  51     /**
  52      * Returns the number of key bindings for this object
  53      *
  54      * @return the zero-based number of key bindings for this object
  55      */
  56     public int getAccessibleKeyBindingCount();
  57 
  58     /**
  59      * Returns a key binding for this object.  The value returned is an
  60      * java.lang.Object which must be cast to appropriate type depending
  61      * on the underlying implementation of the key.  For example, if the
  62      * Object returned is a javax.swing.KeyStroke, the user of this
  63      * method should do the following:
  64      * <nf><code>
  65      * Component c = <get the component that has the key bindings>
  66      * AccessibleContext ac = c.getAccessibleContext();
  67      * AccessibleKeyBinding akb = ac.getAccessibleKeyBinding();
  68      * for (int i = 0; i < akb.getAccessibleKeyBindingCount(); i++) {
  69      *     Object o = akb.getAccessibleKeyBinding(i);
  70      *     if (o instanceof javax.swing.KeyStroke) {
  71      *         javax.swing.KeyStroke keyStroke = (javax.swing.KeyStroke)o;
  72      *         <do something with the key binding>
  73      *     }
  74      * }
  75      * </code></nf>
  76      *
  77      * @param i zero-based index of the key bindings
  78      * @return a javax.lang.Object which specifies the key binding
  79      * @see #getAccessibleKeyBindingCount
  80      */
  81     public java.lang.Object getAccessibleKeyBinding(int i);
  82 }

  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  22  * CA 95054 USA or visit www.sun.com if you need additional information or
  23  * have any questions.
  24  */
  25 
  26 package javax.accessibility;
  27 
  28 /**
  29  * The AccessibleKeyBinding interface should be supported by any object
  30  * that has a keyboard bindings such as a keyboard mnemonic and/or keyboard
  31  * shortcut which can be used to select the object.  This interface provides
  32  * the standard mechanism for an assistive technology to determine the
  33  * key bindings which exist for this object.
  34  * Any object that has such key bindings should support this
  35  * interface.




  36  *
  37  * @see Accessible
  38  * @see Accessible#getAccessibleContext
  39  * @see AccessibleContext

  40  *
  41  * @author      Lynn Monsanto
  42  * @since 1.4
  43  */
  44 public interface AccessibleKeyBinding {
  45 
  46     /**
  47      * Returns the number of key bindings for this object
  48      *
  49      * @return the zero-based number of key bindings for this object
  50      */
  51     public int getAccessibleKeyBindingCount();
  52 
  53     /**
  54      * Returns a key binding for this object.  The value returned is an
  55      * java.lang.Object which must be cast to appropriate type depending
  56      * on the underlying implementation of the key.














  57      *
  58      * @param i zero-based index of the key bindings
  59      * @return a javax.lang.Object which specifies the key binding
  60      * @see #getAccessibleKeyBindingCount
  61      */
  62     public java.lang.Object getAccessibleKeyBinding(int i);
  63 }