javafx.scene.input

Class InputMethodEvent

java.lang.Object

Event

javafx.scene.input.InputEvent

javafx.scene.input.InputMethodEvent

public final 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 javafx.scene.control.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.

Since:

JavaFX 2.0

Field Summary

Fields

Modifier and Type	Field and Description
static <any>	ANY Common supertype for all input method event types.
private int	caretPosition The input method caret position within the composed text.
private java.lang.String	committed The text that is committed by the input method as the result of the composition.
private <any>	composed The text under composition.
static <any>	INPUT_METHOD_TEXT_CHANGED The only valid EventType for the InputMethodEvent.
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
InputMethodEvent(<any> eventType, java.util.List<InputMethodTextRun> composed, java.lang.String committed, int caretPosition) Constructs new InputMethodEvent event with empty source and target.
InputMethodEvent(java.lang.Object source, EventTarget target, <any> eventType, java.util.List<InputMethodTextRun> composed, java.lang.String committed, int caretPosition) Constructs new InputMethodEvent event.

Method Summary

Modifier and Type	Method and Description
InputMethodEvent	copyFor(java.lang.Object newSource, EventTarget newTarget)
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.
<any>	getComposed() Gets the text under composition.
<any>	getEventType()
private void	readObject(java.io.ObjectInputStream ois)
java.lang.String	toString() Returns a string representation of this InputMethodEvent object.
private void	writeObject(java.io.ObjectOutputStream oos)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

INPUT_METHOD_TEXT_CHANGED

public static final <any> INPUT_METHOD_TEXT_CHANGED

The only valid EventType for the InputMethodEvent.

ANY

public static final <any> ANY

Common supertype for all input method event types.

Since:

JavaFX 8.0

composed

private transient <any> composed

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

committed

private final java.lang.String committed

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

caretPosition

private final int caretPosition

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

Constructor Detail

InputMethodEvent

public InputMethodEvent(java.lang.Object source,
                        EventTarget target,
                        <any> eventType,
                        java.util.List<InputMethodTextRun> composed,
                        java.lang.String committed,
                        int caretPosition)

Constructs new InputMethodEvent event.

Parameters:

source - the source of the event. Can be null.

target - the target of the event. Can be null.

eventType - The type of the event.

composed - the text under composition

committed - the text that is committed as a result of composition

caretPosition - the current position of the caret.

Since:

JavaFX 8.0

InputMethodEvent

public InputMethodEvent(<any> eventType,
                        java.util.List<InputMethodTextRun> composed,
                        java.lang.String committed,
                        int caretPosition)

Constructs new InputMethodEvent event with empty source and target.

Parameters:

eventType - The type of the event.

composed - the text under composition

committed - the text that is committed as a result of composition

caretPosition - the current position of the caret.

Since:

JavaFX 8.0

Method Detail

getComposed

public final <any> 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.

Returns:

a string representation of this InputMethodEvent object.

copyFor

public InputMethodEvent copyFor(java.lang.Object newSource,
                                EventTarget newTarget)

getEventType

public <any> getEventType()

Overrides:

getEventType in class InputEvent

writeObject

private void writeObject(java.io.ObjectOutputStream oos)
                  throws java.io.IOException

Throws:

java.io.IOException

readObject

private void readObject(java.io.ObjectInputStream ois)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException