/*

 * Copyright 1998-2003 Sun Microsystems, Inc.  All Rights Reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 */

package sun.awt;

import java.awt.Image;

import java.awt.Toolkit;

import java.awt.im.spi.InputMethod;

import java.awt.im.spi.InputMethodDescriptor;

import java.security.AccessController;

import java.util.Locale;

import sun.awt.SunToolkit;

import sun.security.action.GetPropertyAction;

/**

 * Provides sufficient information about an input method

 * to enable selection and loading of that input method.

 * The input method itself is only loaded when it is actually used.

 *

 * @since JDK1.3

 */

public abstract class X11InputMethodDescriptor implements InputMethodDescriptor {

    private static Locale locale;

    public X11InputMethodDescriptor() {

        locale = getSupportedLocale();

    }

    /**

     * @see java.awt.im.spi.InputMethodDescriptor#getAvailableLocales

     */

    public Locale[] getAvailableLocales() {

        Locale[] locales = {locale};

        return locales;

    }

    /**

     * @see java.awt.im.spi.InputMethodDescriptor#hasDynamicLocaleList

     */

    public boolean hasDynamicLocaleList() {

        return false;

    }

    /**

     * @see java.awt.im.spi.InputMethodDescriptor#getInputMethodDisplayName

     */

    public synchronized String getInputMethodDisplayName(Locale inputLocale, Locale displayLanguage) {

        // We ignore the input locale.

        // When displaying for the default locale, rely on the localized AWT properties;

        // for any other locale, fall back to English.

        String name = "System Input Methods";

        if (Locale.getDefault().equals(displayLanguage)) {

            name = Toolkit.getProperty("AWT.HostInputMethodDisplayName", name);

        }

        return name;

    }

    /**

     * @see java.awt.im.spi.InputMethodDescriptor#getInputMethodIcon

     */

    public Image getInputMethodIcon(Locale inputLocale) {

        return null;

    }

    /**

     * @see java.awt.im.spi.InputMethodDescriptor#createInputMethod

     */

    public abstract InputMethod createInputMethod() throws Exception;

    /**

     * returns supported locale. Currently this method returns the locale in which

     * the VM is started since Solaris doesn't provide a way to determine the login locale.

     */

    static Locale getSupportedLocale() {

        return SunToolkit.getStartupLocale();

    }

}