| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface InputMethodContext extends InputMethodRequests
Provides methods that input methods can use to communicate with their client components or to request other services. This interface is implemented by the input method framework, and input methods call its methods on the instance they receive through {@link java.awt.im.spi.InputMethod#setInputMethodContext}. There should be no other implementors or callers.
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 committedCharacterCount, TextHitInfo caret, TextHitInfo visiblePosition) Creates an input method event from the arguments given and dispatches it to the client component. |
void |
enableClientWindowNotification(InputMethod inputMethod, boolean enable) Enables or disables notification of the current client window's location and state for the specified input method. |
Methods inherited from class java.awt.im.InputMethodRequests |
---|
cancelLatestCommittedText, getCommittedText, getCommittedTextLength, getInsertPositionOffset, getLocationOffset, getSelectedText, getTextLocation |
Method Detail |
---|
public JFrame createInputMethodJFrame(String title, boolean attachToInputContext)
The title may or may not be displayed, depending on the actual type of window created.
If attachToInputContext is true, the new window will share the input context that corresponds to this input method context, so that events for components in the window are automatically dispatched to the input method. Also, when the window is opened using setVisible(true), the input context will prevent deactivate and activate calls to the input method that might otherwise be caused.
Input methods must call {@link java.awt.Window#dispose() Window.dispose} on the returned input method window when it is no longer needed.
title
- the title to be displayed in the window's title bar,
if there is such a title bar.
A null
value is treated as an empty string, "".attachToInputContext
- whether this window should share the input context
that corresponds to this input method contextpublic Window createInputMethodWindow(String title, boolean attachToInputContext)
The title may or may not be displayed, depending on the actual type of window created.
If attachToInputContext is true, the new window will share the input context that corresponds to this input method context, so that events for components in the window are automatically dispatched to the input method. Also, when the window is opened using setVisible(true), the input context will prevent deactivate and activate calls to the input method that might otherwise be caused.
Input methods must call {@link java.awt.Window#dispose() Window.dispose} on the returned input method window when it is no longer needed.
title
- the title to be displayed in the window's title bar,
if there is such a title bar.
A null
value is treated as an empty string, "".attachToInputContext
- whether this window should share the input context
that corresponds to this input method contextpublic void dispatchInputMethodEvent(int id, AttributedCharacterIterator text, int committedCharacterCount, TextHitInfo caret, TextHitInfo visiblePosition)
id
text
committedCharacterCount
caret
visiblePosition
public void enableClientWindowNotification(InputMethod inputMethod, boolean enable)
inputMethod
- the input method for which notifications are
enabled or disabledenable
- true to enable, false to disable
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |