OpenJDK 27 · java.awt.im.spi.InputMethodDescriptor · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public InputMethod	Returns: a new instance of the corresponding input method createInputMethod() Creates a new instance of the corresponding input method.
public Locale[]	Returns: the locales supported by the input method getAvailableLocales() Returns the locales supported by the corresponding input method.
public String	Returns: the user-visible name of the corresponding input method for the given input locale in the language in which the name will be displayed getInputMethodDisplayName(Locale the locale for which text input is supported, or null inputLocale, Locale the language in which the name will be displayed displayLanguage) Returns the user-visible name of the corresponding input method for the given input locale in the language in which the name will be displayed.
public Image	Returns: an icon for the corresponding input method, or null getInputMethodIcon(Locale the locale for which text input is supported, or null inputLocale) Returns an icon for the corresponding input method.
public boolean	Returns: whether the list of available locales can change at runtime hasDynamicLocaleList() Returns whether the list of available locales can change at runtime.

Method Detail

createInputMethod	back to summary
public InputMethod createInputMethod() throws Exception Creates a new instance of the corresponding input method. Returns:InputMethod a new instance of the corresponding input method Exceptions Exception: any exception that may occur while creating the input method instance

createInputMethod

back to summary

public InputMethod createInputMethod() throws Exception

Creates a new instance of the corresponding input method.

Returns:InputMethod

a new instance of the corresponding input method

Exceptions

Exception:: any exception that may occur while creating the input method instance

getAvailableLocales back to summary

getAvailableLocales	back to summary
public Locale[] getAvailableLocales() throws AWTException Returns the locales supported by the corresponding input method. The locale may describe just the language, or may also include country and variant information if needed. The information is used to select input methods by locale (`java.awt.im.InputContext#selectInputMethod(Locale)`). It may also be used to sort input methods by locale in a user-visible list of input methods. Only the input method's primary locales should be returned. For example, if a Japanese input method also has a pass-through mode for Roman characters, typically still only Japanese would be returned. Thus, the list of locales returned is typically a subset of the locales for which the corresponding input method's implementation of `java.awt.im.spi.InputMethod#setLocale` returns true. If `hasDynamicLocaleList` returns true, this method is called each time the information is needed. This gives input methods that depend on network resources the chance to add or remove locales as resources become available or unavailable. Returns:Locale[] the locales supported by the input method Exceptions AWTException: if it can be determined that the input method is inoperable, for example, because of incomplete installation.

public Locale[] getAvailableLocales() throws AWTException

Returns the locales supported by the corresponding input method. The locale may describe just the language, or may also include country and variant information if needed. The information is used to select input methods by locale (java.awt.im.InputContext#selectInputMethod(Locale)). It may also be used to sort input methods by locale in a user-visible list of input methods.

Only the input method's primary locales should be returned. For example, if a Japanese input method also has a pass-through mode for Roman characters, typically still only Japanese would be returned. Thus, the list of locales returned is typically a subset of the locales for which the corresponding input method's implementation of java.awt.im.spi.InputMethod#setLocale returns true.

If hasDynamicLocaleList returns true, this method is called each time the information is needed. This gives input methods that depend on network resources the chance to add or remove locales as resources become available or unavailable.

Returns:Locale[]

the locales supported by the input method

Exceptions

AWTException:: if it can be determined that the input method is inoperable, for example, because of incomplete installation.

getInputMethodDisplayName back to summary

getInputMethodDisplayName	back to summary
public String getInputMethodDisplayName(Locale inputLocale, Locale displayLanguage) Returns the user-visible name of the corresponding input method for the given input locale in the language in which the name will be displayed. The inputLocale parameter specifies the locale for which text is input. This parameter can only take values obtained from this descriptor's `getAvailableLocales` method or null. If it is null, an input locale independent name for the input method should be returned. If a name for the desired display language is not available, the method may fall back to some other language. Parameters inputLocale:Locale the locale for which text input is supported, or null displayLanguage:Locale the language in which the name will be displayed Returns:String the user-visible name of the corresponding input method for the given input locale in the language in which the name will be displayed

public String getInputMethodDisplayName(Locale inputLocale, Locale displayLanguage)

Returns the user-visible name of the corresponding input method for the given input locale in the language in which the name will be displayed.

The inputLocale parameter specifies the locale for which text is input. This parameter can only take values obtained from this descriptor's getAvailableLocales method or null. If it is null, an input locale independent name for the input method should be returned.

If a name for the desired display language is not available, the method may fall back to some other language.

Parameters

inputLocale:Locale: the locale for which text input is supported, or null
displayLanguage:Locale: the language in which the name will be displayed

Returns:String

the user-visible name of the corresponding input method for the given input locale in the language in which the name will be displayed

getInputMethodIcon back to summary

getInputMethodIcon	back to summary
public Image getInputMethodIcon(Locale inputLocale) Returns an icon for the corresponding input method. The icon may be used by a user interface for selecting input methods. The inputLocale parameter specifies the locale for which text is input. This parameter can only take values obtained from this descriptor's `getAvailableLocales` method or null. If it is null, an input locale independent icon for the input method should be returned. The icon's size should be 16×16 pixels. Parameters inputLocale:Locale the locale for which text input is supported, or null Returns:Image an icon for the corresponding input method, or null

public Image getInputMethodIcon(Locale inputLocale)

Returns an icon for the corresponding input method. The icon may be used by a user interface for selecting input methods.

The icon's size should be 16×16 pixels.

Parameters

inputLocale:Locale: the locale for which text input is supported, or null

Returns:Image

an icon for the corresponding input method, or null

hasDynamicLocaleList	back to summary
public boolean hasDynamicLocaleList() Returns whether the list of available locales can change at runtime. This may be the case, for example, for adapters that access real input methods over the network. Returns:boolean whether the list of available locales can change at runtime

hasDynamicLocaleList

back to summary

public boolean hasDynamicLocaleList()

Returns whether the list of available locales can change at runtime. This may be the case, for example, for adapters that access real input methods over the network.

Returns:boolean: whether the list of available locales can change at runtime

public Interface InputMethodDescriptor

Method Summary

Method Detail