View Javadoc
1   /*
2    * Copyright (c) 2000, 2006, Oracle and/or its affiliates. All rights reserved.
3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4    *
5    * This code is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU General Public License version 2 only, as
7    * published by the Free Software Foundation.  Oracle designates this
8    * particular file as subject to the "Classpath" exception as provided
9    * by Oracle in the LICENSE file that accompanied this code.
10   *
11   * This code is distributed in the hope that it will be useful, but WITHOUT
12   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14   * version 2 for more details (a copy is included in the LICENSE file that
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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22   * or visit www.oracle.com if you need additional information or have any
23   * 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  }