javafx.scene.input

Class InputMethodEvent

java.lang.Object

java.util.EventObject

javafx.event.Event

javafx.scene.input.InputEvent

javafx.scene.input.InputMethodEvent

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class InputMethodEvent
extends InputEvent

An event which indicates that the underlying input method notifies its text change in a Node.

This event is delivered to the Node object that extends TextInputControl, when the text under composition (composed text) is generated/changed/removed, the input method commits the result text, or the input method caret position changes.

On receiving this event, the application is supposed to display the composed text with any visual feedback attributes to the user.

Note: this is a conditional feature. See ConditionalFeature.INPUT_METHOD for more information.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static EventType<InputMethodEvent>	INPUT_METHOD_TEXT_CHANGED The only valid EventType for the InputMethodEvent.

Fields inherited from class javafx.scene.input.InputEvent

ANY

Fields inherited from class javafx.event.Event

consumed, eventType, NULL_SOURCE_TARGET, target

Fields inherited from class java.util.EventObject

source

Method Summary

Methods

Modifier and Type	Method and Description
int	getCaretPosition() The input method caret position within the composed text.
java.lang.String	getCommitted() Gets the text that is committed by the input method as the result of the composition.
ObservableList<InputMethodTextRun>	getComposed() Gets the text under composition.
java.lang.String	toString() Returns a string representation of this InputMethodEvent object.

Methods inherited from class javafx.event.Event

clone, consume, copyFor, fireEvent, getEventType, getTarget, isConsumed

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

INPUT_METHOD_TEXT_CHANGED

public static final EventType<InputMethodEvent> INPUT_METHOD_TEXT_CHANGED

The only valid EventType for the InputMethodEvent.

Method Detail

getComposed

public final ObservableList<InputMethodTextRun> getComposed()

Gets the text under composition. This text should be displayed with the appropriate visual feedback that represents the InputMethodHighlights attached to each run.

Returns:

The text under composition

getCommitted

public final java.lang.String getCommitted()

Gets the text that is committed by the input method as the result of the composition.

Returns:

The committed text

getCaretPosition

public final int getCaretPosition()

The input method caret position within the composed text. If the position is -1, the caret should be invisible.

Returns:

The input method caret position within the composed text

toString

public java.lang.String toString()

Returns a string representation of this InputMethodEvent object.

Overrides:

toString in class java.util.EventObject

Returns:

a string representation of this InputMethodEvent object.