モジュール java.desktop
パッケージ 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
関連項目:
直列化された形式

  • フィールド詳細

    • INPUT_METHOD_FIRST

      @Native public static final int INPUT_METHOD_FIRST
      インプット・メソッド・イベントID範囲の最初の整数IDをマークします。
      関連項目:
      定数フィールド値

    • INPUT_METHOD_TEXT_CHANGED

      @Native public static final int INPUT_METHOD_TEXT_CHANGED
      インプット・メソッド・テキストが変更されたことを示すイベント・タイプです。 このイベントは、入力の処理中に、インプット・メソッドによって生成されます。
      関連項目:
      定数フィールド値

    • CARET_POSITION_CHANGED

      @Native public static final int CARET_POSITION_CHANGED
      インプット・メソッド・テキストで挿入ポイントが変更されたことを示すイベント・タイプです。 このイベントは、入力の処理中にキャレットが変更された場合にだけ、インプット・メソッドによって生成されます。
      関連項目:
      定数フィールド値

    • INPUT_METHOD_LAST

      @Native 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
      戻り値:
      このイベントが消費された場合true;そうでなければfalse
      関連項目:
      consume()

    • getWhen

      public long getWhen()
      このイベントが発生した時点のタイムスタンプを返します。
      戻り値:
      このイベントのタイムスタンプ
      導入されたバージョン:
      1.4

    • paramString

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