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 インプットメソッドイベント ID 範囲の最初の整数 ID をマークします。
static int	INPUT_METHOD_LAST インプットメソッドイベント ID 範囲の最後の整数 ID をマークします
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) 指定されたソースコンポーネント、タイプ、text、caret、および visiblePosition で、InputMethodEvent を構築します。
InputMethodEvent(Component source, int id, long when, AttributedCharacterIterator text, int committedCharacterCount, TextHitInfo caret, TextHitInfo visiblePosition) 指定されたソースコンポーネント、タイプ、時間、text、caret、および visiblePosition で、InputMethodEvent を構築します。
InputMethodEvent(Component source, int id, TextHitInfo caret, TextHitInfo visiblePosition) 指定されたソースコンポーネント、タイプ、caret、および 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

インプットメソッドイベント ID 範囲の最初の整数 ID をマークします。

関連項目:

定数フィールド値

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

インプットメソッドイベント ID 範囲の最後の整数 ID をマークします

関連項目:

定数フィールド値

コンストラクタの詳細

InputMethodEvent

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

指定されたソースコンポーネント、タイプ、時間、text、caret、および visiblePosition で、InputMethodEvent を構築します。

caret と 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)

指定されたソースコンポーネント、タイプ、text、caret、および visiblePosition で、InputMethodEvent を構築します。

caret と 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)

指定されたソースコンポーネント、タイプ、caret、および visiblePosition で、InputMethodEvent を構築します。テキストは 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()

このイベントを消費して、発生させたソースによりデフォルトの方法で処理されないようにします。

オーバーライド:

consume、クラス: AWTEvent

isConsumed

public boolean isConsumed()

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

オーバーライド:

isConsumed、クラス: AWTEvent

関連項目:

consume()

getWhen

public long getWhen()

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

戻り値:

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

導入されたバージョン:

1.4

paramString

public String paramString()

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

オーバーライド:

paramString、クラス: AWTEvent

戻り値:

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