eu.binjr.common.javafx.controls.EditableTab Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of binjr-core Show documentation
A Time Series Data Browser
There is a newer version: 3.20.1
/*
 *    Copyright 2017-2018 Frederic Thevenet
 *
 *    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 eu.binjr.common.javafx.controls;

import com.sun.istack.Nullable;
import javafx.beans.property.BooleanProperty;
import javafx.beans.property.Property;
import javafx.beans.property.SimpleBooleanProperty;
import javafx.scene.control.*;

/**
 * A Tab control that can be renamed on double-click
 *
 * @author Frederic Thevenet
 */
public class EditableTab extends Tab {
    private final Label label;

    private BooleanProperty editable = new SimpleBooleanProperty(false);

    public String getName() {
        return label.textProperty().getValue();
    }

    private final TextField textField = new TextField();

    public Property nameProperty() {
        return label.textProperty();
    }

    public void setName(String tabName) {
        label.textProperty().setValue(tabName);
    }

    public EditableTab(String text) {
        this(text, (ButtonBase) null);
    }

    /**
     * Initializes a new instance of the {@link EditableTab} instance.
     *
     * @param text    the title for the tab.
     * @param buttons A custom {@link Button} instance used to close the tab
     */
    public EditableTab(String text, @Nullable ButtonBase... buttons) {
        super();
        label = new Label(text);
        label.textProperty();
        setGraphic(label);
        if (buttons != null) {
            setClosable(false);
            var tb = new ToolBar();
            tb.getStyleClass().add("editable-tab-tool-bar");
            tb.getItems().addAll(buttons);

            label.setGraphic(tb);
            label.setContentDisplay(ContentDisplay.RIGHT);
        }


        editable.addListener((observable, oldValue, newValue) -> {
            if (newValue) {
                textField.setText(label.getText());
                setGraphic(textField);
                textField.selectAll();
                textField.requestFocus();
            } else {
                if (!textField.getText().isEmpty()) {
                    label.setText(textField.getText());
                }
                setGraphic(label);
            }
        });


        label.setOnMouseClicked(event -> {
            if (event.getClickCount() == 2) {
                editable.setValue(true);
            }
        });

        textField.setOnAction(event -> {
            editable.setValue(false);
        });

        textField.focusedProperty().addListener((observable, oldValue, newValue) -> {
            if (!newValue) {
                editable.setValue(false);
            }
        });
    }

    /**
     * Renames the tab
     *
     * @param text the new name for the tab.
     */
    public void rename(String text) {
        label.setText(text);
    }

    public boolean isEditable() {
        return editable.get();
    }

    public BooleanProperty editableProperty() {
        return editable;
    }

    public void setEditable(boolean editable) {
        if (editable) {
            this.textField.requestFocus();
        }
        this.editable.set(editable);
    }
}