flash.text.imeIIMEClient IME(入力方式エディター)クライアントのインターフェイス。 IME(入力方式エディター)クライアントのインターフェイス。IME を使用したテキストのインライン編集をサポートするには、flash.text.engine パッケージに基づくコンポーネントに、このインターフェイスを実装する必要があります。このインターフェイスは、TextField オブジェクトでは使用されません。TextLayoutFramework(TLF)がこのインターフェイスを使用してインライン IME をサポートするため、TLF を使用するクライアントはこのインターフェイスを実装する必要はありません。

インライン IME をサポートするには、ImeEvent.IME_START_COMPOSITION イベントの imeClient プロパティに、このインターフェイスを実装するオブジェクトを設定します。

以下に、IME 関連の API でよく使用される用語について説明します。

  • 交信とは、IME とアプリケーション間のやりとりのことです。交信中は、入力は 1 回以上更新され、その後、ユーザーによって確定されます。
  • 入力とは、ユーザーが IME を使用して入力したテキストと、そのテキストに関連する入力状態情報(選択範囲や節範囲など)を示します。
  • とは、意味情報(その入力が選択と変換のどちらの状態にあるかを示す情報など)を共有する可能性のある入力の範囲を示します。入力は、0 個以上の節を含みます。
flash.text.ime.CompositionAttributeRangeflash.events.IMEEvent.imeClienttextInput ユーザーがテキストを入力したときに送出されます。flash.events.TextEvent.TEXT_INPUTflash.events.TextEvent ユーザーがテキストを入力したときに送出されます。IME(入力方式エディター)クライアントの場合、受信側は、現在のカーソル(キャレット)位置に、イベントオブジェクトの text プロパティに格納されているストリングを挿入する必要があります。 imeStartComposition ユーザーが IME(入力方式エディター)の使用を開始したときに送出されます。flash.events.IMEEvent.IME_START_COMPOSITIONflash.events.IMEEvent ユーザーが IME(入力方式エディター)の使用を開始したときに送出されます。 confirmComposition このコールバックを使用してインライン編集セッションを終了し、テキストを確定します。textStringnull インラインセッションでのテキストの最終状態(確定されたテキスト)。 preserveSelectionBooleanfalse true の場合は、選択範囲を確認済みテキストの最後にリセットしないでください。 このコールバックを使用してインライン編集セッションを終了し、テキストを確定します。 getTextBounds IME は、このメソッドを使用して、IME クライアントで現在編集されているテキストのバウンディングボックスを照会します。指定したテキストの範囲のバウンディングボックス、あるいはインデックスのどちらか一方または両方が無効な場合は null です。このメソッドは、startIndexendIndex より大きい場合でも小さい場合でも、同じ値を返します。startIndexendIndex より大きい場合でも小さい場合でも、同じ値が返されます。 flash.geom:RectanglestartIndexint測定するバウンディングボックス内のテキスト範囲の開始位置を指定する整数。 endIndexintオプション。測定するバウンディングボックス内のテキスト範囲の終了位置を指定する整数。 IME は、このメソッドを使用して、IME クライアントで現在編集されているテキストのバウンディングボックスを照会します。このメソッドを使用すると、テキストフィールド上または IME をサポートする他のコンポーネント上にマウスがあるときに、IME クライアントに候補ウィンドウが配置され、マウスカーソルが設定されます。 getTextInRange コンポーネント内の指定されたテキスト範囲を取得します。要求されたテキスト。指定された範囲にテキストがない場合やインデックスの一方または両方が無効の場合は、nullstartIndexendIndex より大きい場合でも小さい場合でも、同じ値が返されます。 StringstartIndexint取得するテキスト範囲の開始位置を指定する整数。 endIndexint取得するテキストの範囲の終了位置を指定する整数。 コンポーネント内の指定されたテキスト範囲を取得します。このメソッドは、IME の再変換時に呼び出されます。 selectRange 選択されたテキスト範囲をコンポーネント内に設定します。anchorIndexint選択のアンカー終点位置にある文字の、ゼロベースのインデックス値 activeIndexint選択のアクティブ終点位置にある文字の、ゼロベースのインデックス値 選択されたテキスト範囲をコンポーネント内に設定します。いずれかの引数が範囲外である場合、選択は変更されません。 updateComposition インライン編集セッションの内容を更新するためのコールバックです。textString IME からのインライン編集セッションのテキストを格納します。 attributes 修飾情報が追加された入力節の配列を格納します。 compositionStartIndexint テキストオブジェクトの開始点を基準とする相対的なインラインセッションの開始位置。 compositionEndIndexint テキストオブジェクトの開始点を基準とする相対的なインラインセッションの終了位置。 インライン編集セッションの内容を更新するためのコールバックです。このメソッドは、IME で編集中のテキストが編集されたときに必ず呼び出され、その内容はインライン編集セッション全体を再読み込みするためにクライアントによって使用されます。 compositionEndIndex 現在の編集セッションテキスト(ドキュメントに対してまだ確定されていないインラインセッション内のすべてのテキストなど)の終了点を示す、0 から始まるインデックス値です。int 現在の編集セッションテキスト(ドキュメントに対してまだ確定されていないインラインセッション内のすべてのテキストなど)の終了点を示す、0 から始まるインデックス値です。 compositionStartIndex 現在の編集セッションテキスト(ドキュメントに対してまだ確定されていないインラインセッション内のすべてのテキストなど)の開始点を示す、0 から始まるインデックス値です。int 現在の編集セッションテキスト(ドキュメントに対してまだ確定されていないインラインセッション内のすべてのテキストなど)の開始点を示す、0 から始まるインデックス値です。 selectionActiveIndex 現在の選択範囲における最後の文字を示す、0 から始まるインデックス値です。int 現在の選択範囲における最後の文字を示す、0 から始まるインデックス値です。 selectionAnchorIndex 現在の選択範囲の最初の文字を示す、0 から始まるインデックス値です。int 現在の選択範囲の最初の文字を示す、0 から始まるインデックス値です。 verticalTextLayout コンポーネント内のテキストを縦書きにするかどうかを指定します。Boolean コンポーネント内のテキストを縦書きにするかどうかを指定します。このプロパティは、候補ウィンドウの位置を指定します(縦書き文字の横、横書き文字の下など)。
CompositionAttributeRange CompositionAttributeRange クラスは、IME(入力方式エディター)イベントで使用する入力属性の範囲を表します。Object CompositionAttributeRange クラスは、IME(入力方式エディター)イベントで使用する入力属性の範囲を表します。例えば、IME でテキストを編集する場合、テキストが IME によって複数の入力範囲に分割されます。これらの入力範囲には、選択済み(拡大中、縮小中、編集中などの場合)、または変換済み(その範囲は既に IME 辞書ルックアップを実行済みであることを示す)のフラグが設定されます。

規則により、クライアントは、設定されたフラグに応じて入力範囲を下線や強調表示で修飾します。

次に実際の使用例を示します。

!converted = thick gray underline (raw text) !selected && converted = thin black underline selected && converted = thick black underline
flash.text.ime.IIMEClientCompositionAttributeRange CompositionAttributeRange オブジェクトを作成します。relativeStartint 文字範囲に含まれる最初の文字を示す、0 から始まるインデックスです。 relativeEndint 文字範囲に含まれる最後の文字を示す、0 から始まるインデックスです。 selectedBoolean 現在の入力節がアクティブであるかどうかを定義します。 convertedBoolean 現在の節が IME によって処理されていて、ユーザーの確定を待機していること定義します。 CompositionAttributeRange オブジェクトのコンストラクターです。 CompositionAttributeRange オブジェクトを作成します。 converted 現在の節が IME で処理されており、ユーザーの承認または確定を待機していることを定義するプロパティ。Boolean 現在の節が IME で処理されており、ユーザーの承認または確定を待機していることを定義するプロパティ。 relativeEnd インライン編集セッションの開始点を基準とする、入力節の相対的な終了位置。int インライン編集セッションの開始点を基準とする、入力節の相対的な終了位置。例えば、0 は、IME が読み取るテキストの最初の文字を示します(ただし、編集フィールド内には、この文字よりも手前にテキストが存在することがあります)。 relativeStart 現在のインライン編集セッションの開始点を基準とする、相対的な開始位置。int 現在のインライン編集セッションの開始点を基準とする、相対的な開始位置。例えば、0 は、IME が読み取るテキストの最初の文字を示します(ただし、編集フィールド内には、この文字よりも手前にテキストが存在することがあります)。 selected 現在の入力節がアクティブであり、IME によって拡大、縮小または編集されているが、隣接する節は変更されないことを定義するプロパティ。Boolean 現在の入力節がアクティブであり、IME によって拡大、縮小または編集されているが、隣接する節は変更されないことを定義するプロパティ。