com.speedment.tool.propertyeditor.item.AbstractTextItem Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of tool-deploy Show documentation
A Speedment bundle that shades all dependencies into one jar. This is useful when deploying an application on a server.
The newest version!
/*
 *
 * Copyright (c) 2006-2019, Speedment, Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); You may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at:
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.speedment.tool.propertyeditor.item;

import javafx.beans.property.SimpleStringProperty;
import javafx.beans.property.StringProperty;
import javafx.beans.value.ObservableStringValue;
import javafx.scene.Node;
import javafx.scene.control.CheckBox;
import javafx.scene.control.TextInputControl;
import javafx.scene.layout.HBox;
import javafx.scene.layout.Priority;

import java.util.function.UnaryOperator;

import static java.util.Objects.requireNonNull;

/**
 *
 * @author Simon Jonasson
 * @since 3.0.0
 */
abstract class AbstractTextItem extends AbstractLabelTooltipItem {

    private final ObservableStringValue defaultValue;
    private final StringProperty value;
    private final StringProperty customValue;

    /**
     * Creates a new DefaultStringItem.
     * 
     * While the CheckBox is checked, the TextInput will be disabled, and the
     * property will always have the default value. 

     * While the CheckBox is un-checked, the TextInput will be enabled, and the
     * property will always have the TextInput's current value.
     * 

     * Upon construction, the editor decides whether to check the default box by
     * comparing the property value to the default value. If they match, or the
     * property value is {@code null}, the CheckBox will be checked.
     *
     * @param label the label text
     * @param defaultValue the default value
     * @param value the property to be edited
     * @param tooltip the tooltip
     */
    public AbstractTextItem(String label, ObservableStringValue defaultValue, StringProperty value, String tooltip) {
        this(label, defaultValue, value, tooltip, NO_DECORATOR);
    }

    /**
     * Creates a new DefaultStringItem.
     * 

     * While the CheckBox is checked, the TextInput will be disabled, and the
     * property will always have the default value. 

     * While the CheckBox is un-checked, the TextInput will be enabled, and the
     * property will always have the TextInput's current value.
     * 
     * Upon construction, the editor decides whether to check the default box by
     * comparing the property value to the default value. If they match, or the
     * property value is {@code null}, the CheckBox will be checked.
     *
     * @param label the label text
     * @param defaultValue the default value
     * @param value the property to be edited
     * @param tooltip the tooltip
     * @param decorator the editor decorator
     */
    public AbstractTextItem(String label, ObservableStringValue defaultValue, StringProperty value, String tooltip, UnaryOperator decorator) {
        super(label, tooltip, decorator);
        this.defaultValue = requireNonNull(defaultValue);
        this.value = requireNonNull(value);
        this.customValue = new SimpleStringProperty();
    }

    @Override
    protected HBox createUndecoratedEditor() {
        //TODO: CustomValue should be bound to defaultValue until we disable auto for the first time
        final HBox container = new HBox();
        final TextInputControl textInput = getInputControl();
        final CheckBox auto = new CheckBox("Auto");
        final boolean useDefaultValue = value.isEmpty().get() || value.get().equals(defaultValue.get());

        textInput.disableProperty().bind(auto.selectedProperty());
        if (useDefaultValue) {
            textInput.textProperty().bind(defaultValue);
        } else {
            textInput.setText(value.get());
        }
        customValue.bind(textInput.textProperty());

        attachListener(textInput.textProperty(), (ov, o, n) -> {
            if (n == null || n.isEmpty() || n.equalsIgnoreCase(defaultValue.getValue())) {
                value.setValue(null);
            } else {
                value.setValue(n);
            }
        });

        auto.selectedProperty().setValue(useDefaultValue);
        attachListener(auto.selectedProperty(), (ov, o, isAuto)
            -> setTextFieldBehaviour(textInput, isAuto, defaultValue, customValue)
        );

        HBox.setHgrow(textInput, Priority.ALWAYS);
        HBox.setHgrow(auto, Priority.NEVER);
        container.getChildren().addAll(auto, textInput);
        return container;
    }

    protected abstract TextInputControl getInputControl();

    private static void setTextFieldBehaviour(TextInputControl text, boolean useDefaultValue, ObservableStringValue defaultValue, StringProperty customValue) {
        if (useDefaultValue) {
            customValue.unbind();
            text.textProperty().bind(defaultValue);
        } else {
            text.textProperty().unbind();
            text.setText(customValue.get());
            customValue.bind(text.textProperty());
        }
    }
}