001    /* AccessibleKeyBinding.java -- aids in using keyboard navigation
002       Copyright (C) 2002, 2005  Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    
039    package javax.accessibility;
040    
041    /**
042     * Objects which have keyboard bindings for mneumonics or shortcuts should
043     * implement this interface.  Accessibility software can use the
044     * implementations of this interface to aid the user in using the key
045     * bindings.
046     *
047     * <p>The <code>AccessibleContext.getAccessibleKeyBinding()</code> method
048     * should return <code>null</code> if an object does not implement this
049     * interface.
050     *
051     * @author Eric Blake (ebb9@email.byu.edu)
052     * @see Accessible
053     * @see AccessibleContext
054     * @see AccessibleContext#getAccessibleKeyBinding()
055     * @since 1.2
056     * @status updated to 1.4
057     */
058    public interface AccessibleKeyBinding
059    {
060      /**
061       * Returns the count of key bindings for this object.
062       *
063       * @return the 0-based count, or -1 if there are none
064       */
065      int getAccessibleKeyBindingCount();
066    
067      /**
068       * Return the numbered key binding, which can then be cast in an
069       * implementation dependent way to the appropriate object type. For example,
070       * swing uses <code>javax.swing.KeyStroke</code>. This returns null if i
071       * is out of bounds.
072       *
073       * @param i the 0-based index of key bindings
074       * @return the key binding
075       * @see #getAccessibleKeyBindingCount()
076       */
077      Object getAccessibleKeyBinding(int i);
078    } // interface AccessibleKeyBinding