This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


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 {@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

createInputMethodJFrame

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: 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.

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

createInputMethodWindow

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: 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.

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

dispatchInputMethodEvent

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 {@link java.awt.event.InputMethodEvent#InputMethodEvent}.

Parameters:
id
text
committedCharacterCount
caret
visiblePosition

enableClientWindowNotification

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 {@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.

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


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.