java.awt.event
クラス InputMethodEvent

java.lang.Object
  java.util.EventObject
      java.awt.AWTEvent
          java.awt.event.InputMethodEvent

すべての実装されたインタフェース:

Serializable

public class InputMethodEvent
extends AWTEvent

インプットメソッドイベントには、インプットメソッドを利用して変換されているテキストについての情報が含まれています。インプットメソッドは、テキストが変更されると必ずイベントを送信します。現在インプットメソッドを使用しているテキストコンポーネントがアクティブクライアントである場合は、イベントはそのコンポーネントにディスパッチされます。それ以外の場合は、イベントは離れた変換ウィンドウにディスパッチされます。

インプットメソッドイベントに含まれているテキストは、確定テキストと、変換テキストの 2 つの部分から構成されています。どちらの部分も空の場合があります。2 つの部分はともに、直前のイベントで送られた未確定の変換テキスト、または現在選択されている確定テキストを置き換えます。確定テキストは、テキストコンポーネントの持続的なデータに統合されます。 そうすれば、再度送信されることはありません。変換テキストは、ユーザーの編集オペレーションを反映する変更とともに、繰り返し送信される場合があります。確定テキストは常に、変換テキストより優先されます。

導入されたバージョン:

1.2

関連項目:

直列化された形式

フィールドの概要

static int	CARET_POSITION_CHANGED インプットメソッドテキストでの挿入ポイントが変更されたことを示すイベント型です。
static int	INPUT_METHOD_FIRST インプットメソッドイベント識別子に使う整数の範囲にある最初の番号です。
static int	INPUT_METHOD_LAST インプットメソッドイベント識別子に使う整数の範囲にある最後の番号です。
static int	INPUT_METHOD_TEXT_CHANGED インプットメソッドテキストが変更されたことを示すイベント型です。

クラス java.awt.AWTEvent から継承されたフィールド

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

クラス java.util.EventObject から継承されたフィールド

source

コンストラクタの概要

InputMethodEvent(Component source, int id, AttributedCharacterIterator text, int committedCharacterCount, TextHitInfo caret, TextHitInfo visiblePosition)
InputMethodEvent を構築します。

InputMethodEvent(Component source, int id, long when, AttributedCharacterIterator text, int committedCharacterCount, TextHitInfo caret, TextHitInfo visiblePosition)
InputMethodEvent を構築します。

InputMethodEvent(Component source, int id, TextHitInfo caret, TextHitInfo visiblePosition)
InputMethodEvent を構築します。

メソッドの概要

void	consume() イベントを消費して、イベントがその発生元によりデフォルトの方法で処理されないようにします。
TextHitInfo	getCaret() キャレットを取得します。
int	getCommittedCharacterCount() テキスト内の確定テキストの文字数を返します。
AttributedCharacterIterator	getText() 確定テキストと変換テキストを結合したものを返します。
TextHitInfo	getVisiblePosition() 優先して可視にすべき位置を返します。
long	getWhen() このイベントが発生した時点のタイムスタンプを返します。
boolean	isConsumed() このイベントが消費されたかどうかを返します。
String	paramString() このイベントを特定するパラメータの文字列を返します。

クラス java.awt.AWTEvent から継承されたメソッド

getID, setSource, toString

クラス java.util.EventObject から継承されたメソッド

getSource

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

フィールドの詳細

INPUT_METHOD_FIRST

public static final int INPUT_METHOD_FIRST

インプットメソッドイベント識別子に使う整数の範囲にある最初の番号です。

関連項目:

定数フィールド値

INPUT_METHOD_TEXT_CHANGED

public static final int INPUT_METHOD_TEXT_CHANGED

インプットメソッドテキストが変更されたことを示すイベント型です。このイベントは、入力の処理中に、インプットメソッドによって生成されます。

関連項目:

定数フィールド値

CARET_POSITION_CHANGED

public static final int CARET_POSITION_CHANGED

インプットメソッドテキストでの挿入ポイントが変更されたことを示すイベント型です。このイベントは、入力の処理中にキャレットが変更された場合にだけ、インプットメソッドによって生成されます。

関連項目:

定数フィールド値

INPUT_METHOD_LAST

public static final int INPUT_METHOD_LAST

インプットメソッドイベント識別子に使う整数の範囲にある最後の番号です。

関連項目:

定数フィールド値

コンストラクタの詳細

InputMethodEvent

public InputMethodEvent(Component source,
                        int id,
                        long when,
                        AttributedCharacterIterator text,
                        int committedCharacterCount,
                        TextHitInfo caret,
                        TextHitInfo visiblePosition)

InputMethodEvent を構築します。このとき、イベントの発生元のコンポーネント、型、時刻、テキスト、キャレット、および visiblePosition を指定します。

キャレットと visiblePosition のオフセットは、現在の変換テキストとの相対位置で指定されます。つまり、INPUT_METHOD_TEXT_CHANGED イベントの場合は text 内の変換テキスト、それ以外の場合は先行する INPUT_METHOD_TEXT_CHANGED イベントの text 内の変換テキストになります。

無効な id を渡して、特定できない動作を発生させないようにしてください。このメソッドは source が null の場合に IllegalArgumentException をスローします。

パラメータ:

source - イベントの発生元オブジェクト

id - イベントの型

when - イベントが発生した時間を指定する long 整数

text - 確定テキストと変換テキストを合わせたもの。確定テキストが優先される。イベント型が CARET_POSITION_CHANGED の場合は null。INPUT_METHOD_TEXT_CHANGED イベントの場合は、確定テキストまたは変換テキストがないときは null

committedCharacterCount - テキスト内の確定された文字の数

caret - キャレット (挿入ポイント)。現在の変換テキストにキャレットが存在しない場合は null

visiblePosition - 優先して可視にすべき位置。現在の変換テキスト内に、可視にすべき位置についての指定がない場合は null

例外:

IllegalArgumentException - id が INPUT_METHOD_FIRST..INPUT_METHOD_LAST の範囲にない場合、id が CARET_POSITION_CHANGED で text が null でない場合、または committedCharacterCount が 0..(text.getEndIndex() - text.getBeginIndex()) の範囲にない場合

IllegalArgumentException - source が null の場合

導入されたバージョン:

1.4

InputMethodEvent

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

InputMethodEvent を構築します。このとき、イベント発生元のコンポーネント、型、テキスト、キャレット、および visiblePosition を指定します。

キャレットと visiblePosition のオフセットは、現在の変換テキストとの相対位置で指定されます。つまり、INPUT_METHOD_TEXT_CHANGED イベントの場合は text 内の変換テキスト、それ以外の場合は先行する INPUT_METHOD_TEXT_CHANGED イベントの text 内の変換テキストになります。このイベントのタイムスタンプは、EventQueue.getMostRecentEventTime() 呼び出すことで初期化されます。

無効な id を渡して、特定できない動作を発生させないようにしてください。このメソッドは source が null の場合に IllegalArgumentException をスローします。

パラメータ:

source - イベントの発生元オブジェクト

id - イベントの型

text - 確定テキストと変換テキストを合わせたもの。確定テキストが優先される。イベント型が CARET_POSITION_CHANGED の場合は null。INPUT_METHOD_TEXT_CHANGED イベントの場合は、確定テキストまたは変換テキストがないときは null

committedCharacterCount - テキスト内の確定された文字の数

caret - キャレット (挿入ポイント)。現在の変換テキストにキャレットが存在しない場合は null

visiblePosition - 優先して可視にすべき位置。現在の変換テキスト内に、可視にすべき位置についての指定がない場合は null

例外:

IllegalArgumentException - id が INPUT_METHOD_FIRST..INPUT_METHOD_LAST の範囲にない場合、id が CARET_POSITION_CHANGED で text が null でない場合、または committedCharacterCount が 0..(text.getEndIndex() - text.getBeginIndex()) の範囲にない場合

IllegalArgumentException - source が null の場合

InputMethodEvent

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

InputMethodEvent を構築します。 このとき、イベントの発生元のコンポーネント、型、キャレット、および visiblePosition を指定します。テキストは null、committedCharacterCount は 0 に設定します。

caret と visiblePosition のオフセットは、現在の変換テキストを基準にします。 つまり、イベントが CARET_POSITION_CHANGED として構築された場合は、先行する INPUT_METHOD_TEXT_CHANGED イベントの text 内の変換テキストになります。INPUT_METHOD_TEXT_CHANGED にテキストが存在しない場合、caret と visiblePosition は null である必要があります。このイベントのタイムスタンプは、EventQueue.getMostRecentEventTime() 呼び出すことで初期化されます。

無効な id を渡して、特定できない動作を発生させないようにしてください。このメソッドは source が null の場合に IllegalArgumentException をスローします。

パラメータ:

source - イベントの発生元オブジェクト

id - イベントの型

caret - キャレット (挿入ポイント)。現在の変換テキストにキャレットが存在しない場合は null

visiblePosition - 優先して可視にすべき位置。現在の変換テキスト内に、可視にすべき位置についての指定がない場合は null

例外:

IllegalArgumentException - id が INPUT_METHOD_FIRST..INPUT_METHOD_LAST の範囲にない場合

IllegalArgumentException - source が null の場合

メソッドの詳細

getText

public AttributedCharacterIterator getText()

確定テキストと変換テキストを結合したものを返します。インデックスが 0 〜 getCommittedCharacterCount() - 1 までの文字が確定されたテキストで、残りの文字が変換テキストです。

戻り値:

テキスト。CARET_POSITION_CHANGED イベントの場合は常に null。INPUT_METHOD_TEXT_CHANGED イベントの場合は、変換テキストまたは確定テキストがないときは null

getCommittedCharacterCount

public int getCommittedCharacterCount()

テキスト内の確定テキストの文字数を返します。

getCaret

public TextHitInfo getCaret()

キャレットを取得します。

キャレットのオフセットは、現在の変換テキストに対する相対値です。この場合の変換テキストは、イベントが INPUT_METHOD_TEXT_CHANGED の場合は getText() 内の変換テキスト、それ以外の場合は先行する INPUT_METHOD_TEXT_CHANGED イベントの getText() 内の変換テキストになります。

戻り値:

キャレット (挿入ポイント)。現在の変換テキストにキャレットが存在しない場合は null

getVisiblePosition

public TextHitInfo getVisiblePosition()

優先して可視にすべき位置を返します。

可視の位置のオフセットは、現在の変換テキストとの相対位置で指定されます。つまり、INPUT_METHOD_TEXT_CHANGED イベントの場合は、getText() 内の変換テキストになります。それ以外の場合は、先行する INPUT_METHOD_TEXT_CHANGED イベントの getText() 内の変換テキストです。

戻り値:

優先して可視にすべき位置。現在の変換テキスト内に、可視にすべき位置についての指定がない場合は null

consume

public void consume()

イベントを消費して、イベントがその発生元によりデフォルトの方法で処理されないようにします。

オーバーライド:

クラス AWTEvent 内の consume

isConsumed

public boolean isConsumed()

このイベントが消費されたかどうかを返します。

オーバーライド:

クラス AWTEvent 内の isConsumed

関連項目:

consume()

getWhen

public long getWhen()

このイベントが発生した時点のタイムスタンプを返します。

戻り値:

このイベントのタイムスタンプ

導入されたバージョン:

1.4

paramString

public String paramString()

このイベントを特定するパラメータの文字列を返します。このメソッドは、イベントログの作成およびデバッグに使用します。文字列には、テキスト形式のイベント識別子、「+」によって区切られた確定テキストおよび変換テキストの文字、確定テキストの文字数、キャレット、可視位置が含まれています。

オーバーライド:

クラス AWTEvent 内の paramString

戻り値:

イベントを特定する文字列とその属性