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) を使って具象スタイルにマップする必要があります。

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

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

導入されたバージョン:

1.2

関連項目:

AttributedCharacterIterator

フィールドの概要

static int	CONVERTED_TEXT 変換済みテキストの状態の定数です。
static int	RAW_TEXT 未変換テキストの状態の定数です。
static InputMethodHighlight	SELECTED_CONVERTED_TEXT_HIGHLIGHT 選択された変換済みテキストのデフォルトのハイライトの定数です。
static InputMethodHighlight	SELECTED_RAW_TEXT_HIGHLIGHT 選択された未変換テキストのデフォルトのハイライトの定数です。
static InputMethodHighlight	UNSELECTED_CONVERTED_TEXT_HIGHLIGHT 選択されていない変換済みテキストのデフォルトのハイライトの定数です。
static InputMethodHighlight	UNSELECTED_RAW_TEXT_HIGHLIGHT 選択されていない未変換テキストのデフォルトのハイライトの定数です。

コンストラクタの概要

InputMethodHighlight(boolean selected, int state)
インプットメソッドのハイライトレコードを作成します。

InputMethodHighlight(boolean selected, int state, int variation)
インプットメソッドのハイライトレコードを作成します。

InputMethodHighlight(boolean selected, int state, int variation, Map style)
インプットメソッドのハイライトレコードを作成します。

メソッドの概要

int	getState() テキスト範囲の変換状態を返します。
Map	getStyle() テキスト範囲の描画スタイル属性、または null を返します。
int	getVariation() テキスト範囲のバリエーションを返します。
boolean	isSelected() テキスト範囲が選択されているかどうかを返します。

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

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

フィールドの詳細

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 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 getStyle()

テキスト範囲の描画スタイル属性、または null を返します。

導入されたバージョン:

1.3