java.awt.im.spi
Interface InputMethodContext

All Superinterfaces:
InputMethodRequests

public interface InputMethodContext
extends InputMethodRequests

Provides methods for the communication context between an input method and the client component. This should be passed to InputMethod.setInputMethodContext(InputMethodContext).

Since:
1.3

Method Summary
 JFrame createInputMethodJFrame(String title, boolean attachToInputContext)
          Creates a top-level Swing JFrame for use by the input method.
 Window createInputMethodWindow(String title, boolean attachToInputContext)
          Creates a top-level window for use by the input method.
 void dispatchInputMethodEvent(int id, AttributedCharacterIterator text, int count, TextHitInfo caret, TextHitInfo visiblePosition)
          Create an input method event and dispatch it to the client.
 void enableClientWindowNotification(InputMethod inputMethod, boolean enable)
          Sets whether notification of the client window's location and state should be enabled for the input method.
 
Methods inherited from interface java.awt.im.InputMethodRequests
cancelLatestCommittedText, getCommittedText, getCommittedTextLength, getInsertPositionOffset, getLocationOffset, getSelectedText, getTextLocation
 

Method Detail

dispatchInputMethodEvent

void dispatchInputMethodEvent(int id,
                              AttributedCharacterIterator text,
                              int count,
                              TextHitInfo caret,
                              TextHitInfo visiblePosition)
Create an input method event and dispatch it to the client.

Parameters:
id - the event type
text - an iterator over the text to be committed
count - the count of characters to be committed
caret - the insertion point of the commit, or null
visiblePosition - the best location to make visible, or null

createInputMethodWindow

Window createInputMethodWindow(String title,
                               boolean attachToInputContext)
Creates a top-level window for use by the input method. This window should float above all document windows and dialogs, not receive focus, and have lightweight decorations (such as no title, reduced drag regions). But this behavior may be modified to meet the platform style. The title may or may not be displayed, depending on the platform.

If attachToInputContext is true, the new window will share the input context of the input method, so that events in the new window are dispatched to the input method. Also, this supresses deactivate and activate calls to the input method caused by setVisible.

Parameters:
title - the window title, if one is displayed; null becomes ""
attachToInputContext - true for the window to share context with the input method
Returns:
the new window for use by the input method
Throws:
HeadlessException - if GraphicsEnvironment.isHeadless is true

createInputMethodJFrame

JFrame createInputMethodJFrame(String title,
                               boolean attachToInputContext)
Creates a top-level Swing JFrame for use by the input method. This frame should float above all document windows and dialogs, not receive focus, and have lightweight decorations (such as no title, reduced drag regions). But this behavior may be modified to meet the platform style. The title may or may not be displayed, depending on the platform.

If attachToInputContext is true, the new window will share the input context of the input method, so that events in the new window are dispatched to the input method. Also, this supresses deactivate and activate calls to the input method caused by setVisible.

Parameters:
title - the window title, if one is displayed; null becomes ""
attachToInputContext - true for the window to share context with the input method
Returns:
the new window for use by the input method
Throws:
HeadlessException - if GraphicsEnvironment.isHeadless is true
Since:
1.4

enableClientWindowNotification

void enableClientWindowNotification(InputMethod inputMethod,
                                    boolean enable)
Sets whether notification of the client window's location and state should be enabled for the input method. When enabled, the input method's InputMethod.notifyClientWindowChange(Rectangle) method is called. Notification is automatically disabled when the input method is disposed.

Parameters:
inputMethod - the method to change status of
enable - true to enable notification