Java™ Platform
Standard Ed. 6

java.awt.im.spi
Interface InputMethodContext

All Superinterfaces:
InputMethodRequests

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 InputMethod.setInputMethodContext(java.awt.im.spi.InputMethodContext). There should be no other implementors or callers.

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 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 interface java.awt.im.InputMethodRequests
cancelLatestCommittedText, getCommittedText, getCommittedTextLength, getInsertPositionOffset, getLocationOffset, getSelectedText, getTextLocation
 

Method Detail

dispatchInputMethodEvent

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 InputMethodEvent.InputMethodEvent(java.awt.Component, int, java.awt.font.TextHitInfo, java.awt.font.TextHitInfo).


createInputMethodWindow

Window createInputMethodWindow(String title,
                               boolean attachToInputContext)
Creates a top-level window for use by the input method. The intended behavior of this window is: 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 - 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 context
Returns:
a window with special characteristics for use by input methods
Throws:
HeadlessException - if GraphicsEnvironment.isHeadless returns true

createInputMethodJFrame

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: 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 - 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 context
Returns:
a JFrame with special characteristics for use by input methods
Throws:
HeadlessException - if GraphicsEnvironment.isHeadless returns true
Since:
1.4

enableClientWindowNotification

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 - the input method for which notifications are enabled or disabled
enable - true to enable, false to disable

Java™ Platform
Standard Ed. 6

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.

Scripting on this page tracks web page traffic, but does not change the content in any way.