モジュール java.desktop
パッケージ java.awt.im

クラスInputMethodHighlight

java.lang.Object
java.awt.im.InputMethodHighlight
public class InputMethodHighlight
extends Object
InputMethodHighlightは、変換されるテキストのハイライト属性を記述するため使われます。 記述は2つのレベルで可能です。変換状態およびテキストが選択されているかどうかを特定する抽象レベルと、ハイライトを描画するために使われるスタイル属性を指定する具象レベルです。 InputMethodHighlightは抽象レベルの記述を提供する必要があります。具象レベルの記述は、提供する場合としない場合があります。 具象スタイルが提供されない場合、レンダリングはToolkit.mapInputMethodHighlight(java.awt.im.InputMethodHighlight)を使って具象スタイルにマップする必要があります。

The abstract description consists of three fields: selected, state, and variation.selectedは、テキスト範囲が、たとえば変換候補が現在メニューに表示されているセグメントのように、インプット・メソッドが現在実行中の範囲かどうかを示します。stateは変換の状態を表します。 状態値はインプット・メソッド・フレームワークによって定義され、抽象スタイルから具象スタイルへの全マッピングにおいて識別される必要があります。 現在定義されている状態値は、raw (未変換)の値および変換された値です。 これらの状態値は、テキスト変換の主な変換ステップの前後、つまりカナ漢字変換またはピン・イン漢字変換の前後に使用することをお薦めします。 variationフィールドでは、インプット・メソッドが変換結果に関する追加情報を表すことができます。

InputMethodHighlightのインスタンスは、通常、INPUT_METHOD_HIGHLIGHT属性のAttributedCharacterIteratorから返される属性値として使用されます。 個別のテキスト・セグメントを示すために、Annotationインスタンスにラップされることがあります。

導入されたバージョン:
1.2
関連項目:
AttributedCharacterIterator

  • フィールド詳細

    • RAW_TEXT

      public static final int RAW_TEXT
      未変換テキストの状態の定数です。
      関連項目:
      定数フィールド値

    • CONVERTED_TEXT

      public static final int CONVERTED_TEXT
      変換済みテキストの状態の定数です。
      関連項目:
      定数フィールド値

    • UNSELECTED_RAW_TEXT_HIGHLIGHT

      public static final InputMethodHighlight UNSELECTED_RAW_TEXT_HIGHLIGHT
      選択されていない未変換テキストのデフォルトのハイライトの定数です。

    • SELECTED_RAW_TEXT_HIGHLIGHT

      public static final InputMethodHighlight SELECTED_RAW_TEXT_HIGHLIGHT
      選択された未変換テキストのデフォルトのハイライトの定数です。

    • UNSELECTED_CONVERTED_TEXT_HIGHLIGHT

      public static final InputMethodHighlight UNSELECTED_CONVERTED_TEXT_HIGHLIGHT
      選択されていない変換済みテキストのデフォルトのハイライトの定数です。

    • SELECTED_CONVERTED_TEXT_HIGHLIGHT

      public static final InputMethodHighlight SELECTED_CONVERTED_TEXT_HIGHLIGHT
      選択された変換済みテキストのデフォルトのハイライトの定数です。

  • コンストラクタの詳細

    • InputMethodHighlight

      public InputMethodHighlight​(boolean selected, int state)
      インプット・メソッドのハイライト・レコードを作成します。 variationは0、styleはnullに設定されます。
      パラメータ:
      selected - テキスト範囲が選択されているかどうか
      state - テキスト範囲の変換状態(RAW_TEXTまたはCONVERTED_TEXT)
      例外:
      IllegalArgumentException - RAW_TEXTまたはCONVERTED_TEXT以外の状態が指定された場合
      関連項目:
      RAW_TEXT, CONVERTED_TEXT

    • InputMethodHighlight

      public InputMethodHighlight​(boolean selected, int state, int variation)
      インプット・メソッドのハイライト・レコードを作成します。 styleはnullに設定されます。
      パラメータ:
      selected - テキスト範囲が選択されているかどうか
      state - テキスト範囲の変換状態(RAW_TEXTまたはCONVERTED_TEXT)
      variation - テキスト範囲のスタイルのバリエーション
      例外:
      IllegalArgumentException - RAW_TEXTまたはCONVERTED_TEXT以外の状態が指定された場合
      関連項目:
      RAW_TEXT, CONVERTED_TEXT

    • InputMethodHighlight

      public InputMethodHighlight​(boolean selected, int state, int variation, Map<TextAttribute,​?> style)
      インプット・メソッドのハイライト・レコードを作成します。 提供されるstyle属性マップは変更不可能にする必要があります。
      パラメータ:
      selected - テキスト範囲が選択されているかどうか
      state - テキスト範囲の変換状態(RAW_TEXTまたはCONVERTED_TEXT)
      variation - テキスト範囲のバリエーション
      style - テキスト範囲の描画スタイル属性、またはnull
      例外:
      IllegalArgumentException - RAW_TEXTまたはCONVERTED_TEXT以外の状態が指定された場合
      導入されたバージョン:
      1.3
      関連項目:
      RAW_TEXT, CONVERTED_TEXT

  • メソッドの詳細

    • isSelected

      public boolean isSelected()
      テキスト範囲が選択されているかどうかを返します。
      戻り値:
      テキスト範囲が選択されているかどうか

    • getState

      public int getState()
      テキスト範囲の変換状態を返します。
      戻り値:
      テキスト範囲の変換状態。RAW_TEXTまたはCONVERTED_TEXT
      関連項目:
      RAW_TEXT, CONVERTED_TEXT

    • getVariation

      public int getVariation()
      テキスト範囲のバリエーションを返します。
      戻り値:
      テキスト範囲の変化

    • getStyle

      public Map<TextAttribute,​?> getStyle()
      テキスト範囲の描画スタイル属性、またはnullを返します。
      戻り値:
      テキスト範囲のレンダリング・スタイル属性、またはnull
      導入されたバージョン:
      1.3