| パッケージ | flash.text.ime |
| インターフェイス | public interface IIMEClient |
| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10.1, AIR 2 |
インライン IME をサポートするには、ImeEvent.IME_START_COMPOSITION イベントの imeClient プロパティに、このインターフェイスを実装するオブジェクトを設定します。
以下に、IME 関連の API でよく使用される用語について説明します。
- 交信とは、IME とアプリケーション間のやりとりのことです。交信中は、入力は 1 回以上更新され、その後、ユーザーによって確定されます。
- 入力とは、ユーザーが IME を使用して入力したテキストと、そのテキストに関連する入力状態情報（選択範囲や節範囲など）を示します。
- 節とは、意味情報（その入力が選択と変換のどちらの状態にあるかを示す情報など）を共有する可能性のある入力の範囲を示します。入力は、0 個以上の節を含みます。
関連する API エレメント
パブリックプロパティ
| プロパティ | 定義元 | ||
|---|---|---|---|
| compositionEndIndex : int [読み取り専用]
現在の編集セッションテキスト（ドキュメントに対してまだ確定されていないインラインセッション内のすべてのテキストなど）の終了点を示す、0 から始まるインデックス値です。 | IIMEClient | ||
| compositionStartIndex : int [読み取り専用]
現在の編集セッションテキスト（ドキュメントに対してまだ確定されていないインラインセッション内のすべてのテキストなど）の開始点を示す、0 から始まるインデックス値です。 | IIMEClient | ||
| selectionActiveIndex : int [読み取り専用]
現在の選択範囲における最後の文字を示す、0 から始まるインデックス値です。 | IIMEClient | ||
| selectionAnchorIndex : int [読み取り専用]
現在の選択範囲の最初の文字を示す、0 から始まるインデックス値です。 | IIMEClient | ||
| verticalTextLayout : Boolean [読み取り専用]
コンポーネント内のテキストを縦書きにするかどうかを指定します。 | IIMEClient | ||
パブリックメソッド
| メソッド | 定義元 | ||
|---|---|---|---|
このコールバックを使用してインライン編集セッションを終了し、テキストを確定します。 | IIMEClient | ||
IME は、このメソッドを使用して、IME クライアントで現在編集されているテキストのバウンディングボックスを照会します。 | IIMEClient | ||
コンポーネント内の指定されたテキスト範囲を取得します。 | IIMEClient | ||
選択されたテキスト範囲をコンポーネント内に設定します。 | IIMEClient | ||
updateComposition(text:String, attributes:Vector.<CompositionAttributeRange>, compositionStartIndex:int, compositionEndIndex:int):void
インライン編集セッションの内容を更新するためのコールバックです。 | IIMEClient | ||
イベント
| イベント | 概要 | 定義元 | ||
|---|---|---|---|---|
| ユーザーが IME（入力方式エディター）の使用を開始したときに送出されます。 | IIMEClient | |||
| ユーザーがテキストを入力したときに送出されます。 | IIMEClient | |||
プロパティの詳細
compositionEndIndex | プロパティ |
compositionStartIndex | プロパティ |
selectionActiveIndex | プロパティ |
selectionAnchorIndex | プロパティ |
verticalTextLayout | プロパティ |
メソッドの詳細
confirmComposition | () | メソッド |
public function confirmComposition(text:String = null, preserveSelection:Boolean = false):void| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10.1, AIR 2 |
このコールバックを使用してインライン編集セッションを終了し、テキストを確定します。
パラメーター
text:String (default = null) | |
preserveSelection:Boolean (default = false) |
getTextBounds | () | メソッド |
public function getTextBounds(startIndex:int, endIndex:int):Rectangle| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10.1, AIR 2 |
IME は、このメソッドを使用して、IME クライアントで現在編集されているテキストのバウンディングボックスを照会します。このメソッドを使用すると、テキストフィールド上または IME をサポートする他のコンポーネント上にマウスがあるときに、IME クライアントに候補ウィンドウが配置され、マウスカーソルが設定されます。
パラメーター
startIndex:int — 測定するバウンディングボックス内のテキスト範囲の開始位置を指定する整数。
| |
endIndex:int — オプション。測定するバウンディングボックス内のテキスト範囲の終了位置を指定する整数。
|
Rectangle — 指定したテキストの範囲のバウンディングボックス、あるいはインデックスのどちらか一方または両方が無効な場合は null です。このメソッドは、startIndex が endIndex より大きい場合でも小さい場合でも、同じ値を返します。startIndex が endIndex より大きい場合でも小さい場合でも、同じ値が返されます。
|
getTextInRange | () | メソッド |
public function getTextInRange(startIndex:int, endIndex:int):String| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10.1, AIR 2 |
コンポーネント内の指定されたテキスト範囲を取得します。このメソッドは、IME の再変換時に呼び出されます。
パラメーター
startIndex:int — 取得するテキスト範囲の開始位置を指定する整数。
| |
endIndex:int — 取得するテキストの範囲の終了位置を指定する整数。
|
String — 要求されたテキスト。指定された範囲にテキストがない場合やインデックスの一方または両方が無効の場合は、null。startIndex が endIndex より大きい場合でも小さい場合でも、同じ値が返されます。
|
selectRange | () | メソッド |
updateComposition | () | メソッド |
public function updateComposition(text:String, attributes:Vector.<CompositionAttributeRange>, compositionStartIndex:int, compositionEndIndex:int):void| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10.1, AIR 2 |
インライン編集セッションの内容を更新するためのコールバックです。このメソッドは、IME で編集中のテキストが編集されたときに必ず呼び出され、その内容はインライン編集セッション全体を再読み込みするためにクライアントによって使用されます。
パラメーター
text:String — IME からのインライン編集セッションのテキストを格納します。
| |
attributes:Vector.<CompositionAttributeRange> — 修飾情報が追加された入力節の配列を格納します。
| |
compositionStartIndex:int — テキストオブジェクトの開始点を基準とする相対的なインラインセッションの開始位置。
| |
compositionEndIndex:int — テキストオブジェクトの開始点を基準とする相対的なインラインセッションの終了位置。
|
イベントの詳細
imeStartComposition | イベント |
イベントオブジェクトの型:
プロパティ IMEEvent.type =
flash.events.IMEEventプロパティ IMEEvent.type =
flash.events.IMEEvent.IME_START_COMPOSITION| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10.1, AIR 2 |
ユーザーが IME（入力方式エディター）の使用を開始したときに送出されます。
IME テキスト入力を処理する場合、レシーバーでは、イベントのimeClient フィールドを、IIMEClient インターフェイスを実装するオブジェクトに設定する必要があります。imeClient が設定されていない場合、ランタイムは、代わりにアウトオブライン IME コンポジションを使用し、最終的なコンポジションを TEXT_INPUT イベントとして送信します。
このイベントには、次のプロパティがあります。
| プロパティ | 値 |
|---|---|
bubbles | false |
cancelable | false は、キャンセルするデフォルトの動作がないことを示します。 |
currentTarget | イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。 |
target | IME オブジェクトです。 |
textInput | イベント |
イベントオブジェクトの型:
プロパティ TextEvent.type =
flash.events.TextEventプロパティ TextEvent.type =
flash.events.TextEvent.TEXT_INPUT| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10.1, AIR 2 |
ユーザーがテキストを入力したときに送出されます。IME（入力方式エディター）クライアントの場合、受信側は、現在のカーソル（キャレット）位置に、イベントオブジェクトの text プロパティに格納されているストリングを挿入する必要があります。
type プロパティ（textInput イベントオブジェクト）の値を定義します。
注意：このイベントは、Delete または Backspace キーについては送出されません。
このイベントには、次のプロパティがあります。
| プロパティ | 値 |
|---|---|
bubbles | true |
cancelable | true。デフォルトの動作を取り消すには、preventDefault() メソッドを呼び出します。 |
currentTarget | イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。 |
target | 文字が入力されるテキストフィールドです。target は、必ずしもイベントリスナーを登録した表示リスト内のオブジェクトとは限りません。現在イベントを処理している表示リスト内のオブジェクトにアクセスするには、currentTarget プロパティを使用します。 |
text | ユーザーが入力した文字または文字の連続です。 |
Tue Jun 12 2018, 10:34 AM Z