public interface InputMethodDescriptor
Modifier and Type | Method and Description |
---|---|
InputMethod |
createInputMethod()
Creates a new instance of the corresponding input method.
|
Locale[] |
getAvailableLocales()
Returns the locales supported by the corresponding input method.
|
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.
|
Image |
getInputMethodIcon(Locale inputLocale)
Returns an icon for the corresponding input method.
|
boolean |
hasDynamicLocaleList()
Returns whether the list of available locales can change
at runtime.
|
Locale[] getAvailableLocales() throws AWTException
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 InputMethod.setLocale(java.util.Locale)
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.
AWTException
- if it can be determined that the input method
is inoperable, for example, because of incomplete installation.boolean hasDynamicLocaleList()
String getInputMethodDisplayName(Locale inputLocale, Locale displayLanguage)
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.
inputLocale
- the locale for which text input is supported, or nulldisplayLanguage
- the language in which the name will be displayedImage getInputMethodIcon(Locale inputLocale)
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.
inputLocale
- the locale for which text input is supported, or nullInputMethod createInputMethod() throws Exception
Exception
- any exception that may occur while creating the
input method instance Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2023, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.