モジュール javafx.controls
パッケージ javafx.scene.control

クラスTextInputControl

    • プロパティの詳細

      • font

        public final ObjectProperty<Font> fontProperty
        TextInputControl内のテキストに使用するデフォルト・フォント。 TextInputControlのテキストがリッチ・テキストである場合、このフォントを使用できるかどうかはリッチ・テキストに埋め込まれたフォント情報に応じて異なりますが、デフォルトのフォントが要求された場合は、常にこのフォントが使用されます。
        導入されたバージョン:
        JavaFX 8.0
        関連項目:
        getFont()、setFont(Font)

      • promptText

        public final StringProperty promptTextProperty
        TextInputControlに表示するプロンプト・テキスト。 nullまたは空文字列に設定されている場合、プロンプト・テキストは表示されません。
        デフォルト値:
        空のString
        導入されたバージョン:
        JavaFX 2.2
        関連項目:
        getPromptText()、setPromptText(String)

      • textFormatter

        public final ObjectProperty<TextFormatter<?>> textFormatterProperty
        このプロパティには、現在アタッチされているTextFormatterが含まれます。 値はFormatterの一部であるため、TextFormatterを変更すると、新しいtextFormatterに基づいてテキストが更新されます。
        デフォルト値:
        null
        導入されたバージョン:
        JavaFX 8u40
        関連項目:
        getTextFormatter()、setTextFormatter(TextFormatter)

      • anchor

        public final ReadOnlyIntegerProperty anchorProperty
        テキスト選択のanchor。 anchorとcaretPositionによって選択範囲が構成されます。 選択は、常に開始<=終了という観点で指定される必要がありますが、anchorはcaretPositionより小さく、大きく、または等しくすることができます。 anchorは、ユーザーがテキストを選択する方法に応じて、選択の下限または上限を表します。
        関連項目:
        getAnchor()

      • caretPosition

        public final ReadOnlyIntegerProperty caretPositionProperty
        テキスト内のキャレットの現在の位置。 anchorとcaretPositionによって選択範囲が構成されます。 選択は、常に開始<=終了という観点で指定される必要がありますが、anchorはcaretPositionより小さく、大きく、または等しくすることができます。 caretPositionは、ユーザーがテキストを選択する方法に応じて、選択の下限または上限を表します。
        関連項目:
        getCaretPosition()

      • undoable

        public final ReadOnlyBooleanProperty undoableProperty
        このプロパティは、実行されたコンテンツの最新の変更を元に戻すことが現在可能かどうかを記述します。
        デフォルト値:
        false
        導入されたバージョン:
        JavaFX 8u40
        関連項目:
        isUndoable()

      • redoable

        public final ReadOnlyBooleanProperty redoableProperty
        このプロパティは、元に戻されたコンテンツの最新の変更をやり直すことが現在可能かどうかを記述します。
        デフォルト値:
        false
        導入されたバージョン:
        JavaFX 8u40
        関連項目:
        isRedoable()

    • コンストラクタの詳細

      • TextInputControl

        protected TextInputControl​(TextInputControl.Content content)
        新しいTextInputControlを作成します。 コンテンツは不変のプロパティで、構築時に(null以外として)指定する必要があります。
        パラメータ:
        content - コンテンツのnull以外の実装。

    • メソッドの詳細

      • fontProperty

        public final ObjectProperty<Font> fontProperty​()
        TextInputControl内のテキストに使用するデフォルト・フォント。 TextInputControlのテキストがリッチ・テキストである場合、このフォントを使用できるかどうかはリッチ・テキストに埋め込まれたフォント情報に応じて異なりますが、デフォルトのフォントが要求された場合は、常にこのフォントが使用されます。
        導入されたバージョン:
        JavaFX 8.0
        関連項目:
        getFont()、setFont(Font)

      • setFont

        public final void setFont​(Font value)
        プロパティfontの値を設定します。
        プロパティの説明:
        TextInputControl内のテキストに使用するデフォルト・フォント。 TextInputControlのテキストがリッチ・テキストである場合、このフォントを使用できるかどうかはリッチ・テキストに埋め込まれたフォント情報に応じて異なりますが、デフォルトのフォントが要求された場合は、常にこのフォントが使用されます。
        導入されたバージョン:
        JavaFX 8.0

      • getFont

        public final Font getFont​()
        プロパティfontの値を取得します。
        プロパティの説明:
        TextInputControl内のテキストに使用するデフォルト・フォント。 TextInputControlのテキストがリッチ・テキストである場合、このフォントを使用できるかどうかはリッチ・テキストに埋め込まれたフォント情報に応じて異なりますが、デフォルトのフォントが要求された場合は、常にこのフォントが使用されます。
        導入されたバージョン:
        JavaFX 8.0

      • promptTextProperty

        public final StringProperty promptTextProperty​()
        TextInputControlに表示するプロンプト・テキスト。 nullまたは空文字列に設定されている場合、プロンプト・テキストは表示されません。
        デフォルト値:
        空のString
        導入されたバージョン:
        JavaFX 2.2
        関連項目:
        getPromptText()、setPromptText(String)

      • getPromptText

        public final String getPromptText​()
        プロパティpromptTextの値を取得します。
        プロパティの説明:
        TextInputControlに表示するプロンプト・テキスト。 nullまたは空文字列に設定されている場合、プロンプト・テキストは表示されません。
        デフォルト値:
        空のString
        導入されたバージョン:
        JavaFX 2.2

      • setPromptText

        public final void setPromptText​(String value)
        プロパティpromptTextの値を設定します。
        プロパティの説明:
        TextInputControlに表示するプロンプト・テキスト。 nullまたは空文字列に設定されている場合、プロンプト・テキストは表示されません。
        デフォルト値:
        空のString
        導入されたバージョン:
        JavaFX 2.2

      • textFormatterProperty

        public final ObjectProperty<TextFormatter<?>> textFormatterProperty​()
        このプロパティには、現在アタッチされているTextFormatterが含まれます。 値はFormatterの一部であるため、TextFormatterを変更すると、新しいtextFormatterに基づいてテキストが更新されます。
        デフォルト値:
        null
        導入されたバージョン:
        JavaFX 8u40
        関連項目:
        getTextFormatter()、setTextFormatter(TextFormatter)

      • getTextFormatter

        public final TextFormatter<?> getTextFormatter​()
        プロパティtextFormatterの値を取得します。
        プロパティの説明:
        このプロパティには、現在アタッチされているTextFormatterが含まれます。 値はFormatterの一部であるため、TextFormatterを変更すると、新しいtextFormatterに基づいてテキストが更新されます。
        デフォルト値:
        null
        導入されたバージョン:
        JavaFX 8u40

      • setTextFormatter

        public final void setTextFormatter​(TextFormatter<?> value)
        プロパティtextFormatterの値を設定します。
        プロパティの説明:
        このプロパティには、現在アタッチされているTextFormatterが含まれます。 値はFormatterの一部であるため、TextFormatterを変更すると、新しいtextFormatterに基づいてテキストが更新されます。
        デフォルト値:
        null
        導入されたバージョン:
        JavaFX 8u40

      • getContent

        protected final TextInputControl.Content getContent​()
        テキスト入力のコンテンツ・モデルを返します。
        戻り値:
        テキスト入力コンテンツ・モデル

      • getText

        public final String getText​()
        プロパティtextの値を取得します。
        プロパティの説明:
        このTextInputControlのテキスト・コンテンツ。

      • setText

        public final void setText​(String value)
        プロパティtextの値を設定します。
        プロパティの説明:
        このTextInputControlのテキスト・コンテンツ。

      • getLength

        public final int getLength​()
        プロパティlengthの値を取得します。
        プロパティの説明:
        テキスト入力の文字の数。

      • isEditable

        public final boolean isEditable​()
        プロパティeditableの値を取得します。
        プロパティの説明:
        このTextInputControlをユーザーが編集できるかどうかを示します。

      • setEditable

        public final void setEditable​(boolean value)
        プロパティeditableの値を設定します。
        プロパティの説明:
        このTextInputControlをユーザーが編集できるかどうかを示します。

      • getSelection

        public final IndexRange getSelection​()
        プロパティselectionの値を取得します。
        プロパティの説明:
        現在の選択。

      • getSelectedText

        public final String getSelectedText​()
        プロパティselectedTextの値を取得します。
        プロパティの説明:
        選択されるTextInputControlの文字を定義します

      • getAnchor

        public final int getAnchor​()
        プロパティanchorの値を取得します。
        プロパティの説明:
        テキスト選択のanchor。 anchorとcaretPositionによって選択範囲が構成されます。 選択は、常に開始<=終了という観点で指定される必要がありますが、anchorはcaretPositionより小さく、大きく、または等しくすることができます。 anchorは、ユーザーがテキストを選択する方法に応じて、選択の下限または上限を表します。

      • anchorProperty

        public final ReadOnlyIntegerProperty anchorProperty​()
        テキスト選択のanchor。 anchorとcaretPositionによって選択範囲が構成されます。 選択は、常に開始<=終了という観点で指定される必要がありますが、anchorはcaretPositionより小さく、大きく、または等しくすることができます。 anchorは、ユーザーがテキストを選択する方法に応じて、選択の下限または上限を表します。
        関連項目:
        getAnchor()

      • getCaretPosition

        public final int getCaretPosition​()
        プロパティcaretPositionの値を取得します。
        プロパティの説明:
        テキスト内のキャレットの現在の位置。 anchorとcaretPositionによって選択範囲が構成されます。 選択は、常に開始<=終了という観点で指定される必要がありますが、anchorはcaretPositionより小さく、大きく、または等しくすることができます。 caretPositionは、ユーザーがテキストを選択する方法に応じて、選択の下限または上限を表します。

      • caretPositionProperty

        public final ReadOnlyIntegerProperty caretPositionProperty​()
        テキスト内のキャレットの現在の位置。 anchorとcaretPositionによって選択範囲が構成されます。 選択は、常に開始<=終了という観点で指定される必要がありますが、anchorはcaretPositionより小さく、大きく、または等しくすることができます。 caretPositionは、ユーザーがテキストを選択する方法に応じて、選択の下限または上限を表します。
        関連項目:
        getCaretPosition()

      • isUndoable

        public final boolean isUndoable​()
        プロパティundoableの値を取得します。
        プロパティの説明:
        このプロパティは、実行されたコンテンツの最新の変更を元に戻すことが現在可能かどうかを記述します。
        デフォルト値:
        false
        導入されたバージョン:
        JavaFX 8u40

      • undoableProperty

        public final ReadOnlyBooleanProperty undoableProperty​()
        このプロパティは、実行されたコンテンツの最新の変更を元に戻すことが現在可能かどうかを記述します。
        デフォルト値:
        false
        導入されたバージョン:
        JavaFX 8u40
        関連項目:
        isUndoable()

      • isRedoable

        public final boolean isRedoable​()
        プロパティredoableの値を取得します。
        プロパティの説明:
        このプロパティは、元に戻されたコンテンツの最新の変更をやり直すことが現在可能かどうかを記述します。
        デフォルト値:
        false
        導入されたバージョン:
        JavaFX 8u40

      • redoableProperty

        public final ReadOnlyBooleanProperty redoableProperty​()
        このプロパティは、元に戻されたコンテンツの最新の変更をやり直すことが現在可能かどうかを記述します。
        デフォルト値:
        false
        導入されたバージョン:
        JavaFX 8u40
        関連項目:
        isRedoable()

      • getText

        public String getText​(int start,
                      int end)
        テキスト入力のコンテンツのサブセットを返します。
        パラメータ:
        start - 0から終了- 1の値にする必要があります。
        end - その長さ以下にする必要があります。
        戻り値:
        テキスト入力コンテンツのサブセット

      • appendText

        public void appendText​(String text)
        コンテンツに文字シーケンスを追加します。
        パラメータ:
        text - null以外の文字列。

      • insertText

        public void insertText​(int index,
                       String text)
        コンテンツに文字シーケンスを挿入します。
        パラメータ:
        index - テキストを挿入する位置。
        text - 挿入するテキスト。

      • deleteText

        public void deleteText​(IndexRange range)
        特定範囲の文字をコンテンツから削除します。
        パラメータ:
        range - 削除するテキストの範囲。 範囲オブジェクトはnullにしないでください。
        関連項目:
        deleteText(int, int)

      • deleteText

        public void deleteText​(int start,
                       int end)
        特定範囲の文字をコンテンツから削除します。
        パラメータ:
        start - 範囲の開始インデックス(この値を含む)。 これは0以上で終了より小さくする必要があります。
        end - 範囲の終了インデックス(この値を含まない)。 これは削除する最後の文字の1つ後です(文字列操作メソッドと一貫性があります)。 これは開始よりも大きく、テキストの長さ以下にする必要があります。

      • replaceText

        public void replaceText​(IndexRange range,
                        String text)
        特定範囲の文字を指定されたテキストに置き換えます。
        パラメータ:
        range - 置換するテキストの範囲。 範囲オブジェクトはnullにしないでください。
        text - 範囲を置換するテキスト。 nullは指定できません。
        関連項目:
        replaceText(int, int, String)

      • replaceText

        public void replaceText​(int start,
                        int end,
                        String text)
        特定範囲の文字を指定されたテキストに置き換えます。
        パラメータ:
        start - 範囲の開始インデックス(この値を含む)。 これは0以上で終了より小さくする必要があります。
        end - 範囲の終了インデックス(この値を含まない)。 これは削除する最後の文字の1つ後です(文字列操作メソッドと一貫性があります)。 これは開始よりも大きく、テキストの長さ以下にする必要があります。
        text - 範囲を置換するテキスト。 nullは指定できません。

      • cut

        public void cut​()
        テキスト内で現在選択されている範囲をクリップボードに転送して、現在の選択を解除します。

      • copy

        public void copy​()
        テキスト内で現在選択されている範囲をクリップボードに転送して、選択はそのまま残します。

      • paste

        public void paste​()
        クリップボードのコンテンツをこのテキストに転送し、現在の選択と置き換えます。 選択範囲がない場合、クリップボードのコンテンツは現在のキャレットの位置に挿入されます。

      • selectBackward

        public void selectBackward​()
        テキスト内の選択を1文字分逆方向に移動します。 caretPositionに対するanchorの位置に応じて、これに選択解除の効果がある場合があります。 この関数は、実質的には単にcaretPositionを移動します。

      • selectForward

        public void selectForward​()
        テキスト内の選択を1文字分順方向に移動します。 caretPositionに対するanchorの位置に応じて、これに選択解除の効果がある場合があります。 この関数は、実質的には単にキャレットを順方向に移動します。

      • previousWord

        public void previousWord​()
        キャレットを前の単語の先頭に移動します。 この関数にも、選択をクリアする効果があります。

      • nextWord

        public void nextWord​()
        キャレットを次の単語の先頭に移動します。 この関数にも、選択をクリアする効果があります。

      • endOfNextWord

        public void endOfNextWord​()
        キャレットを次の単語の終わりに移動します。 この関数にも、選択をクリアする効果があります。

      • selectPreviousWord

        public void selectPreviousWord​()
        キャレットを前の単語の先頭に移動します。 これによって選択がクリアされることはありません。 正確には、anchorの配置が維持され、caretPositionが前の単語の先頭に移動します。

      • selectNextWord

        public void selectNextWord​()
        キャレットを次の単語の先頭に移動します。 これによって選択がクリアされることはありません。 正確には、anchorの配置が維持され、caretPositionが次の単語の先頭に移動します。

      • selectEndOfNextWord

        public void selectEndOfNextWord​()
        キャレットを次の単語の終わりに移動します。 これによって選択がクリアされることはありません。

      • selectAll

        public void selectAll​()
        テキスト入力のすべてのテキストを選択します。

      • home

        public void home​()
        キャレットをテキストの最初の文字の前に移動します。 この関数にも、選択をクリアする効果があります。

      • end

        public void end​()
        キャレットをテキストの最後の文字の後に移動します。 この関数にも、選択をクリアする効果があります。

      • selectHome

        public void selectHome​()
        キャレットをテキストの最初の文字の前に移動します。 これによって選択がクリアされることはありません。 正確には、anchorの配置が維持され、caretPositionが最初の文字の前に移動します。

      • selectEnd

        public void selectEnd​()
        キャレットをテキストの最後の文字の後に移動します。 これによって選択がクリアされることはありません。 正確には、anchorの配置が維持され、caretPositionが最後の文字の後に移動します。

      • deletePreviousChar

        public boolean deletePreviousChar​()
        何も選択されていない場合は現在のキャレット位置の直前にある文字をテキストから削除し、選択がある場合はそれを削除します。 この関数は、削除が成功した場合はtrueを返し、それ以外の場合はfalseを返します。
        戻り値:
        削除が成功した場合はtrue、そうでない場合はfalse

      • deleteNextChar

        public boolean deleteNextChar​()
        何も選択されていない場合は現在のキャレット位置の直後にある文字をテキストから削除し、選択がある場合はそれを削除します。 この関数は、削除が成功した場合はtrueを返し、それ以外の場合はfalseを返します。
        戻り値:
        削除が成功した場合はtrue、そうでない場合はfalse

      • forward

        public void forward​()
        キャレットの位置を順方向に移動します。 選択範囲がない場合、キャレットの位置が1文字分順方向に移動されます。 選択範囲がある場合、キャレットの位置が選択範囲の終わりに移動されて、選択がクリアされます。

      • backward

        public void backward​()
        キャレットの位置を逆方向に移動します。 選択範囲がない場合、キャレットの位置が1文字分逆方向に移動されます。 選択範囲がある場合、キャレットの位置が選択範囲の先頭に移動されて、選択がクリアされます。 ノート: この機能は、主に新しいスキンまたはビヘイビアを実装する者が専門家によって使用されることを意図しています。 開発者や設計者がこの機能に直接アクセスするのは一般的ではありません。

      • positionCaret

        public void positionCaret​(int pos)
        posによって指定された位置にキャレットを配置します。 また、この関数により、選択がクリアされます。
        パラメータ:
        pos - 位置

      • selectPositionCaret

        public void selectPositionCaret​(int pos)
        posによって指定された位置にキャレットを配置し、選択がある場合はそれを拡張します。 選択範囲がない場合、アンカーが現在のキャレット位置にある場合に選択が形成され、caretPositionがposに移動されます。
        パラメータ:
        pos - 位置

      • selectRange

        public void selectRange​(int anchor,
                        int caretPosition)
        anchorとcaretPositionを明示的に配置します。
        パラメータ:
        anchor - アンカー
        caretPosition - caretPosition

      • extendSelection

        public void extendSelection​(int pos)
        この関数により、指定された位置が含まれるように選択が拡張されます。 これは、キャレットを単に移動するわけではないという点でselectPositionCaretとは異なります。 正確には、これによって必要に応じてキャレットとアンカーの位置が変更され、posが新しいキャレットになり、選択範囲の逆側の端がアンカーになります。
        パラメータ:
        pos - 位置

      • clear

        public void clear​()
        テキストをクリアします。

      • deselect

        public void deselect​()
        選択をクリアします。

      • replaceSelection

        public void replaceSelection​(String replacement)
        選択を指定した置換文字列に置き換えます。 選択範囲がない場合、置換テキストは単に現在のキャレットの位置に挿入されます。 選択範囲がある場合、選択がクリアされて、指定した置換テキストが挿入されます。
        パラメータ:
        replacement - 置換文字列

      • undo

        public final void undo​()
        可能な場合、最後の変更を元に戻します。 isUndoable()がfalseを返す場合は、このメソッドを呼び出しても無効です。
        導入されたバージョン:
        JavaFX 8u40

      • redo

        public final void redo​()
        可能な場合、元に戻された最後の変更をやり直します。 isRedoable()がfalseを返す場合は、このメソッドを呼び出しても無効です。
        導入されたバージョン:
        JavaFX 8u40

      • commitValue

        public final void commitValue​()
        現在のテキストをコミットして、値に変換します。
        導入されたバージョン:
        JavaFX 8u40

      • cancelEdit

        public final void cancelEdit​()
        このフィールドが現在編集中の場合、このコールによりテキストが最後にコミットされた値に設定されます。
        導入されたバージョン:
        JavaFX 8u40

      • getClassCssMetaData

        public static List<CssMetaData<? extends Styleable,?>> getClassCssMetaData​()
        戻り値:
        このクラスに関連付けられたCssMetaData。スーパークラスのCssMetaDataを含むことがあります。
        導入されたバージョン:
        JavaFX 8.0

      • getControlCssMetaData

        public List<CssMetaData<? extends Styleable,?>> getControlCssMetaData​()
        オーバーライド:
        getControlCssMetaData 、クラス: Control
        戻り値:
        コントロールのCSSでスタイル設定可能なプロパティの変更不可能なリスト
        導入されたバージョン:
        JavaFX 8.0

      • queryAccessibleAttribute

        public Object queryAccessibleAttribute​(AccessibleAttribute attribute,
                                       Object... parameters)
        このメソッドは、属性の値をリクエストするためにアシスティブ・テクノロジによって呼び出されます。

        このメソッドは一般に、特定の役割に必要な属性を実装するためにサブクラスによってオーバーライドされます。
        特定の属性が処理されない場合は、スーパークラスの実装を呼び出す必要があります。

        オーバーライド:
        queryAccessibleAttribute、クラス: Control
        パラメータ:
        attribute - リクエストされた属性
        parameters - オプションのパラメータ・リスト
        戻り値:
        リクエストされた属性の値
        関連項目:
        AccessibleAttribute

      • executeAccessibleAction

        public void executeAccessibleAction​(AccessibleAction action,
                                    Object... parameters)
        このメソッドは、引数で指定されたアクションの実行をリクエストするためにアシスティブ・テクノロジによって呼び出されます。

        このメソッドは一般に、特定の役割に必要なアクションを実装するためにサブクラスによってオーバーライドされます。
        特定のアクションが処理されない場合は、スーパークラスの実装を呼び出す必要があります。

        オーバーライド:
        executeAccessibleAction、クラス: Control
        パラメータ:
        action - 実行するアクション
        parameters - オプションのパラメータ・リスト
        関連項目:
        「AccessibleAction」