| java.awt.AWTEvent
 java.awt.event.InputMethodEvent
| InputMethodEvent | | public class InputMethodEvent extends AWTEvent (Code) | | 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.
author:
JavaSoft Asia/Pacific
version:
1.32 06/05/07
since:
1.2 |
| Field Summary | |
| final public static int | CARET_POSITION_CHANGED
The event type indicating a changed insertion point in input method text. | | final public static int | INPUT_METHOD_FIRST
Marks the first integer id for the range of input method event ids. | | final public static int | INPUT_METHOD_LAST
Marks the last integer id for the range of input method event ids. | | final public static int | INPUT_METHOD_TEXT_CHANGED
The event type indicating changed input method text. | | long | when
The time stamp that indicates when the event was created. |
| Constructor Summary | |
| 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. | | 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
java.awt.EventQueue.getMostRecentEventTime .
Note that passing in an invalid id results in
unspecified behavior. | | 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
java.awt.EventQueue.getMostRecentEventTime .
Note that passing in an invalid id results in
unspecified behavior. |
| Method Summary | |
| 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.
the caret (a.k.a. | | public int | getCommittedCharacterCount()
Gets the number of committed characters in the text. | | public AttributedCharacterIterator | getText()
Gets the combined committed and composed text. | | public TextHitInfo | getVisiblePosition()
Gets the position that's most important to be visible. | | public long | getWhen()
Returns the time stamp of when this event occurred. | | public boolean | isConsumed()
Returns whether or not this event has been consumed. | | public String | paramString()
Returns a parameter string identifying this event. |
| CARET_POSITION_CHANGED | | final public static int CARET_POSITION_CHANGED(Code) | | 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.
|
| INPUT_METHOD_FIRST | | final public static int INPUT_METHOD_FIRST(Code) | | Marks the first integer id for the range of input method event ids.
|
| INPUT_METHOD_LAST | | final public static int INPUT_METHOD_LAST(Code) | | Marks the last integer id for the range of input method event ids.
|
| INPUT_METHOD_TEXT_CHANGED | | final public static int INPUT_METHOD_TEXT_CHANGED(Code) | | The event type indicating changed input method text. This event is
generated by input methods while processing input.
|
| InputMethodEvent | | public InputMethodEvent(Component source, int id, long when, AttributedCharacterIterator text, int committedCharacterCount, TextHitInfo caret, TextHitInfo visiblePosition)(Code) | | 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
Parameters:
id - the event type
Parameters:
when - a long integer that specifies the time the event occurred
Parameters:
text - the combined committed and composed text,committed text first; must be nullwhen the event type is CARET_POSITION_CHANGED;may be null forINPUT_METHOD_TEXT_CHANGED if there's nocommitted or composed text
Parameters:
committedCharacterCount - the number of committedcharacters in the text
Parameters:
caret - the caret (a.k.a. insertion point);null if there's no caret within currentcomposed text
Parameters:
visiblePosition - the position that's most importantto be visible; null if there's norecommendation for a visible position within currentcomposed text
throws:
IllegalArgumentException - if id is notin the rangeINPUT_METHOD_FIRST..INPUT_METHOD_LAST;or if id is CARET_POSITION_CHANGED andtext is not null;or if committedCharacterCount is not in the range0..(text.getEndIndex() - text.getBeginIndex())
throws:
IllegalArgumentException - if source is null
since:
1.4 |
| InputMethodEvent | | public InputMethodEvent(Component source, int id, AttributedCharacterIterator text, int committedCharacterCount, TextHitInfo caret, TextHitInfo visiblePosition)(Code) | | 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
java.awt.EventQueue.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
Parameters:
id - the event type
Parameters:
text - the combined committed and composed text,committed text first; must be nullwhen the event type is CARET_POSITION_CHANGED;may be null forINPUT_METHOD_TEXT_CHANGED if there's nocommitted or composed text
Parameters:
committedCharacterCount - the number of committedcharacters in the text
Parameters:
caret - the caret (a.k.a. insertion point);null if there's no caret within currentcomposed text
Parameters:
visiblePosition - the position that's most importantto be visible; null if there's norecommendation for a visible position within currentcomposed text
throws:
IllegalArgumentException - if id is notin the rangeINPUT_METHOD_FIRST..INPUT_METHOD_LAST;or if id is CARET_POSITION_CHANGED andtext is not null;or if committedCharacterCount is not in the range0..(text.getEndIndex() - text.getBeginIndex())
throws:
IllegalArgumentException - if source is null |
| InputMethodEvent | | public InputMethodEvent(Component source, int id, TextHitInfo caret, TextHitInfo visiblePosition)(Code) | | 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
java.awt.EventQueue.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
Parameters:
id - the event type
Parameters:
caret - the caret (a.k.a. insertion point);null if there's no caret within currentcomposed text
Parameters:
visiblePosition - the position that's most importantto be visible; null if there's norecommendation for a visible position within currentcomposed text
throws:
IllegalArgumentException - if id is notin the rangeINPUT_METHOD_FIRST..INPUT_METHOD_LAST
throws:
IllegalArgumentException - if source is null |
| consume | | public void consume()(Code) | | Consumes this event so that it will not be processed
in the default manner by the source which originated it.
|
| getCaret | | public TextHitInfo getCaret()(Code) | | 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.
the caret (a.k.a. insertion point).Null if there's no caret within current composed text. |
| getCommittedCharacterCount | | public int getCommittedCharacterCount()(Code) | | Gets the number of committed characters in the text.
|
| getText | | public AttributedCharacterIterator getText()(Code) | | Gets the combined committed and composed text.
Characters from index 0 to index getCommittedCharacterCount() - 1 are committed
text, the remaining characters are composed text.
the text.Always null for CARET_POSITION_CHANGED;may be null for INPUT_METHOD_TEXT_CHANGED if there's no composed or committed text. |
| getVisiblePosition | | public TextHitInfo getVisiblePosition()(Code) | | 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.
the position that's most important to be visible.Null if there's no recommendation for a visible position within current composed text. |
| getWhen | | public long getWhen()(Code) | | Returns the time stamp of when this event occurred.
this event's timestamp
since:
1.4 |
| paramString | | public String paramString()(Code) | | 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.
a string identifying the event and its attributes |
|
|