public class InputMethodEvent extends AWTEvent
The text included with the input method event consists of two parts: committed text and composed text. Either part may be empty. The two parts together replace any uncommitted composed text sent in previous events, or the currently selected committed text. Committed text should be integrated into the text component's persistent data, it will not be sent again. Composed text may be sent repeatedly, with changes to reflect the user's editing operations. Committed text always precedes composed text.
Modifier and Type | Field and Description |
---|---|
static int |
CARET_POSITION_CHANGED
The event type indicating a changed insertion point in input method text.
|
static int |
INPUT_METHOD_FIRST
Marks the first integer id for the range of input method event ids.
|
static int |
INPUT_METHOD_LAST
Marks the last integer id for the range of input method event ids.
|
static int |
INPUT_METHOD_TEXT_CHANGED
The event type indicating changed input method text.
|
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
source
Constructor and Description |
---|
InputMethodEvent(Component source,
int id,
AttributedCharacterIterator text,
int committedCharacterCount,
TextHitInfo caret,
TextHitInfo visiblePosition)
Constructs an
InputMethodEvent with the specified
source component, type, text, caret, and visiblePosition. |
InputMethodEvent(Component source,
int id,
long when,
AttributedCharacterIterator text,
int committedCharacterCount,
TextHitInfo caret,
TextHitInfo visiblePosition)
Constructs an
InputMethodEvent with the specified
source component, type, time, text, caret, and visiblePosition. |
InputMethodEvent(Component source,
int id,
TextHitInfo caret,
TextHitInfo visiblePosition)
Constructs an
InputMethodEvent with the
specified source component, type, caret, and visiblePosition. |
Modifier and Type | Method and Description |
---|---|
void |
consume()
Consumes this event so that it will not be processed
in the default manner by the source which originated it.
|
TextHitInfo |
getCaret()
Gets the caret.
|
int |
getCommittedCharacterCount()
Gets the number of committed characters in the text.
|
AttributedCharacterIterator |
getText()
Gets the combined committed and composed text.
|
TextHitInfo |
getVisiblePosition()
Gets the position that's most important to be visible.
|
long |
getWhen()
Returns the time stamp of when this event occurred.
|
boolean |
isConsumed()
Returns whether or not this event has been consumed.
|
String |
paramString()
Returns a parameter string identifying this event.
|
getSource
@Native public static final int INPUT_METHOD_FIRST
@Native public static final int INPUT_METHOD_TEXT_CHANGED
@Native public static final int CARET_POSITION_CHANGED
@Native public static final int INPUT_METHOD_LAST
public InputMethodEvent(Component source, int id, long when, AttributedCharacterIterator text, int committedCharacterCount, TextHitInfo caret, TextHitInfo visiblePosition)
InputMethodEvent
with the specified
source component, type, time, text, caret, and visiblePosition.
The offsets of caret and visiblePosition are relative to the current
composed text; that is, the composed text within text
if this is an INPUT_METHOD_TEXT_CHANGED
event,
the composed text within the text
of the
preceding INPUT_METHOD_TEXT_CHANGED
event otherwise.
Note that passing in an invalid id
results in
unspecified behavior. This method throws an
IllegalArgumentException
if source
is null
.
source
- the object where the event originatedid
- the event typewhen
- a long integer that specifies the time the event occurredtext
- the combined committed and composed text,
committed text first; must be null
when the event type is CARET_POSITION_CHANGED
;
may be null
for
INPUT_METHOD_TEXT_CHANGED
if there's no
committed or composed textcommittedCharacterCount
- the number of committed
characters in the textcaret
- the caret (a.k.a. insertion point);
null
if there's no caret within current
composed textvisiblePosition
- the position that's most important
to be visible; null
if there's no
recommendation for a visible position within current
composed textIllegalArgumentException
- if id
is not
in the range
INPUT_METHOD_FIRST
..INPUT_METHOD_LAST
;
or if id is CARET_POSITION_CHANGED
and
text
is not null
;
or if committedCharacterCount
is not in the range
0
..(text.getEndIndex() - text.getBeginIndex())
IllegalArgumentException
- if source
is nullpublic InputMethodEvent(Component source, int id, AttributedCharacterIterator text, int committedCharacterCount, TextHitInfo caret, TextHitInfo visiblePosition)
InputMethodEvent
with the specified
source component, type, text, caret, and visiblePosition.
The offsets of caret and visiblePosition are relative to the current
composed text; that is, the composed text within text
if this is an INPUT_METHOD_TEXT_CHANGED
event,
the composed text within the text
of the
preceding INPUT_METHOD_TEXT_CHANGED
event otherwise.
The time stamp for this event is initialized by invoking
EventQueue.getMostRecentEventTime()
.
Note that passing in an invalid id
results in
unspecified behavior. This method throws an
IllegalArgumentException
if source
is null
.
source
- the object where the event originatedid
- the event typetext
- the combined committed and composed text,
committed text first; must be null
when the event type is CARET_POSITION_CHANGED
;
may be null
for
INPUT_METHOD_TEXT_CHANGED
if there's no
committed or composed textcommittedCharacterCount
- the number of committed
characters in the textcaret
- the caret (a.k.a. insertion point);
null
if there's no caret within current
composed textvisiblePosition
- the position that's most important
to be visible; null
if there's no
recommendation for a visible position within current
composed textIllegalArgumentException
- if id
is not
in the range
INPUT_METHOD_FIRST
..INPUT_METHOD_LAST
;
or if id is CARET_POSITION_CHANGED
and
text
is not null
;
or if committedCharacterCount
is not in the range
0
..(text.getEndIndex() - text.getBeginIndex())
IllegalArgumentException
- if source
is nullpublic InputMethodEvent(Component source, int id, TextHitInfo caret, TextHitInfo visiblePosition)
InputMethodEvent
with the
specified source component, type, caret, and visiblePosition.
The text is set to null
,
committedCharacterCount
to 0.
The offsets of caret
and visiblePosition
are relative to the current composed text; that is,
the composed text within the text
of the
preceding INPUT_METHOD_TEXT_CHANGED
event if the
event being constructed as a CARET_POSITION_CHANGED
event.
For an INPUT_METHOD_TEXT_CHANGED
event without text,
caret
and visiblePosition
must be
null
.
The time stamp for this event is initialized by invoking
EventQueue.getMostRecentEventTime()
.
Note that passing in an invalid id
results in
unspecified behavior. This method throws an
IllegalArgumentException
if source
is null
.
source
- the object where the event originatedid
- the event typecaret
- the caret (a.k.a. insertion point);
null
if there's no caret within current
composed textvisiblePosition
- the position that's most important
to be visible; null
if there's no
recommendation for a visible position within current
composed textIllegalArgumentException
- if id
is not
in the range
INPUT_METHOD_FIRST
..INPUT_METHOD_LAST
IllegalArgumentException
- if source
is nullpublic AttributedCharacterIterator getText()
getCommittedCharacterCount() - 1
are committed
text, the remaining characters are composed text.public int getCommittedCharacterCount()
public TextHitInfo getCaret()
The offset of the caret is relative to the current
composed text; that is, the composed text within getText()
if this is an INPUT_METHOD_TEXT_CHANGED
event,
the composed text within getText() of the
preceding INPUT_METHOD_TEXT_CHANGED
event otherwise.
public TextHitInfo getVisiblePosition()
The offset of the visible position is relative to the current
composed text; that is, the composed text within getText()
if this is an INPUT_METHOD_TEXT_CHANGED
event,
the composed text within getText() of the
preceding INPUT_METHOD_TEXT_CHANGED
event otherwise.
public void consume()
public boolean isConsumed()
isConsumed
in class AWTEvent
consume()
public long getWhen()
public String paramString()
paramString
in class AWTEvent
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2021, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.