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

クラスChoiceBox<T>

  • すべての実装されたインタフェース:
    Styleable, EventTarget, Skinnable
    @DefaultProperty("items")
public class ChoiceBox<T>
extends Control
    ChoiceBoxは、ユーザーに選択可能な比較的小さいセットの事前に定義された選択項目を示すために使用されます。 ChoiceBoxは、表示されている場合、これらの選択項目をユーザーに表示し、ユーザーが厳密に1つ選択できるようにします。 表示されていない場合、現在の選択が表示されます。

    デフォルトでは、ChoiceBoxには選択されているアイテムはありません(他に指定されている場合を除く)。 ChoiceBoxでは、ユーザーは事前定義済リストからの選択のみ可能ですが、開発者は、事前定義済リストで使用できないアイテムを選択済アイテムとして指定できます。 このことは、いくつかの重要なユースケースで必要となります。

    ChoiceBoxの構成は順序非依存です。 アイテムを指定してから選択済アイテムを指定したり、選択済アイテムを指定してからアイテムを指定することができます。 いずれの方法も正常に機能します。

    ChoiceBoxアイテムの選択は、SelectionModelによって処理されます。ListViewおよびComboBoxと同様、使用されるSelectionModelを変更できます(ただし、変更されることはほとんどありません)。 ChoiceBoxは、使用されるデフォルトがSingleSelectionModelであるため、単一選択モデルのみをサポートします。 

     import javafx.scene.control.ChoiceBox;

 ChoiceBox cb = new ChoiceBox();
 cb.getItems().addAll("item1", "item2", "item3");
    導入されたバージョン:
    JavaFX 2.0

    • プロパティの詳細

      • selectionModel

        public final ObjectProperty<SingleSelectionModel<T>> selectionModelProperty
        ChoiceBoxの選択モデル。 単一の選択のみを行えるため、ChoiceBoxではSingleSelectionModelのみをサポートします。 通常は、選択モデルとの主な対話は、アイテム・リスト内のどのアイテムを選択するかを明示的に設定するか、または選択での変更をリスニングしてどのアイテムが選択されたかを認識することです。
        関連項目:
        getSelectionModel()、setSelectionModel(SingleSelectionModel)

      • showing

        public final ReadOnlyBooleanProperty showingProperty
        ドロップ・ダウンで選択のリストがユーザーに表示されているかどうかを示します。 これは、#showメソッドおよび#hideメソッドで操作される読取り専用プロパティです。
        関連項目:
        isShowing()

      • items

        public final ObjectProperty<ObservableList<T>> itemsProperty
        選択ボックスに表示するアイテム。 選択されたアイテムは(選択モデルで示されているように)、常に、これらのいずれかのアイテムである必要があります。
        関連項目:
        getItems()、setItems(ObservableList)

      • converter

        public ObjectProperty<StringConverter<T>> converterProperty
        アイテム・リストでオブジェクトを表す方法を指定できるようにします。 StringConverterが設定されている場合、オブジェクトのtoStringメソッドは呼び出されず、かわりにそのtoString(object T)が呼び出され、アイテム・リスト内のオブジェクトを渡します。 このプロパティでは、表現のカスタマイズが可能であるため、ChoiceBoxのドメイン・オブジェクトの使用時に役立ちます。 また、javafx.util.converterパッケージで使用可能な、あらかじめ構築されたコンバータを設定することもできます。
        導入されたバージョン:
        JavaFX 2.1
        関連項目:
        getConverter()、setConverter(StringConverter)

      • value

        public ObjectProperty<T> valueProperty
        このChoiceBoxの値は、ChoiceBox選択モデルの選択項目として定義されます。 valuePropertyは、selectedItemと同期されます。 このプロパティでは、ChoiceBoxに対する外部プロパティの双方向バインディングが可能で、それに従って選択モデルを更新します。
        導入されたバージョン:
        JavaFX 2.1
        関連項目:
        getValue()、setValue(T)

      • onAction

        public final ObjectProperty<EventHandler<ActionEvent>> onActionProperty
        ChoiceBoxアクションは、ChoiceBoxのvalueプロパティが変更されたときに呼び出されます。 これは、valueプロパティがプログラムによって変更されているか、ユーザーがポップアップ・メニューでアイテムを選択したことが原因である可能性があります。
        導入されたバージョン:
        JavaFX 8u60
        関連項目:
        getOnAction()、setOnAction(EventHandler)

    • フィールドの詳細

      • ON_SHOWING

        public static final EventType<Event> ON_SHOWING
        ChoiceBoxの前に呼び出され、ユーザーがChoiceBoxをクリックしたり操作したりした後でポップアップを表示します。
        導入されたバージョン:
        JavaFX 8u60

      • ON_SHOWN

        public static final EventType<Event> ON_SHOWN
        ChoiceBoxがポップアップを表示した後に呼び出されます。
        導入されたバージョン:
        JavaFX 8u60

      • ON_HIDING

        public static final EventType<Event> ON_HIDING
        ChoiceBoxポップアップwillが非表示になったときに呼び出されます。
        導入されたバージョン:
        JavaFX 8u60

      • ON_HIDDEN

        public static final EventType<Event> ON_HIDDEN
        ChoiceBoxポップアップが非表示になったときに呼び出されます。
        導入されたバージョン:
        JavaFX 8u60

    • コンストラクタの詳細

      • ChoiceBox

        public ChoiceBox()
        空のアイテム・リストを持つ、新しいChoiceBoxを作成します。

      • ChoiceBox

        public ChoiceBox​(ObservableList<T> items)
        指定されたアイテム・セットを含む新しいChoiceBoxを作成します。 監視可能であるため、このリストのコンテンツが時間の経過に伴って変更されると、ChoiceBoxはそれに従って更新されます。
        パラメータ:
        items - アイテムのセット

    • メソッドの詳細

      • setSelectionModel

        public final void setSelectionModel​(SingleSelectionModel<T> value)
        プロパティselectionModelの値を設定します。
        プロパティの説明:
        ChoiceBoxの選択モデル。 単一の選択のみを行えるため、ChoiceBoxではSingleSelectionModelのみをサポートします。 通常は、選択モデルとの主な対話は、アイテム・リスト内のどのアイテムを選択するかを明示的に設定するか、または選択での変更をリスニングしてどのアイテムが選択されたかを認識することです。

      • getSelectionModel

        public final SingleSelectionModel<T> getSelectionModel()
        プロパティselectionModelの値を取得します。
        プロパティの説明:
        ChoiceBoxの選択モデル。 単一の選択のみを行えるため、ChoiceBoxではSingleSelectionModelのみをサポートします。 通常は、選択モデルとの主な対話は、アイテム・リスト内のどのアイテムを選択するかを明示的に設定するか、または選択での変更をリスニングしてどのアイテムが選択されたかを認識することです。

      • selectionModelProperty

        public final ObjectProperty<SingleSelectionModel<T>> selectionModelProperty()
        ChoiceBoxの選択モデル。 単一の選択のみを行えるため、ChoiceBoxではSingleSelectionModelのみをサポートします。 通常は、選択モデルとの主な対話は、アイテム・リスト内のどのアイテムを選択するかを明示的に設定するか、または選択での変更をリスニングしてどのアイテムが選択されたかを認識することです。
        関連項目:
        getSelectionModel()、setSelectionModel(SingleSelectionModel)

      • isShowing

        public final boolean isShowing()
        プロパティshowingの値を取得します。
        プロパティの説明:
        ドロップ・ダウンで選択のリストがユーザーに表示されているかどうかを示します。 これは、#showメソッドおよび#hideメソッドで操作される読取り専用プロパティです。

      • showingProperty

        public final ReadOnlyBooleanProperty showingProperty()
        ドロップ・ダウンで選択のリストがユーザーに表示されているかどうかを示します。 これは、#showメソッドおよび#hideメソッドで操作される読取り専用プロパティです。
        関連項目:
        isShowing()

      • setItems

        public final void setItems​(ObservableList<T> value)
        プロパティ・アイテムの値を設定します。
        プロパティの説明:
        選択ボックスに表示するアイテム。 選択されたアイテムは(選択モデルで示されているように)、常に、これらのいずれかのアイテムである必要があります。

      • getItems

        public final ObservableList<T> getItems()
        プロパティ・アイテムの値を取得します。
        プロパティの説明:
        選択ボックスに表示するアイテム。 選択されたアイテムは(選択モデルで示されているように)、常に、これらのいずれかのアイテムである必要があります。

      • itemsProperty

        public final ObjectProperty<ObservableList<T>> itemsProperty()
        選択ボックスに表示するアイテム。 選択されたアイテムは(選択モデルで示されているように)、常に、これらのいずれかのアイテムである必要があります。
        関連項目:
        getItems()、setItems(ObservableList)

      • converterProperty

        public ObjectProperty<StringConverter<T>> converterProperty()
        アイテム・リストでオブジェクトを表す方法を指定できるようにします。 StringConverterが設定されている場合、オブジェクトのtoStringメソッドは呼び出されず、かわりにそのtoString(object T)が呼び出され、アイテム・リスト内のオブジェクトを渡します。 このプロパティでは、表現のカスタマイズが可能であるため、ChoiceBoxのドメイン・オブジェクトの使用時に役立ちます。 また、javafx.util.converterパッケージで使用可能な、あらかじめ構築されたコンバータを設定することもできます。
        導入されたバージョン:
        JavaFX 2.1
        関連項目:
        getConverter()、setConverter(StringConverter)

      • setConverter

        public final void setConverter​(StringConverter<T> value)
        プロパティconverterの値を設定します。
        プロパティの説明:
        アイテム・リストでオブジェクトを表す方法を指定できるようにします。 StringConverterが設定されている場合、オブジェクトのtoStringメソッドは呼び出されず、かわりにそのtoString(object T)が呼び出され、アイテム・リスト内のオブジェクトを渡します。 このプロパティでは、表現のカスタマイズが可能であるため、ChoiceBoxのドメイン・オブジェクトの使用時に役立ちます。 また、javafx.util.converterパッケージで使用可能な、あらかじめ構築されたコンバータを設定することもできます。
        導入されたバージョン:
        JavaFX 2.1

      • getConverter

        public final StringConverter<T> getConverter()
        プロパティconverterの値を取得します。
        プロパティの説明:
        アイテム・リストでオブジェクトを表す方法を指定できるようにします。 StringConverterが設定されている場合、オブジェクトのtoStringメソッドは呼び出されず、かわりにそのtoString(object T)が呼び出され、アイテム・リスト内のオブジェクトを渡します。 このプロパティでは、表現のカスタマイズが可能であるため、ChoiceBoxのドメイン・オブジェクトの使用時に役立ちます。 また、javafx.util.converterパッケージで使用可能な、あらかじめ構築されたコンバータを設定することもできます。
        導入されたバージョン:
        JavaFX 2.1

      • valueProperty

        public ObjectProperty<T> valueProperty()
        このChoiceBoxの値は、ChoiceBox選択モデルの選択項目として定義されます。 valuePropertyは、selectedItemと同期されます。 このプロパティでは、ChoiceBoxに対する外部プロパティの双方向バインディングが可能で、それに従って選択モデルを更新します。
        導入されたバージョン:
        JavaFX 2.1
        関連項目:
        getValue()、setValue(T)

      • setValue

        public final void setValue​(T value)
        プロパティvalueの値を設定します。
        プロパティの説明:
        このChoiceBoxの値は、ChoiceBox選択モデルの選択項目として定義されます。 valuePropertyは、selectedItemと同期されます。 このプロパティでは、ChoiceBoxに対する外部プロパティの双方向バインディングが可能で、それに従って選択モデルを更新します。
        導入されたバージョン:
        JavaFX 2.1

      • getValue

        public final T getValue()
        プロパティvalueの値を取得します。
        プロパティの説明:
        このChoiceBoxの値は、ChoiceBox選択モデルの選択項目として定義されます。 valuePropertyは、selectedItemと同期されます。 このプロパティでは、ChoiceBoxに対する外部プロパティの双方向バインディングが可能で、それに従って選択モデルを更新します。
        導入されたバージョン:
        JavaFX 2.1

      • onActionProperty

        public final ObjectProperty<EventHandler<ActionEvent>> onActionProperty()
        ChoiceBoxアクションは、ChoiceBoxのvalueプロパティが変更されたときに呼び出されます。 これは、valueプロパティがプログラムによって変更されているか、ユーザーがポップアップ・メニューでアイテムを選択したことが原因である可能性があります。
        導入されたバージョン:
        JavaFX 8u60
        関連項目:
        getOnAction()、setOnAction(EventHandler)

      • setOnAction

        public final void setOnAction​(EventHandler<ActionEvent> value)
        プロパティonActionの値を設定します。
        プロパティの説明:
        ChoiceBoxアクションは、ChoiceBoxのvalueプロパティが変更されたときに呼び出されます。 これは、valueプロパティがプログラムによって変更されているか、ユーザーがポップアップ・メニューでアイテムを選択したことが原因である可能性があります。
        導入されたバージョン:
        JavaFX 8u60

      • getOnAction

        public final EventHandler<ActionEvent> getOnAction()
        プロパティonActionの値を取得します。
        プロパティの説明:
        ChoiceBoxアクションは、ChoiceBoxのvalueプロパティが変更されたときに呼び出されます。 これは、valueプロパティがプログラムによって変更されているか、ユーザーがポップアップ・メニューでアイテムを選択したことが原因である可能性があります。
        導入されたバージョン:
        JavaFX 8u60

      • setOnShowing

        public final void setOnShowing​(EventHandler<Event> value)
        プロパティonShowingの値を設定します。
        プロパティの説明:
        表示されているChoiceBoxポップアップの直前に呼び出されます。
        導入されたバージョン:
        JavaFX 8u60

      • getOnShowing

        public final EventHandler<Event> getOnShowing()
        プロパティonShowingの値を取得します。
        プロパティの説明:
        表示されているChoiceBoxポップアップの直前に呼び出されます。
        導入されたバージョン:
        JavaFX 8u60

      • setOnShown

        public final void setOnShown​(EventHandler<Event> value)
        プロパティonShownの値を設定します。
        プロパティの説明:
        ChoiceBoxポップアップが表示された直後に呼び出されます。
        導入されたバージョン:
        JavaFX 8u60

      • getOnShown

        public final EventHandler<Event> getOnShown()
        プロパティonShownの値を取得します。
        プロパティの説明:
        ChoiceBoxポップアップが表示された直後に呼び出されます。
        導入されたバージョン:
        JavaFX 8u60

      • setOnHiding

        public final void setOnHiding​(EventHandler<Event> value)
        プロパティonHidingの値を設定します。
        プロパティの説明:
        ChoiceBoxポップアップを非表示にする直前に呼び出されます。
        導入されたバージョン:
        JavaFX 8u60

      • getOnHiding

        public final EventHandler<Event> getOnHiding()
        プロパティonHidingの値を取得します。
        プロパティの説明:
        ChoiceBoxポップアップを非表示にする直前に呼び出されます。
        導入されたバージョン:
        JavaFX 8u60

      • setOnHidden

        public final void setOnHidden​(EventHandler<Event> value)
        プロパティonHiddenの値を設定します。
        プロパティの説明:
        ChoiceBoxポップアップが非表示になった直後に呼び出されます。
        導入されたバージョン:
        JavaFX 8u60

      • getOnHidden

        public final EventHandler<Event> getOnHidden()
        プロパティonHiddenの値を取得します。
        プロパティの説明:
        ChoiceBoxポップアップが非表示になった直後に呼び出されます。
        導入されたバージョン:
        JavaFX 8u60

      • show

        public void show()
        選択のリストを開きます。

      • hide

        public void hide()
        選択のリストを閉じます。