public class InputMethodEvent extends AWTEvent
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.
@Native public static final int INPUT_METHOD_FIRST
Marks the first integer id for the range of input method event ids.
@Native 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.
@Native 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.
@Native public static final int INPUT_METHOD_LAST
Marks the last integer id for the range of input method event ids.
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.
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) 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 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) 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 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()
Gets the combined committed and composed text. Characters from index 0 to index getCommittedCharacterCount() - 1 are committed text, the remaining characters are composed text.
public int getCommittedCharacterCount()
Gets the number of committed characters in the text.
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.
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.
public void consume()
Consumes this event so that it will not be processed in the default manner by the source which originated it.
public boolean isConsumed()
Returns whether or not this event has been consumed.
isConsumed in class AWTEvent
consume()public long getWhen()
Returns the time stamp of when this event occurred.
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.
paramString in class AWTEvent
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.