aboutsummaryrefslogtreecommitdiff
path: root/libjava/javax/accessibility/AccessibleKeyBinding.java
diff options
context:
space:
mode:
Diffstat (limited to 'libjava/javax/accessibility/AccessibleKeyBinding.java')
-rw-r--r--libjava/javax/accessibility/AccessibleKeyBinding.java78
1 files changed, 78 insertions, 0 deletions
diff --git a/libjava/javax/accessibility/AccessibleKeyBinding.java b/libjava/javax/accessibility/AccessibleKeyBinding.java
new file mode 100644
index 0000000..777f8b7
--- /dev/null
+++ b/libjava/javax/accessibility/AccessibleKeyBinding.java
@@ -0,0 +1,78 @@
+/* AccessibleKeyBinding.java -- aids in using keyboard navigation
+ Copyright (C) 2002 Free Software Foundation, Inc.
+
+This file is part of GNU Classpath.
+
+GNU Classpath is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2, or (at your option)
+any later version.
+
+GNU Classpath is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with GNU Classpath; see the file COPYING. If not, write to the
+Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+02111-1307 USA.
+
+Linking this library statically or dynamically with other modules is
+making a combined work based on this library. Thus, the terms and
+conditions of the GNU General Public License cover the whole
+combination.
+
+As a special exception, the copyright holders of this library give you
+permission to link this library with independent modules to produce an
+executable, regardless of the license terms of these independent
+modules, and to copy and distribute the resulting executable under
+terms of your choice, provided that you also meet, for each linked
+independent module, the terms and conditions of the license of that
+module. An independent module is a module which is not derived from
+or based on this library. If you modify this library, you may extend
+this exception to your version of the library, but you are not
+obligated to do so. If you do not wish to do so, delete this
+exception statement from your version. */
+
+
+package javax.accessibility;
+
+/**
+ * Objects which have keyboard bindings for mneumonics or shortcuts should
+ * implement this interface. Accessibility software can use the
+ * implementations of this interface to aid the user in using the key
+ * bindings.
+ *
+ * <p>The <code>AccessibleContext.getAccessibleKeyBinding()</code> method
+ * should return <code>null</code> if an object does not implement this
+ * interface.
+ *
+ * @author Eric Blake <ebb9@email.byu.edu>
+ * @see Accessible
+ * @see AccessibleContext
+ * @see AccessibleContext#getAccessibleKeyBinding()
+ * @since 1.2
+ * @status updated to 1.4
+ */
+public interface AccessibleKeyBinding
+{
+ /**
+ * Returns the count of key bindings for this object.
+ *
+ * @return the 0-based count, or -1 if there are none
+ */
+ int getAccessibleKeyBindingCount();
+
+ /**
+ * Return the numbered key binding, which can then be cast in an
+ * implementation dependent way to the appropriate object type. For example,
+ * swing uses <code>javax.swing.KeyStroke</code>. This returns null if i
+ * is out of bounds.
+ *
+ * @param i the 0-based index of key bindings
+ * @return the key binding
+ * @see #getAccessibleKeyBindingCount()
+ */
+ Object getAccessibleKeyBinding(int i);
+} // interface AccessibleKeyBinding