org.panteleyev.fx.FxFactory Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of java-fx-helpers Show documentation
JavaFX helper classes
The newest version!
/*
 Copyright © 2020-2024 Petr Panteleyev 
 SPDX-License-Identifier: BSD-2-Clause
 */
package org.panteleyev.fx;

import javafx.scene.Node;
import javafx.scene.control.CheckBox;
import javafx.scene.control.Tab;
import javafx.scene.control.TextField;
import javafx.scene.input.KeyCode;

import java.util.ResourceBundle;
import java.util.function.Consumer;
import java.util.function.Supplier;

/**
 * This class provides convenience methods to create and configure various JavaFX controls in one method call.
 * Most of the methods take resource bundle and text key as parameters for I18N purposes.
 */
public final class FxFactory {
    /**
     * Creates new search text field.
     *
     * @param fieldSupplier text field supplier
     * @param valueCallback value callback
     * @return text field
     * @deprecated use {@link #searchField(Supplier, Consumer)} instead
     */
    @Deprecated(forRemoval = true)
    public static TextField newSearchField(Supplier fieldSupplier, Consumer valueCallback) {
        return searchField(fieldSupplier, valueCallback);
    }

    /**
     * Creates new search text field.
     *
     * @param fieldSupplier text field supplier
     * @param valueCallback value callback
     * @return text field
     */
    public static TextField searchField(Supplier fieldSupplier, Consumer valueCallback) {
        var searchField = fieldSupplier.get();
        searchField.setPrefColumnCount(20);
        searchField.textProperty().addListener((x, y, newValue) -> valueCallback.accept(newValue));
        searchField.setOnKeyPressed(keyEvent -> {
            if (keyEvent.getCode() == KeyCode.ESCAPE) {
                searchField.clear();
            }
        });
        return searchField;
    }

    /**
     * Creates new text field.
     *
     * @param prefColumnCount the preferred number of text columns
     * @return text field
     */
    public static TextField textField(int prefColumnCount) {
        return textField("", prefColumnCount);
    }

    /**
     * Creates new text field.
     *
     * @param initialValue    initial value
     * @param prefColumnCount the preferred number of text columns
     * @return text field
     */
    public static TextField textField(String initialValue, int prefColumnCount) {
        var textField = new TextField(initialValue);
        textField.setPrefColumnCount(prefColumnCount);
        return textField;
    }

    /**
     * Creates new check box.
     *
     * @param rb  resource bundle
     * @param key text key
     * @return check box
     */
    public static CheckBox newCheckBox(ResourceBundle rb, String key) {
        return new CheckBox(rb.getString(key));
    }

    /**
     * Creates new tab.
     *
     * @param rb        resource bundle
     * @param key       text key
     * @param closeable closeable flag
     * @return tab
     * @deprecated use {@link TabFactory#tab(String, boolean, Node)}
     */
    @Deprecated(forRemoval = true)
    public static Tab newTab(ResourceBundle rb, String key, boolean closeable) {
        var tab = new Tab(rb.getString(key));
        tab.setClosable(closeable);
        return tab;
    }

    /**
     * Creates new tab.
     *
     * @param rb        resource bundle
     * @param key       text key
     * @param closeable closeable flag
     * @param node      tab content
     * @return tab
     * @deprecated use {@link TabFactory#tab(String, boolean, Node)}
     */
    @Deprecated(forRemoval = true)
    public static Tab newTab(ResourceBundle rb, String key, boolean closeable, Node node) {
        var tab = new Tab(rb.getString(key), node);
        tab.setClosable(closeable);
        return tab;
    }
}