APIdia Launch Partner
Top Description Fields Constructors Methods
sun.awt

public abstract Class X11InputMethodDescriptor

extends Object
implements InputMethodDescriptor
Class Inheritance
All Implemented Interfaces
java.awt.im.spi.InputMethodDescriptor
Known Direct Subclasses
sun.awt.X11.XInputMethodDescriptor
Imports
java.awt.Image, .Toolkit, java.awt.im.spi.InputMethod, .InputMethodDescriptor, java.util.Locale, sun.awt.SunToolkit

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
1.3

Field Summary

Modifier and TypeField and Description
private static Locale

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public abstract InputMethod
createInputMethod()

Redeclares java.awt.im.spi.InputMethodDescriptor.createInputMethod.

Creates a new instance of the corresponding input method.

public Locale[]
getAvailableLocales()

Implements java.awt.im.spi.InputMethodDescriptor.getAvailableLocales.

Returns the locales supported by the corresponding input method.

public synchronized String
getInputMethodDisplayName(Locale inputLocale, Locale displayLanguage)

Implements java.awt.im.spi.InputMethodDescriptor.getInputMethodDisplayName.

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
getInputMethodIcon(Locale inputLocale)

Implements java.awt.im.spi.InputMethodDescriptor.getInputMethodIcon.

Returns an icon for the corresponding input method.

pack-priv static Locale
getSupportedLocale()

returns supported locale.

public boolean
hasDynamicLocaleList()

Implements java.awt.im.spi.InputMethodDescriptor.hasDynamicLocaleList.

Returns whether the list of available locales can change at runtime.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

localeback to summary
private static Locale locale

Constructor Detail

X11InputMethodDescriptorback to summary
public X11InputMethodDescriptor()

Method Detail

createInputMethodback to summary
public abstract InputMethod createInputMethod() throws Exception

Redeclares java.awt.im.spi.InputMethodDescriptor.createInputMethod.

Doc from java.awt.im.spi.InputMethodDescriptor.createInputMethod.

Creates a new instance of the corresponding input method.

Annotations
@Override
Exceptions
Exception:
any exception that may occur while creating the input method instance
See Also
java.awt.im.spi.InputMethodDescriptor#createInputMethod
getAvailableLocalesback to summary
public Locale[] getAvailableLocales()

Implements java.awt.im.spi.InputMethodDescriptor.getAvailableLocales.

Doc from java.awt.im.spi.InputMethodDescriptor.getAvailableLocales.

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.

Annotations
@Override
See Also
java.awt.im.spi.InputMethodDescriptor#getAvailableLocales
getInputMethodDisplayNameback to summary
public synchronized String getInputMethodDisplayName(Locale inputLocale, Locale displayLanguage)

Implements java.awt.im.spi.InputMethodDescriptor.getInputMethodDisplayName.

Doc from java.awt.im.spi.InputMethodDescriptor.getInputMethodDisplayName.

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.

Annotations
@Override
See Also
java.awt.im.spi.InputMethodDescriptor#getInputMethodDisplayName
getInputMethodIconback to summary
public Image getInputMethodIcon(Locale inputLocale)

Implements java.awt.im.spi.InputMethodDescriptor.getInputMethodIcon.

Doc from java.awt.im.spi.InputMethodDescriptor.getInputMethodIcon.

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.

Annotations
@Override
See Also
java.awt.im.spi.InputMethodDescriptor#getInputMethodIcon
getSupportedLocaleback to summary
pack-priv static Locale getSupportedLocale()

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.

hasDynamicLocaleListback to summary
public boolean hasDynamicLocaleList()

Implements java.awt.im.spi.InputMethodDescriptor.hasDynamicLocaleList.

Doc from java.awt.im.spi.InputMethodDescriptor.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.

Annotations
@Override
See Also
java.awt.im.spi.InputMethodDescriptor#hasDynamicLocaleList