0N/A/*
2362N/A * Copyright (c) 1998, 1999, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
2362N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
2362N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
2362N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
2362N/A * or visit www.oracle.com if you need additional information or have any
2362N/A * questions.
0N/A */
0N/A
0N/A
0N/Apackage java.awt.im.spi;
0N/A
0N/Aimport java.awt.AWTException;
0N/Aimport java.awt.Image;
0N/Aimport java.util.Locale;
0N/A
0N/A/**
0N/A * Defines methods that provide sufficient information about an input method
0N/A * to enable selection and loading of that input method.
0N/A * The input method itself is only loaded when it is actually used.
0N/A *
0N/A * @since 1.3
0N/A */
0N/A
0N/Apublic interface InputMethodDescriptor {
0N/A
0N/A /**
0N/A * Returns the locales supported by the corresponding input method.
0N/A * The locale may describe just the language, or may also include
0N/A * country and variant information if needed.
0N/A * The information is used to select input methods by locale
0N/A * ({@link java.awt.im.InputContext#selectInputMethod(Locale)}). It may also
0N/A * be used to sort input methods by locale in a user-visible
0N/A * list of input methods.
0N/A * <p>
0N/A * Only the input method's primary locales should be returned.
0N/A * For example, if a Japanese input method also has a pass-through
0N/A * mode for Roman characters, typically still only Japanese would
0N/A * be returned. Thus, the list of locales returned is typically
0N/A * a subset of the locales for which the corresponding input method's
0N/A * implementation of {@link java.awt.im.spi.InputMethod#setLocale} returns true.
0N/A * <p>
0N/A * If {@link #hasDynamicLocaleList} returns true, this method is
0N/A * called each time the information is needed. This
0N/A * gives input methods that depend on network resources the chance
0N/A * to add or remove locales as resources become available or
0N/A * unavailable.
0N/A *
0N/A * @return the locales supported by the input method
0N/A * @exception AWTException if it can be determined that the input method
0N/A * is inoperable, for example, because of incomplete installation.
0N/A */
0N/A Locale[] getAvailableLocales() throws AWTException;
0N/A
0N/A /**
0N/A * Returns whether the list of available locales can change
0N/A * at runtime. This may be the case, for example, for adapters
0N/A * that access real input methods over the network.
0N/A */
0N/A boolean hasDynamicLocaleList();
0N/A
0N/A /**
0N/A * Returns the user-visible name of the corresponding
0N/A * input method for the given input locale in the language in which
0N/A * the name will be displayed.
0N/A * <p>
0N/A * The inputLocale parameter specifies the locale for which text
0N/A * is input.
0N/A * This parameter can only take values obtained from this descriptor's
0N/A * {@link #getAvailableLocales} method or null. If it is null, an
0N/A * input locale independent name for the input method should be
0N/A * returned.
0N/A * <p>
0N/A * If a name for the desired display language is not available, the
0N/A * method may fall back to some other language.
0N/A *
0N/A * @param inputLocale the locale for which text input is supported, or null
0N/A * @param displayLanguage the language in which the name will be displayed
0N/A */
0N/A String getInputMethodDisplayName(Locale inputLocale, Locale displayLanguage);
0N/A
0N/A /**
0N/A * Returns an icon for the corresponding input method.
0N/A * The icon may be used by a user interface for selecting input methods.
0N/A * <p>
0N/A * The inputLocale parameter specifies the locale for which text
0N/A * is input.
0N/A * This parameter can only take values obtained from this descriptor's
0N/A * {@link #getAvailableLocales} method or null. If it is null, an
0N/A * input locale independent icon for the input method should be
0N/A * returned.
0N/A * <p>
0N/A * The icon's size should be 16&times;16 pixels.
0N/A *
0N/A * @param inputLocale the locale for which text input is supported, or null
0N/A * @return an icon for the corresponding input method, or null
0N/A */
0N/A Image getInputMethodIcon(Locale inputLocale);
0N/A
0N/A /**
0N/A * Creates a new instance of the corresponding input method.
0N/A *
0N/A * @return a new instance of the corresponding input method
0N/A * @exception Exception any exception that may occur while creating the
0N/A * input method instance
0N/A */
0N/A InputMethod createInputMethod() throws Exception;
0N/A}