Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Class java.awt.event.InputMethodEvent

java.lang.Object
    |
    +----java.util.EventObject
            |
            +----java.awt.AWTEvent
                    |
                    +----java.awt.event.InputMethodEvent

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 to the text editing component that uses it.

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.


Field Summary
static int  ALL_CHARACTERS_COMMITTED
Constant indicating that the entire text sent with this event is committed.
static int  CARET_POSITION_CHANGED
The event type indicating a changed insertion point in input method text.
static int  INPUT_METHOD_FIRST
Marks the first integer id for the range of input method event ids.
static int  INPUT_METHOD_LAST
Marks the last integer id for the range of input method event ids.
static int  INPUT_METHOD_TEXT_CHANGED
The event type indicating changed input method text.
 
Fields inherited from class java.awt.AWTEvent
 ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, id, INPUT_METHOD_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK
 
Fields inherited from class java.util.EventObject
 source
 

Constructor Summary
 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.
 InputMethodEvent(Component source, int id, TextHitInfo caret, TextHitInfo visiblePosition)
Constructs an InputMethodEvent with the specified source component, type, caret, and visiblePosition.
 

Method Summary
void  consume()
Consumes this event so that it will not be processed in the default manner by the source which originated it.
TextHitInfo  getCaret()
Gets the caret.
int  getCommittedCharacterCount()
Gets the number of committed characters in the text.
AttributedCharacterIterator  getText()
Gets the combined committed and composed text.
TextHitInfo  getVisiblePosition()
Gets the position that's most important to be visible.
boolean  isConsumed()
Returns whether or not this event has been consumed.
String  paramString()
Returns a parameter string identifying this event.
 
Methods inherited from class java.awt.AWTEvent
 consume, getID, isConsumed, paramString, toString
 
Methods inherited from class java.util.EventObject
 getSource, toString
 
Methods inherited from class java.lang.Object
 clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

INPUT_METHOD_FIRST

public static final int INPUT_METHOD_FIRST
Marks the first integer id for the range of input method event ids.

INPUT_METHOD_TEXT_CHANGED

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.

CARET_POSITION_CHANGED

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.

INPUT_METHOD_LAST

public static final int INPUT_METHOD_LAST
Marks the last integer id for the range of input method event ids.

ALL_CHARACTERS_COMMITTED

public static final int ALL_CHARACTERS_COMMITTED
Constant indicating that the entire text sent with this event is committed.
Constructor Detail

InputMethodEvent

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.
Parameters:
source - The object where the event originated.
id - The event type.
text - The combined committed and composed text, committed text first.
committedCharacterCount - The number of committed characters in the text, ALL_CHARACTERS_COMMITTED if all characters are committed.
caret - The caret (a.k.a. insertion point), with offset relative to text. Null if there's no caret.
visiblePosition - The position that's most important to be visible. Null if there's no recommendation.

InputMethodEvent

public InputMethodEvent(Component source,
                        int id,
                        TextHitInfo caret,
                        TextHitInfo visiblePosition)
Constructs an InputMethodEvent with the specified source component, type, caret, and visiblePosition.
Parameters:
source - The object where the event originated.
id - The event type.
caret - The caret (a.k.a. insertion point), with offset relative to text. Null if there's no caret.
visiblePosition - The position that's most important to be visible. Null if there's no recommendation.
Method Detail

getText

public AttributedCharacterIterator getText()
Gets the combined committed and composed text. If getCommittedCharacterCount returns ALL_CHARACTERS_COMMITTED, then the entire text is committed. Otherwise, Characters from offset 0 to offset getCommittedCharacterCount() are committed text, the remaining characters are composed text.
Returns:
the text

getCommittedCharacterCount

public int getCommittedCharacterCount()
Gets the number of committed characters in the text. If all characters are committed, ALL_CHARACTERS_COMMITTED is returned.

getCaret

public TextHitInfo getCaret()
Gets the caret. Null if there's no caret.

getVisiblePosition

public TextHitInfo getVisiblePosition()
Gets the position that's most important to be visible. Null if there's no recommendation.

consume

public void consume()
Consumes this event so that it will not be processed in the default manner by the source which originated it.
Overrides:
consume in class AWTEvent

isConsumed

public boolean isConsumed()
Returns whether or not this event has been consumed.
Overrides:
isConsumed in class AWTEvent
See Also:
consume

paramString

public String paramString()
Returns a parameter string identifying this event. This method is useful for event-logging and for debugging.
Returns:
a string identifying the event and its attributes
Overrides:
paramString in class AWTEvent

Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Submit a bug or feature
Submit comments/suggestions about new javadoc look.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.