InputMethodEvent JDK 1.6)

Constructors

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 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
- 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, long when, AttributedCharacterIterator text, int committedCharacterCount, TextHitInfo caret, TextHitInfo visiblePosition)

Constructs an InputMethodEvent with the specified source component, type, time, text, caret, and visiblePosition.

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
Since: 1.4

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

Constructs an InputMethodEvent with the specified source component, type, caret, and 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.
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

Methods

Hide/Show inherited methods

public void consume () [Overrides AWTEvent]

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.

public int getCommittedCharacterCount ()

Gets the number of committed characters in the text.

public int getID () [Inherited From AWTEvent]

Returns the event type.

public Object getSource () [Inherited From EventObject]

The object on which the Event initially occurred.

public AttributedCharacterIterator getText ()

Gets the combined committed and composed text.

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.

public long getWhen ()

Returns the time stamp of when this event occurred.

public boolean isConsumed () [Overrides AWTEvent]

Returns whether or not this event has been consumed.

public String paramString () [Overrides AWTEvent]

Returns a parameter string identifying this event.

public void setSource (Object newSource) [Inherited From AWTEvent]

Retargets an event to a new source.

public String toString () [Inherited From AWTEvent]

Returns a String representation of this object.

Fields

Hide/Show inherited fields

publicfinalstatic long ACTION_EVENT_MASK = "128" [Inherited From AWTEvent]

The event mask for selecting action events.

publicfinalstatic long ADJUSTMENT_EVENT_MASK = "256" [Inherited From AWTEvent]

The event mask for selecting adjustment events.

publicfinalstatic int CARET_POSITION_CHANGED = "1101"

The event type indicating a changed insertion point in input method text.

publicfinalstatic long COMPONENT_EVENT_MASK = "1" [Inherited From AWTEvent]

The event mask for selecting component events.

protected boolean consumed [Inherited From AWTEvent]

Controls whether or not the event is sent back down to the peer once the source has processed it - false means it's sent to the peer; true means it's not.

publicfinalstatic long CONTAINER_EVENT_MASK = "2" [Inherited From AWTEvent]

The event mask for selecting container events.

publicfinalstatic long FOCUS_EVENT_MASK = "4" [Inherited From AWTEvent]

The event mask for selecting focus events.

publicfinalstatic long HIERARCHY_BOUNDS_EVENT_MASK = "65536" [Inherited From AWTEvent]

The event mask for selecting hierarchy bounds events.

publicfinalstatic long HIERARCHY_EVENT_MASK = "32768" [Inherited From AWTEvent]

The event mask for selecting hierarchy events.

protected int id [Inherited From AWTEvent]

The event's id.

publicfinalstatic long INPUT_METHOD_EVENT_MASK = "2048" [Inherited From AWTEvent]

The event mask for selecting input method events.

publicfinalstatic int INPUT_METHOD_FIRST = "1100"

Marks the first integer id for the range of input method event ids.

publicfinalstatic int INPUT_METHOD_LAST = "1101"

Marks the last integer id for the range of input method event ids.

publicfinalstatic int INPUT_METHOD_TEXT_CHANGED = "1100"

The event type indicating changed input method text.

publicfinalstatic long INVOCATION_EVENT_MASK = "16384" [Inherited From AWTEvent]

The event mask for selecting invocation events.

publicfinalstatic long ITEM_EVENT_MASK = "512" [Inherited From AWTEvent]

The event mask for selecting item events.

publicfinalstatic long KEY_EVENT_MASK = "8" [Inherited From AWTEvent]

The event mask for selecting key events.

publicfinalstatic long MOUSE_EVENT_MASK = "16" [Inherited From AWTEvent]

The event mask for selecting mouse events.

publicfinalstatic long MOUSE_MOTION_EVENT_MASK = "32" [Inherited From AWTEvent]

The event mask for selecting mouse motion events.

publicfinalstatic long MOUSE_WHEEL_EVENT_MASK = "131072" [Inherited From AWTEvent]

The event mask for selecting mouse wheel events.

publicfinalstatic long PAINT_EVENT_MASK = "8192" [Inherited From AWTEvent]

The event mask for selecting paint events.

publicfinalstatic int RESERVED_ID_MAX = "1999" [Inherited From AWTEvent]

The maximum value for reserved AWT event IDs.

protectedtransient Object source [Inherited From EventObject]

The object on which the Event initially occurred.

publicfinalstatic long TEXT_EVENT_MASK = "1024" [Inherited From AWTEvent]

The event mask for selecting text events.

pack-private long when

The time stamp that indicates when the event was created.

publicfinalstatic long WINDOW_EVENT_MASK = "64" [Inherited From AWTEvent]

The event mask for selecting window events.

publicfinalstatic long WINDOW_FOCUS_EVENT_MASK = "524288" [Inherited From AWTEvent]

The event mask for selecting window focus events.

publicfinalstatic long WINDOW_STATE_EVENT_MASK = "262144" [Inherited From AWTEvent]

The event mask for selecting window state events.