-
- 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 throughInputMethod.setInputMethodContext(java.awt.im.spi.InputMethodContext)
. There should be no other implementors or callers.- Since:
- 1.3
-
-
Method Summary
Methods Modifier and Type Method and Description 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, seeInputMethodEvent.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:- 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
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. Anull
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
- ifGraphicsEnvironment.isHeadless
returnstrue
-
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:- 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
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. Anull
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
- ifGraphicsEnvironment.isHeadless
returnstrue
- 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'snotifyClientWindowChange
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 disabledenable
- true to enable, false to disable
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/awt/im/spi/InputMethodContext.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.