Source for java.awt.im.spi.InputMethodDescriptor

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