OpenJDK 27 · java.awt.im.spi.InputMethodContext · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public JFrame	Returns: a JFrame with special characteristics for use by input methods createInputMethodJFrame(String 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, "". title, boolean whether this window should share the input context that corresponds to this input method context attachToInputContext) Creates a top-level Swing JFrame for use by the input method.
public Window	Returns: a window with special characteristics for use by input methods createInputMethodWindow(String 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, "". title, boolean whether this window should share the input context that corresponds to this input method context attachToInputContext) Creates a top-level window for use by the input method.
public void	dispatchInputMethodEvent(int the event type id, AttributedCharacterIterator the combined committed and composed text text, int the number of committed characters in the text committedCharacterCount, TextHitInfo the caret (a.k.a. insertion point); null if there's no caret within current composed text caret, TextHitInfo the position that's most important to be visible; null if there's no recommendation for a visible position within current composed text visiblePosition) Creates an input method event from the arguments given and dispatches it to the client component.
public void	enableClientWindowNotification(InputMethod the input method for which notifications are enabled or disabled inputMethod, boolean true to enable, false to disable enable) Enables or disables notification of the current client window's location and state for the specified input method.

Inherited from java.awt.im.InputMethodRequests:: cancelLatestCommittedText getCommittedText getCommittedTextLength getInsertPositionOffset getLocationOffset getSelectedText getTextLocation

Method Detail

createInputMethodJFrame back to summary

createInputMethodJFrame	back to summary
public JFrame createInputMethodJFrame(String title, boolean attachToInputContext) Creates a top-level Swing JFrame for use by the input method. The intended behavior of this window is: it floats above all document windows and dialogs it and all components that it contains do not receive the focus it has lightweight decorations, such as a reduced drag region without title However, the actual behavior with respect to these three items is platform dependent. 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 `Window.dispose` on the returned input method window when it is no longer needed. Parameters title:String 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:boolean whether this window should share the input context that corresponds to this input method context Returns:JFrame a JFrame with special characteristics for use by input methods Exceptions HeadlessException: if `GraphicsEnvironment.isHeadless` returns `true` Since 1.4

public JFrame createInputMethodJFrame(String title, boolean attachToInputContext)

Creates a top-level Swing JFrame for use by the input method. The intended behavior of this window is:

it floats above all document windows and dialogs
it and all components that it contains do not receive the focus
it has lightweight decorations, such as a reduced drag region without title

However, the actual behavior with respect to these three items is platform dependent.

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 Window.dispose on the returned input method window when it is no longer needed.

Parameters

title:String: 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:boolean: whether this window should share the input context that corresponds to this input method context

Returns:JFrame

a JFrame with special characteristics for use by input methods

Exceptions

HeadlessException:: if GraphicsEnvironment.isHeadless returns true

Since

1.4

createInputMethodWindow back to summary

createInputMethodWindow	back to summary
public Window createInputMethodWindow(String title, boolean attachToInputContext) Creates a top-level window for use by the input method. The intended behavior of this window is: it floats above all document windows and dialogs it and all components that it contains do not receive the focus it has lightweight decorations, such as a reduced drag region without title However, the actual behavior with respect to these three items is platform dependent. 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 `Window.dispose` on the returned input method window when it is no longer needed. Parameters title:String 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:boolean whether this window should share the input context that corresponds to this input method context Returns:Window a window with special characteristics for use by input methods Exceptions HeadlessException: if `GraphicsEnvironment.isHeadless` returns `true`

public Window createInputMethodWindow(String title, boolean attachToInputContext)

Creates a top-level window for use by the input method. The intended behavior of this window is:

it floats above all document windows and dialogs
it and all components that it contains do not receive the focus
it has lightweight decorations, such as a reduced drag region without title

However, the actual behavior with respect to these three items is platform dependent.

The title may or may not be displayed, depending on the actual type of window created.

Input methods must call Window.dispose on the returned input method window when it is no longer needed.

Parameters

title:String: 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:boolean: whether this window should share the input context that corresponds to this input method context

Returns:Window

a window with special characteristics for use by input methods

Exceptions

HeadlessException:: if GraphicsEnvironment.isHeadless returns true

dispatchInputMethodEvent back to summary

dispatchInputMethodEvent	back to summary
public 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. For arguments, see `java.awt.event.InputMethodEvent#InputMethodEvent`. Parameters id:int the event type text:AttributedCharacterIterator the combined committed and composed text committedCharacterCount:int the number of committed characters in the text caret:TextHitInfo the caret (a.k.a. insertion point); null if there's no caret within current composed text visiblePosition:TextHitInfo the position that's most important to be visible; null if there's no recommendation for a visible position within current composed text

public 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. For arguments, see java.awt.event.InputMethodEvent#InputMethodEvent.

Parameters

id:int: the event type
text:AttributedCharacterIterator: the combined committed and composed text
committedCharacterCount:int: the number of committed characters in the text
caret:TextHitInfo: the caret (a.k.a. insertion point); null if there's no caret within current composed text
visiblePosition:TextHitInfo: the position that's most important to be visible; null if there's no recommendation for a visible position within current composed text

enableClientWindowNotification back to summary

enableClientWindowNotification	back to summary
public void enableClientWindowNotification(InputMethod inputMethod, boolean enable) Enables or disables notification of the current client window's location and state for the specified input method. When notification is enabled, the input method's `notifyClientWindowChange` method is called as described in that method's specification. Notification is automatically disabled when the input method is disposed. Parameters inputMethod:InputMethod the input method for which notifications are enabled or disabled enable:boolean true to enable, false to disable

public void enableClientWindowNotification(InputMethod inputMethod, boolean enable)

Enables or disables notification of the current client window's location and state for the specified input method. When notification is enabled, the input method's notifyClientWindowChange method is called as described in that method's specification. Notification is automatically disabled when the input method is disposed.

Parameters

inputMethod:InputMethod: the input method for which notifications are enabled or disabled
enable:boolean: true to enable, false to disable

public Interface InputMethodContext

Method Summary

Method Detail