Index (Frames) | Index (No Frames) | Package | Package Tree | Tree
java.awt.im.spi

Interface InputMethodDescriptor

java.lang.Object
|
+--java.awt.im.spi.InputMethodDescriptor


public interface InputMethodDescriptor

This interface provides information about an InputMethod before it is loaded.

Since:Author:

Method Summary

java.awt.im.spi.InputMethodcreateInputMethod()

Creates a new instance of the input method.
java.util.Locale[]getAvailableLocales()

Returns the locales supported by the input method this describes.
java.lang.StringgetInputMethodDisplayName(java.util.Locale inputLocale, java.util.Locale displayLanguage)

Returns a user visible name of the input locale, displayed in the specified locale.
java.awt.ImagegetInputMethodIcon(java.util.Locale inputLocale)

Returns a 16x16 icon for the input locale.
booleanhasDynamicLocaleList()

Test whether the input method this describes has a static or dynamic locale list.

Method Details

createInputMethod

public InputMethod createInputMethod()

Creates a new instance of the input method.

Returns:

Throws:


getAvailableLocales

public Locale[] getAvailableLocales()

Returns the locales supported by the input method this describes. This allows the selection of input methods by locale (by language only, or also by country and variant), via InputContext#selectInputMethod(Locale). The returned list should ignore pass-through locales, so it is usually a subset of locales for which InputMethod#setContext(Locale) returns true. If #hasDynamicLocaleList() returns true, this is called each time information is needed, allowing dynamic addition or removal of supported locales.

Returns:

Throws:


getInputMethodDisplayName

public String getInputMethodDisplayName(java.util.Locale inputLocale, java.util.Locale displayLanguage)

Returns a user visible name of the input locale, displayed in the specified locale. The inputLocale parameter must be one obtained from the list in #getAvailableLocales(), or null for a locale-independent description of the input method. If a translation to the desired display language is not available, another language may be used.

Parameters:

Returns:


getInputMethodIcon

public Image getInputMethodIcon(java.util.Locale inputLocale)

Returns a 16x16 icon for the input locale. The inputLocale parameter must be one obtained from the list in #getAvailableLocales(), or null for a locale-independent icon for the input method.

Parameters:

Returns:


hasDynamicLocaleList

public boolean hasDynamicLocaleList()

Test whether the input method this describes has a static or dynamic locale list. For example, this would return true if the list of supported locales depends on adapters currently loaded over a network.

Returns: