Class InputMethodEvent

java.lang.Object

java.util.EventObject

java.awt.AWTEvent

vaadinx.awt.event.InputMethodEvent

All Implemented Interfaces:

Serializable

public class InputMethodEvent
extends AWTEvent

Port of InputMethodEvent. Niche — used by IME text-composition pipelines. Ported for completeness since Component exposes input-method listener methods and the type surface needs a consistent root.

Sub-objects (AttributedCharacterIterator, TextHitInfo) have no Component references, so we reuse them unchanged from the JDK per D_whitelist_porting.

consume() / isConsumed() are public here as in the JDK, with the same caveat as InputEvent: the flag round-trips but vetoes nothing, since the browser has already acted. See D_event_consume.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CARET_POSITION_CHANGED
static final int	INPUT_METHOD_FIRST
static final int	INPUT_METHOD_LAST
static final int	INPUT_METHOD_TEXT_CHANGED

Fields inherited from class AWTEvent

ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, id, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, MOUSE_WHEEL_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, WINDOW_STATE_EVENT_MASK

Fields inherited from class EventObject

source

Constructor Summary

Constructors

Constructor	Description
InputMethodEvent(Component source, int id, long when, AttributedCharacterIterator text, int committedCharacterCount, TextHitInfo caret, TextHitInfo visiblePosition)
InputMethodEvent(Component source, int id, TextHitInfo caret, TextHitInfo visiblePosition)
InputMethodEvent(Component source, int id, AttributedCharacterIterator text, int committedCharacterCount, TextHitInfo caret, TextHitInfo visiblePosition)

Method Summary

Modifier and Type	Method	Description
void	consume()	Marks this event consumed.
TextHitInfo	getCaret()
int	getCommittedCharacterCount()
AttributedCharacterIterator	getText()
TextHitInfo	getVisiblePosition()
long	getWhen()
boolean	isConsumed()
String	paramString()

Methods inherited from class AWTEvent

getID, setSource, toString

Methods inherited from class EventObject

getSource

Methods inherited from class Object

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

Field Details

INPUT_METHOD_FIRST

public static final int INPUT_METHOD_FIRST

See Also:

• Constant Field Values

INPUT_METHOD_LAST

public static final int INPUT_METHOD_LAST

See Also:

• Constant Field Values

INPUT_METHOD_TEXT_CHANGED

public static final int INPUT_METHOD_TEXT_CHANGED

See Also:

• Constant Field Values

CARET_POSITION_CHANGED

public static final int CARET_POSITION_CHANGED

See Also:

• Constant Field Values

Constructor Details

InputMethodEvent

public InputMethodEvent(Component source,
 int id,
 long when,
 AttributedCharacterIterator text,
 int committedCharacterCount,
 TextHitInfo caret,
 TextHitInfo visiblePosition)

InputMethodEvent

public InputMethodEvent(Component source,
 int id,
 AttributedCharacterIterator text,
 int committedCharacterCount,
 TextHitInfo caret,
 TextHitInfo visiblePosition)

InputMethodEvent

public InputMethodEvent(Component source,
 int id,
 TextHitInfo caret,
 TextHitInfo visiblePosition)

Method Details

getWhen

public long getWhen()

getText

public AttributedCharacterIterator getText()

getCommittedCharacterCount

public int getCommittedCharacterCount()

getCaret

public TextHitInfo getCaret()

getVisiblePosition

public TextHitInfo getVisiblePosition()

consume

public void consume()

Marks this event consumed. Public here, as in the JDK — AWTEvent declares it protected; InputMethodEvent widens it and drops the id condition.

Overrides:

consume in class AWTEvent

isConsumed

public boolean isConsumed()

Overrides:

isConsumed in class AWTEvent

Returns:

whether consume() has been called on this event

paramString

public String paramString()

Overrides:

paramString in class AWTEvent