java.awt.im.spi
Interface InputMethodContext

All Superinterfaces:
InputMethodRequests sample code for java.awt.im.InputMethodRequests definition code for java.awt.im.InputMethodRequests

public interface InputMethodContext
extends InputMethodRequests sample code for java.awt.im.InputMethodRequests definition code for java.awt.im.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) sample code for java.awt.im.spi.InputMethod.setInputMethodContext(java.awt.im.spi.InputMethodContext) definition code for java.awt.im.spi.InputMethod.setInputMethodContext(java.awt.im.spi.InputMethodContext) . There should be no other implementors or callers.

Since:
1.3

Method Summary
 JFrame sample code for javax.swing.JFrame definition code for javax.swing.JFrame createInputMethodJFrame sample code for java.awt.im.spi.InputMethodContext.createInputMethodJFrame(java.lang.String, boolean) definition code for java.awt.im.spi.InputMethodContext.createInputMethodJFrame(java.lang.String, boolean) (String sample code for java.lang.String definition code for java.lang.String  title, boolean attachToInputContext)
          Creates a top-level Swing JFrame for use by the input method.
 Window sample code for java.awt.Window definition code for java.awt.Window createInputMethodWindow sample code for java.awt.im.spi.InputMethodContext.createInputMethodWindow(java.lang.String, boolean) definition code for java.awt.im.spi.InputMethodContext.createInputMethodWindow(java.lang.String, boolean) (String sample code for java.lang.String definition code for java.lang.String  title, boolean attachToInputContext)
          Creates a top-level window for use by the input method.
 void dispatchInputMethodEvent sample code for java.awt.im.spi.InputMethodContext.dispatchInputMethodEvent(int, java.text.AttributedCharacterIterator, int, java.awt.font.TextHitInfo, java.awt.font.TextHitInfo) definition code for java.awt.im.spi.InputMethodContext.dispatchInputMethodEvent(int, java.text.AttributedCharacterIterator, int, java.awt.font.TextHitInfo, java.awt.font.TextHitInfo) (int id, AttributedCharacterIterator sample code for java.text.AttributedCharacterIterator definition code for java.text.AttributedCharacterIterator  text, int committedCharacterCount, TextHitInfo sample code for java.awt.font.TextHitInfo definition code for java.awt.font.TextHitInfo  caret, TextHitInfo sample code for java.awt.font.TextHitInfo definition code for java.awt.font.TextHitInfo  visiblePosition)
          Creates an input method event from the arguments given and dispatches it to the client component.
 void enableClientWindowNotification sample code for java.awt.im.spi.InputMethodContext.enableClientWindowNotification(java.awt.im.spi.InputMethod, boolean) definition code for java.awt.im.spi.InputMethodContext.enableClientWindowNotification(java.awt.im.spi.InputMethod, boolean) (InputMethod sample code for java.awt.im.spi.InputMethod definition code for 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.
 
Methods inherited from interface java.awt.im.InputMethodRequests sample code for java.awt.im.InputMethodRequests definition code for java.awt.im.InputMethodRequests
cancelLatestCommittedText sample code for java.awt.im.InputMethodRequests.cancelLatestCommittedText(java.text.AttributedCharacterIterator.Attribute[]) definition code for java.awt.im.InputMethodRequests.cancelLatestCommittedText(java.text.AttributedCharacterIterator.Attribute[]) , getCommittedText sample code for java.awt.im.InputMethodRequests.getCommittedText(int, int, java.text.AttributedCharacterIterator.Attribute[]) definition code for java.awt.im.InputMethodRequests.getCommittedText(int, int, java.text.AttributedCharacterIterator.Attribute[]) , getCommittedTextLength sample code for java.awt.im.InputMethodRequests.getCommittedTextLength() definition code for java.awt.im.InputMethodRequests.getCommittedTextLength() , getInsertPositionOffset sample code for java.awt.im.InputMethodRequests.getInsertPositionOffset() definition code for java.awt.im.InputMethodRequests.getInsertPositionOffset() , getLocationOffset sample code for java.awt.im.InputMethodRequests.getLocationOffset(int, int) definition code for java.awt.im.InputMethodRequests.getLocationOffset(int, int) , getSelectedText sample code for java.awt.im.InputMethodRequests.getSelectedText(java.text.AttributedCharacterIterator.Attribute[]) definition code for java.awt.im.InputMethodRequests.getSelectedText(java.text.AttributedCharacterIterator.Attribute[]) , getTextLocation sample code for java.awt.im.InputMethodRequests.getTextLocation(java.awt.font.TextHitInfo) definition code for java.awt.im.InputMethodRequests.getTextLocation(java.awt.font.TextHitInfo)
 

Method Detail

dispatchInputMethodEvent sample code for java.awt.im.spi.InputMethodContext.dispatchInputMethodEvent(int, java.text.AttributedCharacterIterator, int, java.awt.font.TextHitInfo, java.awt.font.TextHitInfo) definition code for java.awt.im.spi.InputMethodContext.dispatchInputMethodEvent(int, java.text.AttributedCharacterIterator, int, java.awt.font.TextHitInfo, java.awt.font.TextHitInfo)

void dispatchInputMethodEvent(int id,
                              AttributedCharacterIterator sample code for java.text.AttributedCharacterIterator definition code for java.text.AttributedCharacterIterator  text,
                              int committedCharacterCount,
                              TextHitInfo sample code for java.awt.font.TextHitInfo definition code for java.awt.font.TextHitInfo  caret,
                              TextHitInfo sample code for java.awt.font.TextHitInfo definition code for java.awt.font.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) sample code for java.awt.event.InputMethodEvent.InputMethodEvent(java.awt.Component, int, java.awt.font.TextHitInfo, java.awt.font.TextHitInfo) definition code for java.awt.event.InputMethodEvent.InputMethodEvent(java.awt.Component, int, java.awt.font.TextHitInfo, java.awt.font.TextHitInfo) .


createInputMethodWindow sample code for java.awt.im.spi.InputMethodContext.createInputMethodWindow(java.lang.String, boolean) definition code for java.awt.im.spi.InputMethodContext.createInputMethodWindow(java.lang.String, boolean)

Window sample code for java.awt.Window definition code for java.awt.Window  createInputMethodWindow(String sample code for java.lang.String definition code for java.lang.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 sample code for java.awt.Window.dispose() definition code for java.awt.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 sample code for java.awt.HeadlessException definition code for java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true

createInputMethodJFrame sample code for java.awt.im.spi.InputMethodContext.createInputMethodJFrame(java.lang.String, boolean) definition code for java.awt.im.spi.InputMethodContext.createInputMethodJFrame(java.lang.String, boolean)

JFrame sample code for javax.swing.JFrame definition code for javax.swing.JFrame  createInputMethodJFrame(String sample code for java.lang.String definition code for 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: 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 sample code for java.awt.Window.dispose() definition code for java.awt.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 sample code for java.awt.HeadlessException definition code for java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true
Since:
1.4

enableClientWindowNotification sample code for java.awt.im.spi.InputMethodContext.enableClientWindowNotification(java.awt.im.spi.InputMethod, boolean) definition code for java.awt.im.spi.InputMethodContext.enableClientWindowNotification(java.awt.im.spi.InputMethod, boolean)

void enableClientWindowNotification(InputMethod sample code for java.awt.im.spi.InputMethod definition code for 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 notifyClientWindowChange sample code for java.awt.im.spi.InputMethod.notifyClientWindowChange(java.awt.Rectangle) definition code for java.awt.im.spi.InputMethod.notifyClientWindowChange(java.awt.Rectangle) 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