| java.lang.Object | |||
| ↳ | java.util.EventObject | ||
| ↳ | java.awt.AWTEvent | ||
| ↳ | java.awt.event.InputMethodEvent | ||
Class Overview
Input method events contain information about text that is being composed using an input method. Whenever the text changes, the input method sends an event. If the text component that's currently using the input method is an active client, the event is dispatched to that component. Otherwise, it is dispatched to a separate composition window.
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.
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | CARET_POSITION_CHANGED | The event type indicating a changed insertion point in input method text. | |||||||||
| int | INPUT_METHOD_FIRST | Marks the first integer id for the range of input method event ids. | |||||||||
| int | INPUT_METHOD_LAST | Marks the last integer id for the range of input method event ids. | |||||||||
| int | INPUT_METHOD_TEXT_CHANGED | The event type indicating changed input method text. | |||||||||
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
 From class
java.awt.AWTEvent
| |||||||||||
|
[Expand]
Inherited Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.awt.AWTEvent
| |||||||||||
|
From class
java.util.EventObject
| |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Constructs an
InputMethodEvent with the specified
source component, type, time, text, caret, and visiblePosition. | |||||||||||
Constructs an
InputMethodEvent with the specified
source component, type, text, caret, and visiblePosition. | |||||||||||
Constructs an
InputMethodEvent with the
specified source component, type, caret, and visiblePosition. | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Consumes this event so that it will not be processed
in the default manner by the source which originated it.
| |||||||||||
Gets the caret.
| |||||||||||
Gets the number of committed characters in the text.
| |||||||||||
Gets the combined committed and composed text.
| |||||||||||
Gets the position that's most important to be visible.
| |||||||||||
Returns the time stamp of when this event occurred.
| |||||||||||
Returns whether or not this event has been consumed.
| |||||||||||
Returns a parameter string identifying this event.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.awt.AWTEvent
| |||||||||||
|
From class
java.util.EventObject
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
Constants
public static final int CARET_POSITION_CHANGED
The event type indicating a changed insertion point in input method text. This event is generated by input methods while processing input if only the caret changed.
public static final int INPUT_METHOD_FIRST
Marks the first integer id for the range of input method event ids.
public static final int INPUT_METHOD_LAST
Marks the last integer id for the range of input method event ids.
public static final int INPUT_METHOD_TEXT_CHANGED
The event type indicating changed input method text. This event is generated by input methods while processing input.
Public Constructors
public 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.
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.
Parameters
| source | the object where the event originated |
|---|---|
| id | the event type |
| when | a long integer that specifies the time the event occurred |
| text | 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 text |
| committedCharacterCount | the number of committed characters in the text |
| caret | the caret (a.k.a. insertion point);
null if there's no caret within current
composed text |
| visiblePosition | the position that's most important
to be visible; null if there's no
recommendation for a visible position within current
composed text |
Throws
| IllegalArgumentException | 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 null |
public 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.
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
getMostRecentEventTime().
Note that passing in an invalid id results in
unspecified behavior. This method throws an
IllegalArgumentException if source
is null.
Parameters
| source | the object where the event originated |
|---|---|
| id | the event type |
| text | 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 text |
| committedCharacterCount | the number of committed characters in the text |
| caret | the caret (a.k.a. insertion point);
null if there's no caret within current
composed text |
| visiblePosition | the position that's most important
to be visible; null if there's no
recommendation for a visible position within current
composed text |
Throws
| IllegalArgumentException | 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 null
|
public InputMethodEvent (Component source, int id, TextHitInfo caret, TextHitInfo visiblePosition)
Constructs an 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
getMostRecentEventTime().
Note that passing in an invalid id results in
unspecified behavior. This method throws an
IllegalArgumentException if source
is null.
Parameters
| source | the object where the event originated |
|---|---|
| id | the event type |
| caret | the caret (a.k.a. insertion point);
null if there's no caret within current
composed text |
| visiblePosition | the position that's most important
to be visible; null if there's no
recommendation for a visible position within current
composed text |
Throws
| IllegalArgumentException | if id is not
in the range
INPUT_METHOD_FIRST..INPUT_METHOD_LAST |
|---|---|
| IllegalArgumentException | if source is null
|
Public Methods
public void consume ()
Consumes this event so that it will not be processed in the default manner by the source which originated it.
public TextHitInfo getCaret ()
Gets the caret.
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.
Returns
- the caret (a.k.a. insertion point). Null if there's no caret within current composed text.
public int getCommittedCharacterCount ()
Gets the number of committed characters in the text.
public AttributedCharacterIterator getText ()
Gets the combined committed and composed text.
Characters from index 0 to index getCommittedCharacterCount() - 1 are committed
text, the remaining characters are composed text.
Returns
- the text. Always null for CARET_POSITION_CHANGED; may be null for INPUT_METHOD_TEXT_CHANGED if there's no composed or committed text.
public TextHitInfo getVisiblePosition ()
Gets the position that's most important to be visible.
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.
Returns
- the position that's most important to be visible. Null if there's no recommendation for a visible position within current composed text.
public long getWhen ()
Returns the time stamp of when this event occurred.
Returns
- this event's timestamp
public boolean isConsumed ()
Returns whether or not this event has been consumed.
See Also
public String paramString ()
Returns a parameter string identifying this event. This method is useful for event-logging and for debugging. It contains the event ID in text form, the characters of the committed and composed text separated by "+", the number of committed characters, the caret, and the visible position.
Returns
- a string identifying the event and its attributes