モジュール javafx.graphics

パッケージ javafx.scene.input

クラスInputMethodEvent

java.lang.Object

java.util.EventObject

javafx.event.Event

javafx.scene.input.InputEvent

javafx.scene.input.InputMethodEvent

すべての実装されたインタフェース:

Serializable, Cloneable

public final class InputMethodEvent
extends InputEvent

基礎となる入力メソッドがNodeでのテキスト変更を通知することを示すイベント。

コンポジションのテキスト(変換テキスト)が生成/変更/削除されたり、入力メソッドが結果テキストをコミットしたり、入力メソッドのキャレット位置が変更されると、このイベントがTextInputControlを拡張するNodeオブジェクトに配信されます。

このイベントを受け取った後、アプリケーションではビジュアル・フィードバック属性とともに変換テキストをユーザーに表示することになっています。

注意: これは条件付き機能です。 詳細は、ConditionalFeature.INPUT_METHODを参照してください。

導入されたバージョン:

JavaFX 2.0

関連項目:

直列化された形式

フィールドのサマリー

フィールド

修飾子と型	フィールド	説明
static EventType<InputMethodEvent>	ANY	すべての入力メソッド・イベント・タイプに共通のスーパータイプ。
static EventType<InputMethodEvent>	INPUT_METHOD_TEXT_CHANGED	InputMethodEventに対して唯一有効なEventType。

クラス javafx.event.Eventで宣言されたフィールド

consumed、eventType、NULL_SOURCE_TARGET、target

クラス java.util.EventObjectで宣言されたフィールド

source

コンストラクタのサマリー

コンストラクタ

コンストラクタ	説明
InputMethodEvent(Object source, EventTarget target, EventType<InputMethodEvent> eventType, List<InputMethodTextRun> composed, String committed, int caretPosition)	新しいInputMethodEventイベントを構築します。
InputMethodEvent(EventType<InputMethodEvent> eventType, List<InputMethodTextRun> composed, String committed, int caretPosition)	空のソースおよびターゲットを使用した新しいInputMethodEventイベントを構築します。

メソッドのサマリー

修飾子と型	メソッド	説明
int	getCaretPosition()	変換テキスト内での入力メソッドのキャレット位置。
String	getCommitted()	コンポジションの結果として入力メソッドによって確定されるテキストを取得します。
ObservableList<InputMethodTextRun>	getComposed()	コンポジションのテキストを取得します。
String	toString()	このInputMethodEventオブジェクトの文字列表現を返します。

クラス javafx.event.Eventで宣言されたメソッド

clone、consume、copyFor、fireEvent、getEventType、getTarget、isConsumed

クラス java.util.EventObjectで宣言されたメソッド

getSource

クラス java.lang.Objectで宣言されたメソッド

equals、finalize、getClass、hashCode、notify、notifyAll、wait、wait、wait

フィールドの詳細

INPUT_METHOD_TEXT_CHANGED

public static final EventType<InputMethodEvent> INPUT_METHOD_TEXT_CHANGED

InputMethodEventに対して唯一有効なEventType。

ANY

public static final EventType<InputMethodEvent> ANY

すべての入力メソッド・イベント・タイプに共通のスーパータイプ。

導入されたバージョン:

JavaFX 8.0

コンストラクタの詳細

InputMethodEvent

public InputMethodEvent(Object source,
                        EventTarget target,
                        EventType<InputMethodEvent> eventType,
                        List<InputMethodTextRun> composed,
                        String committed,
                        int caretPosition)

新しいInputMethodEventイベントを構築します。

パラメータ:

source - イベントのソース。 nullに設定できます。

target - イベントのターゲット。 nullに設定できます。

eventType - イベントのタイプ。

composed - コンポジションのテキスト

committed - コンポジションの結果として確定されるテキスト

caretPosition - キャレットの現在位置

導入されたバージョン:

JavaFX 8.0

InputMethodEvent

public InputMethodEvent(EventType<InputMethodEvent> eventType,
                        List<InputMethodTextRun> composed,
                        String committed,
                        int caretPosition)

空のソースおよびターゲットを使用した新しいInputMethodEventイベントを構築します。

パラメータ:

eventType - イベントのタイプ。

composed - コンポジションのテキスト

committed - コンポジションの結果として確定されるテキスト

caretPosition - キャレットの現在位置

導入されたバージョン:

JavaFX 8.0

メソッドの詳細

getComposed

public final ObservableList<InputMethodTextRun> getComposed()

コンポジションのテキストを取得します。 このテキストは、各実行にアタッチされたInputMethodHighlightを表す適切なビジュアル・フィードバックとともに表示されます。

戻り値:

コンポジションのテキスト

getCommitted

public final String getCommitted()

コンポジションの結果として入力メソッドによって確定されるテキストを取得します。

戻り値:

確定テキスト

getCaretPosition

public final int getCaretPosition()

変換テキスト内での入力メソッドのキャレット位置。 位置が-1の場合、キャレットは不可視になります。

戻り値:

変換テキスト内での入力メソッドのキャレット位置。

toString

public String toString()

このInputMethodEventオブジェクトの文字列表現を返します。

オーバーライド:

toString、クラス: EventObject

戻り値:

このInputMethodEventオブジェクトの文字列表現