File Doc Category Size Date Package
InputMethodContext.java API Doc Java SE 5 API 5761 Fri Aug 26 14:56:52 BST 2005 java.awt.im.spi

InputMethodContext

public interface InputMethodContext implements 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.

since: 1.3
version: 1.16, 12/19/03
author: JavaSoft International

Fields Summary
Constructors Summary
Methods Summary
public javax.swing.JFrame createInputMethodJFrame(java.lang.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 {@link java.awt.Window#dispose() Window.dispose} on the returned input method window when it is no longer needed.
param
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, "".
param
attachToInputContext whether this window should share the input context that corresponds to this input method context
return
a JFrame with special characteristics for use by input methods
exception
HeadlessException if GraphicsEnvironment.isHeadless returns true
since
1.4
public java.awt.Window createInputMethodWindow(java.lang.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 {@link java.awt.Window#dispose() Window.dispose} on the returned input method window when it is no longer needed.
param
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, "".
param
attachToInputContext whether this window should share the input context that corresponds to this input method context
return
a window with special characteristics for use by input methods
exception
HeadlessException if GraphicsEnvironment.isHeadless returns true
public void dispatchInputMethodEvent(int id, java.text.AttributedCharacterIterator text, int committedCharacterCount, java.awt.font.TextHitInfo caret, java.awt.font.TextHitInfo visiblePosition)
Creates an input method event from the arguments given and dispatches it to the client component. For arguments, see {@link java.awt.event.InputMethodEvent#InputMethodEvent}.
public void enableClientWindowNotification(java.awt.im.spi.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 {@link java.awt.im.spi.InputMethod#notifyClientWindowChange notifyClientWindowChange} method is called as described in that method's specification. Notification is automatically disabled when the input method is disposed.
param
inputMethod the input method for which notifications are enabled or disabled
param
enable true to enable, false to disable