libjava/java/awt/im/spi/InputMethodDescriptor.java

   1 /* InputMethodDescriptor.java -- enables loading and use of an input method
   2    Copyright (C) 2002, 2005  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 java.awt.im.spi;
  39
  40 import java.awt.AWTException;
  41 import java.awt.Image;
  42 import java.util.Locale;
  43
  44 /**
  45  * This interface provides information about an InputMethod before it is
  46  * loaded.
  47  *
  48  * @author Eric Blake (ebb9@email.byu.edu)
  49  * @since 1.3
  50  * @status updated to 1.4
  51  */
  52 public interface InputMethodDescriptor
  53 {
  54   /**
  55    * Returns the locales supported by the input method this describes. This
  56    * allows the selection of input methods by locale (by language only, or
  57    * also by country and variant), via
  58    * {@link InputContext#selectInputMethod(Locale)}. The returned list should
  59    * ignore pass-through locales, so it is usually a subset of locales for
  60    * which {@link InputMethod#setContext(Locale)} returns true. If
  61    * {@link #hasDynamicLocaleList()} returns true, this is called each time
  62    * information is needed, allowing dynamic addition or removal of supported
  63    * locales.
  64    *
  65    * @return the list of supported locales
  66    * @throws AWTException if the input method is not available
  67    */
  68   Locale[] getAvailableLocales() throws AWTException;
  69
  70   /**
  71    * Test whether the input method this describes has a static or dynamic
  72    * locale list. For example, this would return true if the list of supported
  73    * locales depends on adapters currently loaded over a network.
  74    *
  75    * @return true if the locale list is dynamic
  76    */
  77   boolean hasDynamicLocaleList();
  78
  79   /**
  80    * Returns a user visible name of the input locale, displayed in the
  81    * specified locale. The inputLocale parameter must be one obtained from
  82    * the list in {@link #getAvailableLocales()}, or null for a
  83    * locale-independent description of the input method. If a translation to
  84    * the desired display language is not available, another language may be
  85    * used.
  86    *
  87    * @param inputLocale the locale of the input method, or null
  88    * @param displayLanguage the language of the result
  89    * @return the name of the input method when using the given inputLocale
  90    */
  91   String getInputMethodDisplayName(Locale inputLocale,
  92                                    Locale displayLanguage);
  93
  94   /**
  95    * Returns a 16x16 icon for the input locale. The inputLocale parameter
  96    * must be one obtained from the list in {@link #getAvailableLocales()}, or
  97    * null for a locale-independent icon for the input method.
  98    *
  99    * @param inputLocale the locale of the input method, or null
 100    * @return a 16x16 icon for the input method when using the given inputLocale
 101    */
 102   Image getInputMethodIcon(Locale inputLocale);
 103
 104   /**
 105    * Creates a new instance of the input method.
 106    *
 107    * @return the newly created input method
 108    * @throws Exception if anything goes wrong
 109    */
 110   InputMethod createInputMethod() throws Exception;
 111
 112 } // interface InputMethodDescriptor
 113