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

Interface InputMethod

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


public interface InputMethod

This interface supports complex text input, often for situations where the text is more complex than a keyboard will accomodate. For example, this can be used for Chinese, Japanese, and Korean, where multiple keystrokes are necessary to compose text. This could also support things like phonetic English, or reordering Thai.

These contexts can be loaded by the input method framework, using InputContext#selectInputMethod(Locale).

Since:Author:

Method Summary

voidactivate()

Activate this input method for input processing.
voiddeactivate(boolean isTemporary)

Deactivate this input method, either temporarily or permanently for the given client.
voiddispatchEvent(java.awt.AWTEvent event)

Dispatch an event to the input method.
voiddispose()

Disposes the input method and release any resources it is using.
voidendComposition()

End any input composition currently taking place.
java.lang.ObjectgetControlObject()

Returns a control object from this input method, or null.
java.util.LocalegetLocale()

Returns the current input locale, or null if none is defined.
voidhideWindows()

Close or hide all windows opened by this input method.
booleanisCompositionEnabled()

Find out if this input method is enabled.
voidnotifyClientWindowChange(java.awt.Rectangle bounds)

Notify this input method of changes in the client window.
voidreconvert()

Starts a reconversion operation.
voidremoveNotify()

Notify the input method that a client component has been removed from its hierarchy, or that input method support has been disabled.
voidsetCharacterSubsets(java.lang.Character.Subset[] subsets)

Sets the allowed Unicode subsets that this input method can use.
voidsetCompositionEnabled(boolean enable)

Changes the enabled status of this input method.
voidsetInputMethodContext(java.awt.im.spi.InputMethodContext context)

Set the input method context, which ties the input method to a client component.
booleansetLocale(java.util.Locale locale)

Sets the input locale.

Method Details

activate

public void activate()

Activate this input method for input processing. If the input method provides its own windows, it should make them open and visible at this time. This method is called when a client component receives a FOCUS_GAINED event, or when switching to this input method from another one. It is only called when the input method is inactive, assuming that new instances begin in an inactive state.


deactivate

public void deactivate(boolean isTemporary)

Deactivate this input method, either temporarily or permanently for the given client. If the input method provides its own windows, it should only close those related to the current composition (such as a lookup choice panel), while leaving more persistant windows (like a control panel) open to avoid screen flicker. Before control is given to another input method, #hideWindows() will be called on this instance. This method is called when a client component receives a FOCUS_LOST event, when switching to another input method, or before #removeNotify() when the client is removed.

Parameters:


dispatchEvent

public void dispatchEvent(java.awt.AWTEvent event)

Dispatch an event to the input method. If input method support is enabled, certain events are dispatched to the input method before the client component or event listeners. The input method must either consume the event or pass it on to the component. Instances of InputEvent, including KeyEvent and MouseEvent, are given to this input method. This method is called by InputContext#dispatchEvent(AWTEvent).

Parameters:

Throws:


dispose

public void dispose()

Disposes the input method and release any resources it is using. In particular, the input method should dispose windows and close files. This is called by InputContext#dispose(), when the input method is inactive; and nothing will be called on this instance afterwards.


endComposition

public void endComposition()

End any input composition currently taking place. Depending on the platform and user preferences, this may commit or delete uncommitted text, using input method events. This may be called for a variety of reasons, such as when the user moves the insertion point in the client text outside the range of the composed text, or when text is saved to file. This is called by InputContext#endComposition(), when switching to a new input method, or by InputContext#selectInputMethod(Locale).


getControlObject

public Object getControlObject()

Returns a control object from this input method, or null. A control object provides method to control the behavior of this input method, as well as query information about it. The object is implementation dependent, so clients must compare the result against known input method control object types. This is called by InputContext#getInputMethodControlObject().

Returns:


getLocale

public Locale getLocale()

Returns the current input locale, or null if none is defined. This is called by InputContext#getLocale(), or before switching input methods.

Returns:


hideWindows

public void hideWindows()

Close or hide all windows opened by this input method. This is called before activating a different input method, and before calling #dispose() on this instance. It is only called when the input method is inactive.


isCompositionEnabled

public boolean isCompositionEnabled()

Find out if this input method is enabled. This is called by InputContext#isCompositionEnabled(), or when switching input methods via InputContext#selectInputMethod(Locale).

Returns:

Throws:

See Also:


notifyClientWindowChange

public void notifyClientWindowChange(java.awt.Rectangle bounds)

Notify this input method of changes in the client window. This is called when notifications are enabled (see InputMethodContext#enableClientWindowNotification(InputMethod, boolean), if #removeNotify(Component) has not been called. The following situations trigger a notification:

Parameters:


reconvert

public void reconvert()

Starts a reconversion operation. The input method gets its text from the client, using InputMethodRequests#getSelectedText(Attribute[]). Then the composed and committed text produced by the operation is sent back to the client using a sequence of InputMethodEvents. This is called by InputContext#reconvert().

Throws:


removeNotify

public void removeNotify()

Notify the input method that a client component has been removed from its hierarchy, or that input method support has been disabled. This is called by InputContext#removeNotify(), and only when the input method is inactive.


setCharacterSubsets

public void setCharacterSubsets(java.lang.Character.Subset[] subsets)

Sets the allowed Unicode subsets that this input method can use. Null indicates that all characters are allowed. This is called after creation, or when switching to this input method, by InputContext#setCharacterSubsets(Character.Subset[]).

Parameters:


setCompositionEnabled

public void setCompositionEnabled(boolean enable)

Changes the enabled status of this input method. An enabled input method accepts incoming events for composition and control purposes, while a disabled input method ignores events (except for control purposes). This is called by InputContext#setCompositionEnabled(boolean) or when switching from an input method if the previous input method returned without exception on #isCompositionEnabled().

Parameters:

Throws:

See Also:


setInputMethodContext

public void setInputMethodContext(java.awt.im.spi.InputMethodContext context)

Set the input method context, which ties the input method to a client component. This is called once automatically when creating the input method.

Parameters:

Throws:


setLocale

public boolean setLocale(java.util.Locale locale)

Sets the input locale. If the input method supports that locale, it changes its behavior to be consistent with the locale and returns true. Otherwise, it returns false. This is called by InputContext#selectInputMethod(Locale) when the user specifies a locale, or when the previously selected input method had a locale.

Parameters:

Returns:

Throws: