Summary: Ctors | Methods | Inherited Methods | [Expand All]

public class

InputMethodContext

extends InputContext
implements InputMethodContext

java.lang.Object
↳	java.awt.im.InputContext
	↳	sun.awt.im.InputContext
		↳	sun.awt.im.InputMethodContext

Class Overview

The InputMethodContext class provides methods that input methods can use to communicate with their client components. It is a subclass of InputContext, which provides methods for use by components.

Summary

Public Constructors
	InputMethodContext() Constructs an InputMethodContext.

Public Methods
AttributedCharacterIterator	cancelLatestCommittedText(Attribute[] attributes) Calls the current client component's implementation of cancelLatestCommittedText.
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	dispatchEvent(AWTEvent event) Dispatches an event to the active 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)
AttributedCharacterIterator	getCommittedText(int beginIndex, int endIndex, Attribute[] attributes) Calls the current client component's implementation of getCommittedText.
int	getCommittedTextLength() Calls the current client component's implementation of getCommittedTextLength.
int	getInsertPositionOffset() Calls the current client component's implementation of getInsertPositionOffset.
TextHitInfo	getLocationOffset(int x, int y) Calls the current client component's implementation of getLocationOffset.
AttributedCharacterIterator	getSelectedText(Attribute[] attributes) Calls the current client component's implementation of getSelectedText.
Rectangle	getTextLocation(TextHitInfo offset) Calls the current client component's implementation of getTextLocation.

[Expand]

Inherited Methods

From class sun.awt.im.InputContext

void	componentHidden(ComponentEvent e) Invoked when the component has been made invisible.
void	componentMoved(ComponentEvent e) Invoked when the component's position changes.
void	componentResized(ComponentEvent e) Invoked when the component's size changes.
void	componentShown(ComponentEvent e) Invoked when the component has been made visible.
void	disableNativeIM() Turns off the native IM.
void	dispatchEvent(AWTEvent event) Dispatches an event to the active input method.
synchronized void	dispose() Releases the resources used by this input context.
synchronized void	endComposition() Ends any input composition that may currently be going on in this context.
synchronized Object	getInputMethodControlObject() Returns a control object from the current input method, or null.
String	getInputMethodInfo()
Locale	getLocale() Returns the current locale of the current input method or keyboard layout.
boolean	isCompositionEnabled() Determines whether the current input method is enabled for composition.
synchronized void	reconvert() Asks the current input method to reconvert text from the current client component.
synchronized void	removeNotify(Component component) Notifies the input context that a client component has been removed from its containment hierarchy, or that input method support has been disabled for the component.
synchronized boolean	selectInputMethod(Locale locale) Attempts to select an input method or keyboard layout that supports the given locale, and returns a value indicating whether such an input method or keyboard layout has been successfully selected.
void	setCharacterSubsets(Subset[] subsets) Sets the subsets of the Unicode character set that input methods of this input context should be allowed to input.
void	setCompositionEnabled(boolean enable) Enables or disables the current input method for composition, depending on the value of the parameter `enable`.
void	windowActivated(WindowEvent e) Invoked when the Window is set to be the active Window.
void	windowClosed(WindowEvent e) Invoked when a window has been closed as the result of calling dispose on the window.
void	windowClosing(WindowEvent e) Invoked when the user attempts to close the window from the window's system menu.
void	windowDeactivated(WindowEvent e) Invoked when a Window is no longer the active Window.
void	windowDeiconified(WindowEvent e) Invoked when a window is changed from a minimized to a normal state.
void	windowIconified(WindowEvent e) Invoked when a window is changed from a normal to a minimized state.
void	windowOpened(WindowEvent e) Invoked the first time a window is made visible.

From class java.awt.im.InputContext

void	dispatchEvent(AWTEvent event) Dispatches an event to the active input method.
void	dispose() Releases the resources used by this input context.
void	endComposition() Ends any input composition that may currently be going on in this context.
Object	getInputMethodControlObject() Returns a control object from the current input method, or null.
static InputContext	getInstance() Returns a new InputContext instance.
Locale	getLocale() Returns the current locale of the current input method or keyboard layout.
boolean	isCompositionEnabled() Determines whether the current input method is enabled for composition.
void	reconvert() Asks the current input method to reconvert text from the current client component.
void	removeNotify(Component client) Notifies the input context that a client component has been removed from its containment hierarchy, or that input method support has been disabled for the component.
boolean	selectInputMethod(Locale locale) Attempts to select an input method or keyboard layout that supports the given locale, and returns a value indicating whether such an input method or keyboard layout has been successfully selected.
void	setCharacterSubsets(Subset[] subsets) Sets the subsets of the Unicode character set that input methods of this input context should be allowed to input.
void	setCompositionEnabled(boolean enable) Enables or disables the current input method for composition, depending on the value of the parameter `enable`.

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

From interface java.awt.event.ComponentListener

From interface java.awt.event.WindowListener

From interface java.awt.im.InputMethodRequests

abstract AttributedCharacterIterator	cancelLatestCommittedText(Attribute[] attributes) Gets the latest committed text from the text editing component and removes it from the component's text body.
abstract AttributedCharacterIterator	getCommittedText(int beginIndex, int endIndex, Attribute[] attributes) Gets an iterator providing access to the entire text and attributes contained in the text editing component except for uncommitted text.
abstract int	getCommittedTextLength() Gets the length of the entire text contained in the text editing component except for uncommitted (composed) text.
abstract int	getInsertPositionOffset() Gets the offset of the insert position in the committed text contained in the text editing component.
abstract TextHitInfo	getLocationOffset(int x, int y) Gets the offset within the composed text for the specified absolute x and y coordinates on the screen.
abstract AttributedCharacterIterator	getSelectedText(Attribute[] attributes) Gets the currently selected text from the text editing component.
abstract Rectangle	getTextLocation(TextHitInfo offset) Gets the location of a specified offset in the current composed text, or of the selection in committed text.

From interface java.awt.im.spi.InputMethodContext

Public Constructors

public InputMethodContext ()

Constructs an InputMethodContext.

Public Methods

public AttributedCharacterIterator cancelLatestCommittedText (Attribute[] attributes)

Calls the current client component's implementation of cancelLatestCommittedText.

Parameters

attributes	a list of attributes that the input method is interested in

Returns

the latest committed text, or null when the "Undo Commit" feature is not supported

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:

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

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:

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

public void dispatchEvent (AWTEvent event)

Dispatches an event to the active input method. Called by AWT. If no input method is available, then the event will never be consumed.

Parameters

event	The event

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 InputMethodEvent(Component, int, long, AttributedCharacterIterator, int, TextHitInfo, TextHitInfo).

public void enableClientWindowNotification (InputMethod inputMethod, boolean enable)

public AttributedCharacterIterator getCommittedText (int beginIndex, int endIndex, Attribute[] attributes)

Calls the current client component's implementation of getCommittedText.

Parameters

beginIndex	the index of the first character
endIndex	the index of the character following the last character
attributes	a list of attributes that the input method is interested in

Returns

an iterator providing access to the text and its attributes

public int getCommittedTextLength ()

Calls the current client component's implementation of getCommittedTextLength.

Returns

the length of the text except for uncommitted text

public int getInsertPositionOffset ()

Calls the current client component's implementation of getInsertPositionOffset.

Returns

the offset of the insert position

public TextHitInfo getLocationOffset (int x, int y)

Calls the current client component's implementation of getLocationOffset.

Parameters

x	the absolute x coordinate on screen
y	the absolute y coordinate on screen

Returns

a text hit info describing the offset in the composed text.

public AttributedCharacterIterator getSelectedText (Attribute[] attributes)

Calls the current client component's implementation of getSelectedText.

Parameters

attributes	a list of attributes that the input method is interested in

Returns

the currently selected text

public Rectangle getTextLocation (TextHitInfo offset)

Calls the current client component's implementation of getTextLocation.

Parameters

offset	the offset within the composed text, if there is composed text; null otherwise

Returns

a rectangle representing the screen location of the offset

Interfaces

Classes

InputMethodContext

Class Overview

Summary

Public Constructors

public InputMethodContext ()

Public Methods

public AttributedCharacterIterator cancelLatestCommittedText (Attribute[] attributes)

Parameters

Returns

public JFrame createInputMethodJFrame (String title, boolean attachToInputContext)

Parameters

Returns

public Window createInputMethodWindow (String title, boolean attachToInputContext)

Parameters

Returns

public void dispatchEvent (AWTEvent event)

Parameters

public void dispatchInputMethodEvent (int id, AttributedCharacterIterator text, int committedCharacterCount, TextHitInfo caret, TextHitInfo visiblePosition)

public void enableClientWindowNotification (InputMethod inputMethod, boolean enable)

See Also

public AttributedCharacterIterator getCommittedText (int beginIndex, int endIndex, Attribute[] attributes)

Parameters

Returns

public int getCommittedTextLength ()

Returns

public int getInsertPositionOffset ()

Returns

public TextHitInfo getLocationOffset (int x, int y)

Parameters

Returns

public AttributedCharacterIterator getSelectedText (Attribute[] attributes)

Parameters

Returns

public Rectangle getTextLocation (TextHitInfo offset)

Parameters

Returns