toolchain/gcc/libjava/javax/accessibility/AccessibleExtendedComponent.java

   1 /* AccessibleExtendedComponent.java -- aids in extended component access
   2    Copyright (C) 2002 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., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 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 package javax.accessibility;
  39
  40 /**
  41  * Objects which present graphical components with extensions such as key
  42  * bindings or tool-tips should implement this interface.  Accessibility
  43  * software can use the implementations of this interface to display the
  44  * extended information of the component.
  45  *
  46  * <p>The <code>AccessibleContext.getAccessibleComponent()</code> method
  47  * should return an instance of this interface only when it is supported.
  48  *
  49  * @author Eric Blake <ebb9@email.byu.edu>
  50  * @see Accessible
  51  * @see AccessibleContext
  52  * @see AccessibleContext#getAccessibleComponent()
  53  * @since 1.2
  54  * @status updated to 1.4
  55  */
  56 public interface AccessibleExtendedComponent extends AccessibleComponent
  57 {
  58   /**
  59    * Returns the tool-tip text for this component.
  60    *
  61    * @return the tool-tip, or null if not supported
  62    */
  63   String getToolTipText();
  64
  65   /**
  66    * Returns the title border text for this component.
  67    *
  68    * @return the titled border text, or null if not supported
  69    */
  70   String getTitledBorderText();
  71
  72   /**
  73    * Returns the accessible key bindings for this component.
  74    *
  75    * @return the key bindings, or null if not supported
  76    */
  77   AccessibleKeyBinding getAccessibleKeyBinding();
  78 } // interface AccessibleExtendedComponent