Module org.controlsfx.controls
Package org.controlsfx.control

Class CheckComboBox<T>

  • Type Parameters:
    T - The type of the data in the ComboBox.
    All Implemented Interfaces:
    Styleable, EventTarget, Skinnable
    @DefaultProperty("items")
public class CheckComboBox<T>
extends Control
    A simple UI control that makes it possible to select zero or more items within a ComboBox-like control. Each row item shows a CheckBox, and the state of each row can be queried via the check model.
    The title shown in the combobox is, by default, a concatenation of the selected items but this behaviour can be changed and it is possible to set a fixed title (see titleProperty() property), with or without an indication of how many items have been checked (see showCheckedCountProperty() property).

    Screenshots

    The following screenshot shows the CheckComboBox with some sample data:
    Screenshot of CheckComboBox

    The following screenshot shows the CheckComboBox with a fixed title and the indication of how many items have been checked:
    Screenshot of CheckComboBox with number of checked items

    Code Example:

    To create the CheckComboBox shown in the screenshot, simply do the following: 

     
 // create the data to show in the CheckComboBox 
 final ObservableList<String> strings = FXCollections.observableArrayList();
 for (int i = 0; i <= 100; i++) {
     strings.add("Item " + i);
 }
 
 // Create the CheckComboBox with the data 
 final CheckComboBox<String> checkComboBox = new CheckComboBox<String>(strings);
 
 // and listen to the relevant events (e.g. when the selected indices or 
 // selected items change).
 checkComboBox.getCheckModel().getCheckedItems().addListener(new ListChangeListener<String>() {
     public void onChanged(ListChangeListener.Change<? extends String> c) {
          while(c.next()) {
              //do something with changes here
          }
          System.out.println(checkComboBox.getCheckModel().getCheckedItems());
     }
 });
 }

    • Property Detail

      • checkModel

        public final ObjectProperty<IndexedCheckModel<T>> checkModelProperty
        The check model provides the API through which it is possible to check single or multiple items within a CheckComboBox, as well as inspect which items have been checked by the user. Note that it has a generic type that must match the type of the CheckComboBox itself.

      • title

        public final StringProperty titleProperty
        The title to use for this control. If a non null value is explicitly set by the client, then that string will be used, otherwise a title will be constructed concatenating the selected items
        See Also:
        getTitle(), setTitle(String)

      • showCheckedCount

        public final BooleanProperty showCheckedCountProperty
        A boolean to decide if the information of how many items are checked should be shown beside the fixed title. If a titleProperty() has been set and this property is set to true then a string like (3/10) would be shown when 3 items out of 10 are checked.
        This property has effect only if a fixed title has been set (see titleProperty()), otherwise the title is constructed with a concatenation of the selected items.
        See Also:
        isShowCheckedCount(), setShowCheckedCount(boolean)

    • Constructor Detail

      • CheckComboBox

        public CheckComboBox()
        Creates a new CheckComboBox instance with an empty list of choices.

      • CheckComboBox

        public CheckComboBox​(ObservableList<T> items)
        Creates a new CheckComboBox instance with the given items available as choices.
        Parameters:
        items - The items to display within the CheckComboBox.

    • Method Detail

      • getItems

        public ObservableList<T> getItems()
        Represents the list of choices available to the user, from which they can select zero or more items.

      • getItemBooleanProperty

        public BooleanProperty getItemBooleanProperty​(int index)
        Returns the BooleanProperty for a given item index in the CheckComboBox. This is useful if you want to bind to the property.

      • getItemBooleanProperty

        public BooleanProperty getItemBooleanProperty​(T item)
        Returns the BooleanProperty for a given item in the CheckComboBox. This is useful if you want to bind to the property.

      • setCheckModel

        public final void setCheckModel​(IndexedCheckModel<T> value)
        Sets the 'check model' to be used in the CheckComboBox - this is the code that is responsible for representing the selected state of each CheckBox - that is, whether each CheckBox is checked or not (and not to be confused with the selection model concept, which is used in the ComboBox control to represent the selection state of each row)..

      • getCheckModel

        public final IndexedCheckModel<T> getCheckModel()
        Returns the currently installed check model.

      • checkModelProperty

        public final ObjectProperty<IndexedCheckModel<T>> checkModelProperty()
        The check model provides the API through which it is possible to check single or multiple items within a CheckComboBox, as well as inspect which items have been checked by the user. Note that it has a generic type that must match the type of the CheckComboBox itself.

      • setConverter

        public final void setConverter​(StringConverter<T> value)
        Sets the StringConverter to be used in the control.
        Parameters:
        value - A StringConverter that, given an object of type T, will return a String that can be used to represent the object visually.

      • getConverter

        public final StringConverter<T> getConverter()
        A StringConverter that, given an object of type T, will return a String that can be used to represent the object visually.

      • titleProperty

        public final StringProperty titleProperty()
        The title to use for this control. If a non null value is explicitly set by the client, then that string will be used, otherwise a title will be constructed concatenating the selected items
        See Also:
        getTitle(), setTitle(String)

      • setTitle

        public final void setTitle​(String value)
        Sets the title to use. If it is not null it will be used as title, otherwise title will be constructed by the skin
        Parameters:
        value - the string to use as title

      • getTitle

        public final String getTitle()
        The title set for this control, if it has been set explicitly by the client.
        Returns:
        the title if it has been set, null otherwise

      • show

        public void show()
        Requests that the ComboBox display the popup aspect of the user interface.

      • hide

        public void hide()
        Closes the popup / dialog that was shown when show() was called.

      • showCheckedCountProperty

        public final BooleanProperty showCheckedCountProperty()
        A boolean to decide if the information of how many items are checked should be shown beside the fixed title. If a titleProperty() has been set and this property is set to true then a string like (3/10) would be shown when 3 items out of 10 are checked.
        This property has effect only if a fixed title has been set (see titleProperty()), otherwise the title is constructed with a concatenation of the selected items.
        See Also:
        isShowCheckedCount(), setShowCheckedCount(boolean)

      • setShowCheckedCount

        public final void setShowCheckedCount​(boolean value)
        Sets the value to use to decide whether the checked items count should be shown or not
        Parameters:
        value - the value to set

      • isShowCheckedCount

        public final boolean isShowCheckedCount()
        Returns:
        whether the checked items count is set to be shown beside a fixed title

      • getUserAgentStylesheet

        protected final String getUserAgentStylesheet​(Class<?> clazz,
                                              String fileName)
        A helper method that ensures that the resource based lookup of the user agent stylesheet only happens once. Caches the external form of the resource.
        Parameters:
        clazz - the class used for the resource lookup
        fileName - the name of the user agent stylesheet
        Returns:
        the external form of the user agent stylesheet (the path)