impl.com.pixelduke.control.skin.TextFieldWithButtonSkin Maven / Gradle / Ivy

Go to download
/*
 * FXSkins,
 * Copyright (C) 2021 PixelDuke (Pedro Duque Vieira - www.pixelduke.com)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */

package impl.com.pixelduke.control.skin;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import javafx.beans.InvalidationListener;
import javafx.beans.property.BooleanProperty;
import javafx.css.CssMetaData;
import javafx.css.SimpleStyleableBooleanProperty;
import javafx.css.Styleable;
import javafx.css.StyleableProperty;
import javafx.css.converter.BooleanConverter;
import javafx.scene.control.SkinBase;
import javafx.scene.control.TextField;
import javafx.scene.control.skin.TextFieldSkin;
import javafx.scene.layout.Region;
import javafx.scene.layout.StackPane;

public class TextFieldWithButtonSkin extends TextFieldSkin{
    private static final String RIGHT_BUTTON_VISIBLE_PROPERTY_NAME = "-right-button-visible";

    private InvalidationListener textChanged = observable -> onTextChanged();
    private InvalidationListener focusChanged = observable -> onFocusChanged();
    private InvalidationListener rightButtonVisibleChanged = observable -> onRightButtonVisibilityChanged();

    private StackPane rightButton;
    private Region rightButtonGraphic;

    protected TextField textField;

    /**************************************************************************
     *                                                                        *
     *  Constructor                                                           *
     *                                                                        *
     *************************************************************************/

    public TextFieldWithButtonSkin(TextField textField) {
        super(textField);

        this.textField = textField;

        rightButton = new StackPane();
        rightButton.setManaged(false);
        rightButton.getStyleClass().setAll("right-button");
        rightButton.setFocusTraversable(false);

        rightButtonGraphic = new Region();
        rightButtonGraphic.getStyleClass().setAll("right-button-graphic");
        rightButtonGraphic.setFocusTraversable(false);

        rightButtonGraphic.setMaxWidth(Region.USE_PREF_SIZE);
        rightButtonGraphic.setMaxHeight(Region.USE_PREF_SIZE);

        rightButton.setVisible(false);
        rightButtonGraphic.setVisible(false);

        rightButton.getChildren().add(rightButtonGraphic);
        getChildren().add(rightButton);

        setupListeners();
    }

    /**************************************************************************
     *                                                                        *
     *  CSS                                                                   *
     *                                                                        *
     *************************************************************************/

    /*====================== Right Button Visible ===========================*/

    private static final CssMetaData RIGHT_BUTTON_VISIBLE_META_DATA =
            new CssMetaData<>(RIGHT_BUTTON_VISIBLE_PROPERTY_NAME,
                    BooleanConverter.getInstance(), true) {

                @Override
                public boolean isSettable(TextField textField) {
                    final TextFieldWithButtonSkin skin = (TextFieldWithButtonSkin) textField.getSkin();
                    return !skin.rightButtonVisible.isBound();
                }

                @Override
                public StyleableProperty getStyleableProperty(TextField textField) {
                    final TextFieldWithButtonSkin skin = (TextFieldWithButtonSkin) textField.getSkin();
                    return (StyleableProperty) skin.rightButtonVisibleProperty();
                }
            };

    private BooleanProperty rightButtonVisible = new SimpleStyleableBooleanProperty(RIGHT_BUTTON_VISIBLE_META_DATA, true);

    private BooleanProperty rightButtonVisibleProperty() { return rightButtonVisible; }

    private boolean getRightButtonVisible() { return rightButtonVisible.get(); }


    /*=================== General handling of CSS ===========================*/

    /* Setup styleables for this Skin */
    private static final List> STYLEABLES;

    static {
        final List> styleables =
                new ArrayList<>(SkinBase.getClassCssMetaData());
        styleables.add(RIGHT_BUTTON_VISIBLE_META_DATA);
        styleables.addAll(TextFieldSkin.getClassCssMetaData());
        STYLEABLES = Collections.unmodifiableList(styleables);
    }

    /**
     * @return The CssMetaData associated with this class, which may include the
     * CssMetaData of its super classes.
     */
    public static List> getClassCssMetaData() {
        return STYLEABLES;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public List> getCssMetaData() {
        return getClassCssMetaData();
    }

    /**************************************************************************
     *                                                                        *
     *  Other methods                                                         *
     *                                                                        *
     *************************************************************************/

    private void setupListeners() {
        final TextField textField = getSkinnable();
        rightButton.setOnMousePressed(event -> onRightButtonPressed());
        rightButton.setOnMouseReleased(event -> onRightButtonReleased());

        textField.textProperty().addListener(textChanged);
        textField.focusedProperty().addListener(focusChanged);
        rightButtonVisible.addListener(rightButtonVisibleChanged);
    }

    protected void onTextChanged()
    {
        updateRightButtonVisibility();
    }

    protected void onFocusChanged()
    {
        updateRightButtonVisibility();
    }

    protected void onRightButtonVisibilityChanged() {
        updateRightButtonVisibility();
    }

    private void updateRightButtonVisibility() {
        if (textField.getText() == null) {
            return;
        }

        boolean hasFocus = textField.isFocused();
        boolean isEmpty = textField.getText().isEmpty();
        boolean isRightButtonVisible = rightButtonVisible.get();

        boolean shouldBeVisible = isRightButtonVisible && hasFocus && !isEmpty;

        rightButton.setVisible(shouldBeVisible);
        rightButtonGraphic.setVisible(shouldBeVisible);
    }

    protected void onRightButtonPressed()
    {
    }

    protected void onRightButtonReleased()
    {

    }

    @Override
    protected void layoutChildren(double x, double y, double w, double h) {
        super.layoutChildren(x, y, w, h);

        final double rightButtonHeight = h + textField.snappedTopInset() + textField.snappedBottomInset();
        final double rightButtonWidth = rightButton.prefWidth(rightButtonHeight);

        rightButton.resize(rightButtonWidth, rightButtonHeight);
        rightButton.setLayoutX(w + textField.snappedRightInset() + textField.snappedLeftInset() - rightButtonWidth);
    }

    @Override
    public void dispose() {
        textField.textProperty().removeListener(textChanged);
        textField.focusedProperty().removeListener(focusChanged);
        rightButtonVisible.removeListener(rightButtonVisibleChanged);

        super.dispose();
    }
}