Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

java.awt.event

Class InputMethodEvent

Implemented Interfaces:
Serializable
public class InputMethodEvent
extends AWTEvent
This class is for event generated by change in a text input method.
Since:
1.2
See Also:
InputMethodListener, Serialized Form

Field Summary

static int
CARET_POSITION_CHANGED
This event id indicates that the input method curor point has changed.
static int
INPUT_METHOD_FIRST
This is the first id in the range of event ids used by this class.
static int
INPUT_METHOD_LAST
This is the last id in the range of event ids used by this class.
static int
INPUT_METHOD_TEXT_CHANGED
This event id indicates that the text in the input method has changed.

Fields inherited from class java.awt.AWTEvent

ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, 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, consumed, id

Fields inherited from class java.util.EventObject

source

Constructor Summary

InputMethodEvent(Component source, int id, TextHitInfo caret, TextHitInfo visiblePosition)
Initializes a new instance of InputMethodEvent with the specified source, id, caret, and visible position, and with a null text and char count.
InputMethodEvent(Component source, int id, AttributedCharacterIterator text, int committedCharacterCount, TextHitInfo caret, TextHitInfo visiblePosition)
Initializes a new instance of InputMethodEvent with the specified source, id, text, char count, caret, and visible position.
InputMethodEvent(Component source, int id, long when, AttributedCharacterIterator text, int committedCharacterCount, TextHitInfo caret, TextHitInfo visiblePosition)
Initializes a new instance of InputMethodEvent with the specified source, id, timestamp, text, char count, caret, and visible position.

Method Summary

void
consume()
This method consumes the event.
TextHitInfo
getCaret()
Returns the caret position.
int
getCommittedCharacterCount()
Returns the number of committed characters in the input method text.
AttributedCharacterIterator
getText()
This method returns the input method text.
TextHitInfo
getVisiblePosition()
Returns the position that is most important to be visible, or null if such a hint is not necessary.
long
getWhen()
Return the timestamp of this event.
boolean
isConsumed()
This method tests whether or not this event has been consumed.
String
paramString()
This method returns a string identifying the event.

Methods inherited from class java.awt.AWTEvent

consume, getID, isConsumed, paramString, setSource, toString

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CARET_POSITION_CHANGED

public static final int CARET_POSITION_CHANGED
This event id indicates that the input method curor point has changed.
Field Value:
1101

INPUT_METHOD_FIRST

public static final int INPUT_METHOD_FIRST
This is the first id in the range of event ids used by this class.
Field Value:
1100

INPUT_METHOD_LAST

public static final int INPUT_METHOD_LAST
This is the last id in the range of event ids used by this class.
Field Value:
1101

INPUT_METHOD_TEXT_CHANGED

public static final int INPUT_METHOD_TEXT_CHANGED
This event id indicates that the text in the input method has changed.
Field Value:
1100

Constructor Details

InputMethodEvent

public InputMethodEvent(Component source,
                        int id,
                        TextHitInfo caret,
                        TextHitInfo visiblePosition)
Initializes a new instance of InputMethodEvent with the specified source, id, caret, and visible position, and with a null text and char count.
Parameters:
source - the source that generated the event
id - the event id
caret - the caret position
visiblePosition - the position most important to make visible
Throws:
IllegalArgumentException - if source is null or id is invalid
Since:
1.4

InputMethodEvent

public InputMethodEvent(Component source,
                        int id,
                        AttributedCharacterIterator text,
                        int committedCharacterCount,
                        TextHitInfo caret,
                        TextHitInfo visiblePosition)
Initializes a new instance of InputMethodEvent with the specified source, id, text, char count, caret, and visible position.
Parameters:
source - the source that generated the event
id - the event id
text - the input text
committedCharacterCount - the number of committed characters
caret - the caret position
visiblePosition - the position most important to make visible
Throws:
IllegalArgumentException - if source is null, id is invalid, id is CARET_POSITION_CHANGED and text is non-null, or if committedCharacterCount is out of range
Since:
1.4

InputMethodEvent

public InputMethodEvent(Component source,
                        int id,
                        long when,
                        AttributedCharacterIterator text,
                        int committedCharacterCount,
                        TextHitInfo caret,
                        TextHitInfo visiblePosition)
Initializes a new instance of InputMethodEvent with the specified source, id, timestamp, text, char count, caret, and visible position.
Parameters:
source - the source that generated the event
id - the event id
when - the timestamp of the event
text - the input text
committedCharacterCount - the number of committed characters
caret - the caret position
visiblePosition - the position most important to make visible
Throws:
IllegalArgumentException - if source is null, id is invalid, id is CARET_POSITION_CHANGED and text is non-null, or if committedCharacterCount is out of range
Since:
1.4

Method Details

consume

public void consume()
This method consumes the event. A consumed event is not processed in the default manner by the component that generated it.
Overrides:
consume in interface AWTEvent

getCaret

public TextHitInfo getCaret()
Returns the caret position. The caret offset is relative to the composed text of the most recent INPUT_METHOD_TEXT_CHANGED event.
Returns:
the caret position, or null

getCommittedCharacterCount

public int getCommittedCharacterCount()
Returns the number of committed characters in the input method text.
Returns:
the number of committed characters in the input method text

getText

public AttributedCharacterIterator getText()
This method returns the input method text. This can be null, and will always be null for CARET_POSITION_CHANGED events. Characters from 0 to getCommittedCharacterCount()-1 have been committed, the remaining characters are composed text.
Returns:
the input method text, or null

getVisiblePosition

public TextHitInfo getVisiblePosition()
Returns the position that is most important to be visible, or null if such a hint is not necessary. The caret offset is relative to the composed text of the most recent INPUT_METHOD_TEXT_CHANGED event.
Returns:
the position that is most important to be visible

getWhen

public long getWhen()
Return the timestamp of this event.
Returns:
the timestamp
Since:
1.4

isConsumed

public boolean isConsumed()
This method tests whether or not this event has been consumed.
Overrides:
isConsumed in interface AWTEvent
Returns:
true if the event has been consumed

paramString

public String paramString()
This method returns a string identifying the event. This contains the event ID, the committed and composed characters separated by '+', the number of committed characters, the caret, and the visible position.
Overrides:
paramString in interface AWTEvent
Returns:
a string identifying the event
InputMethodEvent.java -- events from a text input method Copyright (C) 1999, 2002, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About