com.dua3.utility.fx.controls.ChoiceInputControl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of utility-fx-controls Show documentation
JavaFX utilities (controls)
There is a newer version: 15.0.2
package com.dua3.utility.fx.controls;

import com.dua3.utility.options.ChoiceOption;
import javafx.beans.property.Property;
import javafx.beans.property.ReadOnlyBooleanProperty;
import javafx.beans.property.ReadOnlyStringProperty;
import javafx.beans.property.SimpleBooleanProperty;
import javafx.beans.property.SimpleObjectProperty;
import javafx.beans.property.SimpleStringProperty;
import javafx.beans.value.ObservableValue;
import javafx.scene.Node;
import javafx.scene.control.ComboBox;
import org.jspecify.annotations.Nullable;

import java.util.Optional;
import java.util.function.Supplier;

/**
 * Interface for an input field.
 *
 * @param  the input result type
 */
public class ChoiceInputControl implements InputControl {

    private final ComboBox> control;
    private final ChoiceOption option;
    private final Supplier dfltValue;
    private final Property<@Nullable T> valueProperty;

    /**
     * Constructs a ChoiceInputControl with the given options and default value supplier.
     *
     * @param option the ChoiceOption containing possible values for the input control
     * @param dfltValue a Supplier that provides the default value for the input control
     */
    public ChoiceInputControl(ChoiceOption option, Supplier dfltValue) {
        this.option = option;
        this.dfltValue = dfltValue;
        this.control = new ComboBox<>();
        this.valueProperty = new SimpleObjectProperty<>();

        //noinspection NullableProblems - false positive
        control.valueProperty().addListener((ObservableValue> v, ChoiceOption.@Nullable Choice o, ChoiceOption.@Nullable Choice n) -> valueProperty.setValue(n == null ? null : n.value()));
        valueProperty.addListener((ObservableValue v, @Nullable T o, @Nullable T n) -> {
                    if (n == null) {
                        control.getSelectionModel().clearSelection();
                    } else {
                        control.getSelectionModel().select(option.choice(n));
                    }
                });

        control.getItems().setAll(option.choices());
        Optional.ofNullable(dfltValue.get()).ifPresent(dflt -> control.getSelectionModel().select(option.choice(dflt)));
    }

    @Override
    public Node node() {
        return control;
    }

    @Override
    public Property<@Nullable T> valueProperty() {
        return valueProperty;
    }

    @Override
    public void reset() {
        valueProperty.setValue(dfltValue.get());
    }

    @Override
    public ReadOnlyBooleanProperty validProperty() {
        return new SimpleBooleanProperty(true);
    }

    @Override
    public ReadOnlyStringProperty errorProperty() {
        return new SimpleStringProperty("");
    }
}