APIdia Launch Partner
Top Description Fields Constructors Methods
sun.awt.im

public abstract Class InputMethodAdapter

extends Object
implements InputMethod
Class Inheritance
All Implemented Interfaces
java.awt.im.spi.InputMethod
Known Direct Subclasses
sun.awt.X11InputMethodBase
Imports
java.awt.Component, .Rectangle, java.awt.im.spi.InputMethod
An input method adapter interfaces with the native input methods on a host platform. In general, it looks to the input method framework like a Java input method (that may support a few more locales than a typical Java input method). However, since it often has to work in a slightly hostile environment that's not designed for easy integration into the Java input method framework, it gets some special treatment that's not available to Java input methods.

Licensees are free to modify this class as necessary to implement their host input method adapters.

Author
JavaSoft International

Field Summary

Modifier and TypeField and Description
private Component
clientComponent

Constructor Summary

AccessConstructor and Description
public
InputMethodAdapter()

Method Summary

Modifier and TypeMethod and Description
public abstract void
disableInputMethod()

Disable the native input method.

protected Component
getClientComponent()

public abstract String
getNativeInputMethodInfo()

Returns a string with information about the native input method, or null.

protected boolean
haveActiveClient()

public void
notifyClientWindowChange(Rectangle location)

Implements java.awt.im.spi.InputMethod.notifyClientWindowChange.

Notifies client Window location or status changes

public void
reconvert()

Implements java.awt.im.spi.InputMethod.reconvert.

Starts reconvertion.

protected void
setAWTFocussedComponent(Component component)

Informs the input method adapter about the component that has the AWT focus if it's using the input context owning this adapter instance.

pack-priv void
setClientComponent(Component client)

protected void
stopListening()

Informs the input method adapter not to listen to the native events.

protected boolean
supportsBelowTheSpot()

Returns whether host input methods can support below-the-spot input.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

clientComponentback to summary
private Component clientComponent

Constructor Detail

InputMethodAdapterback to summary
public InputMethodAdapter()

Method Detail

disableInputMethodback to summary
public abstract void disableInputMethod()

Disable the native input method. This method is provided for explicitly turning off the native IM. The native IM is not turned off when the native input method is deactivated. This method is always called on AWT EDT. See details in bug 6226489.

getClientComponentback to summary
protected Component getClientComponent()
getNativeInputMethodInfoback to summary
public abstract String getNativeInputMethodInfo()

Returns a string with information about the native input method, or null.

haveActiveClientback to summary
protected boolean haveActiveClient()
notifyClientWindowChangeback to summary
public void notifyClientWindowChange(Rectangle location)

Implements java.awt.im.spi.InputMethod.notifyClientWindowChange.

Notifies client Window location or status changes

reconvertback to summary
public void reconvert()

Implements java.awt.im.spi.InputMethod.reconvert.

Starts reconvertion. An implementing host adapter has to override this method if it can support reconvert().

Exceptions
UnsupportedOperationException:
when the adapter does not override the method.
setAWTFocussedComponentback to summary
protected void setAWTFocussedComponent(Component component)

Informs the input method adapter about the component that has the AWT focus if it's using the input context owning this adapter instance.

setClientComponentback to summary
pack-priv void setClientComponent(Component client)
stopListeningback to summary
protected void stopListening()

Informs the input method adapter not to listen to the native events.

supportsBelowTheSpotback to summary
protected boolean supportsBelowTheSpot()

Returns whether host input methods can support below-the-spot input. Returns false by default.