Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.dua3.utility.fx.controls.Controls Maven / Gradle / Ivy
package com.dua3.utility.fx.controls;
import com.dua3.cabe.annotations.Nullable;
import com.dua3.utility.fx.icons.Icon;
import com.dua3.utility.fx.icons.IconUtil;
import com.dua3.utility.fx.icons.IconView;
import com.dua3.utility.data.Color;
import com.dua3.utility.fx.FxUtil;
import javafx.geometry.Orientation;
import javafx.scene.Node;
import javafx.scene.control.Button;
import javafx.scene.control.CheckBox;
import javafx.scene.control.Label;
import javafx.scene.control.Menu;
import javafx.scene.control.MenuItem;
import javafx.scene.control.Separator;
import javafx.scene.control.ToggleButton;
import javafx.scene.control.Tooltip;
import javafx.scene.layout.Region;
import javafx.scene.paint.Paint;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import java.io.File;
import java.nio.file.Path;
import java.util.function.BiFunction;
import java.util.function.Consumer;
public final class Controls {
private static final Logger LOG = LogManager.getLogger(Controls.class);
private Controls() {
}
/**
* Create {@link ButtonBuilder} instance for standard buttons.
*
* @return new ButtonBuilder
*/
public static ButtonBuilder button() {
return new ButtonBuilder<>(Button::new);
}
/**
* Create {@link ButtonBuilder} instance for toggle buttons.
*
* @return new ButtonBuilder
*/
public static ButtonBuilder toggleButton() {
return new ButtonBuilder<>(ToggleButton::new);
}
/**
* Create {@link ButtonBuilder} instance for toggle buttons.
*
* @param selected the initial selection state of the button
* @return new ButtonBuilder
*/
public static ButtonBuilder toggleButton(boolean selected) {
return new ButtonBuilder<>(() -> {
ToggleButton b = new ToggleButton();
b.setSelected(selected);
return b;
});
}
/**
* Create {@link ButtonBuilder} instance for checkboxes.
*
* @return new ButtonBuilder
*/
public static ButtonBuilder checkbox() {
return new ButtonBuilder<>(CheckBox::new);
}
/**
* Create {@link ButtonBuilder} instance for checkboxes.
*
* @param selected the initial selection state of the button
* @return new ButtonBuilder
*/
public static ButtonBuilder checkbox(boolean selected) {
return new ButtonBuilder<>(() -> {
CheckBox b = new CheckBox();
b.setSelected(selected);
return b;
});
}
/**
* Creates a new FileInputBuilder instance with the given mode.
*
* @param mode the {@link FileDialogMode} of the file dialog
* @return a new FileInputBuilder instance
*/
public static FileInputBuilder fileInput(FileDialogMode mode) {
return new FileInputBuilder(mode);
}
/**
* Create {@link SliderBuilder} instance.
*
* @return new SliderBuilder
*/
public static SliderBuilder slider() {
return new SliderBuilder(SliderWithButtons.Mode.SLIDER_ONLY, (v, t) -> "");
}
/**
* Create {@link SliderBuilder} instance.
*
* @param mode the {@link SliderWithButtons.Mode}
* @param formatter the formatter that generates the label text; first argument is current value and second is max value
* @return new SliderBuilder
*/
public static SliderBuilder slider(SliderWithButtons.Mode mode, BiFunction formatter) {
return new SliderBuilder(mode, formatter);
}
/**
* Create {@link javafx.scene.control.Separator}.
*
* @param orientation the separator orientation
* @return new {@link Separator}
*/
public static Node separator(Orientation orientation) {
return new Separator(orientation);
}
/**
* Get graphic for an icon by icon name.
*
* @param name the icon name
* @return a node for the graphic
* @throws IllegalStateException if no icon with a matching name is found
* @see IconUtil#iconFromName(String)
*/
public static Node graphic(String name) {
return icon(name).node();
}
/**
* Get icon by name.
*
* @param name the icon name
* @return icon
* @throws IllegalStateException if no icon with a matching name is found
* @see IconUtil#iconFromName(String)
*/
public static Icon icon(String name) {
return IconUtil.iconFromName(name).orElseThrow(() -> new IllegalStateException("unknown icon: " + name));
}
/**
* Create a fixed minimum width label with the given text to prevent an ellipsis being display.
*
* @param text the text to display on the label
* @return a new Label instance with fixed miimum width
* @see Label
*/
public static Label rigidLabel(String text) {
Label label = new Label(text);
label.setMinWidth(Region.USE_PREF_SIZE);
return label;
}
/**
* Create a fixed minimum width label with the given text to prevent an ellipsis being display.
*
* @param text the text to display on the label
* @param node the node to display on the label
* @return a new Label instance with fixed miimum width
* @see Label
*/
public static Label rigidLabel(String text, Node node) {
Label label = new Label(text, node);
label.setMinWidth(Region.USE_PREF_SIZE);
return label;
}
/**
* Get graphic for an icon by icon name.
*
* @param name the icon name
* @param size the requested size
* @return a node for the graphic
* @throws IllegalStateException if no icon with a matching name is found
* @see IconUtil#iconFromName(String)
*/
public static Node graphic(String name, int size) {
Icon icon = icon(name);
icon.setIconSize(size);
return icon.node();
}
/**
* Get graphic for an icon by icon name.
*
* @param name the icon name
* @param size the requested size
* @param paint the {@link Paint} to use
* @return a node for the graphic
* @throws IllegalStateException if no icon with a matching name is found
* @see IconUtil#iconFromName(String)
*/
public static Node graphic(String name, int size, Paint paint) {
Icon icon = icon(name);
icon.setIconSize(size);
icon.setIconColor(paint);
return icon.node();
}
/**
* Get graphic for an icon by icon name.
*
* @param name the icon name
* @param size the requested size
* @param color the {@link Color} to use
* @return a node for the graphic
* @throws IllegalStateException if no icon with a matching name is found
* @see IconUtil#iconFromName(String)
*/
public static Node graphic(String name, int size, Color color) {
return graphic(name, size, FxUtil.convert(color));
}
/**
* Create an Icon with a tooltip.
*
* @param name the icon name
* @param size the requested size
* @param paint the {@link Paint} to use
* @param tooltipText the text to display as tooltip
* @return a node for the graphic
* @throws IllegalStateException if no icon with a matching name is found
* @see IconUtil#iconFromName(String)
*/
public static Node tooltipIcon(String name, int size, Paint paint, String tooltipText) {
IconView iv = new IconView(name, size, paint);
if (!tooltipText.isBlank()) {
iv.setTooltip(new Tooltip(tooltipText));
}
return iv;
}
/**
* Create an Icon with a tooltip.
*
* @param name the icon name
* @param size the requested size
* @param color the {@link Color} to use
* @param tooltipText the text to display as tooltip
* @return a node for the graphic
* @throws IllegalStateException if no icon with a matching name is found
* @see IconUtil#iconFromName(String)
*/
public static Node tooltipIcon(String name, int size, Color color, String tooltipText) {
return tooltipIcon(name, size, FxUtil.convert(color), tooltipText);
}
/**
* Get TextFieldBuilder for creating a TextField.
* @return TextFieldBuilder instance
*/
public static TextFieldBuilder textField() {
return new TextFieldBuilder();
}
/**
* Make a region resizable by dragging its edge.
*
* @param region the region
* @param borders the borders to make draggable
*/
public static void makeResizable(Region region, Position... borders) {
DragResizer.makeResizable(region, 6, borders);
}
/**
* Make a region resizable by dragging its edge.
*
* @param region the region
* @param resizeMargin size of the draggable margin
* @param borders the borders to make draggable
*/
public static void makeResizable(Region region, int resizeMargin, Position... borders) {
DragResizer.makeResizable(region, resizeMargin, borders);
}
/**
* Create new {@link Menu}.
*
* @param text the text to show
* @param items the menu items
* @return new menu
*/
public static Menu menu(@Nullable String text, MenuItem... items) {
return new Menu(text, null, items);
}
/**
* Create new {@link Menu}.
*
* @param text the text to show
* @param graphic the graphic to show before the text
* @param items the menu items
* @return new menu
*/
public static Menu menu(@Nullable String text, @Nullable Node graphic, MenuItem... items) {
return new Menu(text, graphic, items);
}
/**
* Create new {@link MenuItem}.
*
* @param text the text to show
* @param graphic the graphic to show before the text
* @param action the action to perform when the menu item is invoked
* @return new menu item
*/
public static MenuItem menuItem(@Nullable String text, @Nullable Node graphic, Runnable action) {
return menuItem(text, graphic, action, true);
}
/**
* Create new {@link MenuItem}.
*
* @param text the text to show
* @param graphic the graphic to show before the text
* @param enabled the enabled state
* @param action the action to perform when the menu item is invoked
* @return new menu item
*/
public static MenuItem menuItem(@Nullable String text, @Nullable Node graphic, Runnable action, boolean enabled) {
MenuItem mi = new MenuItem(text, graphic);
mi.setDisable(!enabled);
mi.setOnAction(evt -> action.run());
return mi;
}
/**
* Create new {@link MenuItem}.
*
* @param text the text to show
* @param action the action to perform when the menu item is invoked
* @return new menu item
*/
public static MenuItem menuItem(@Nullable String text, Runnable action) {
return menuItem(text, action, true);
}
/**
* Create new {@link MenuItem}.
*
* @param text the text to show
* @param enabled the enabled state
* @param action the action to perform when the menu item is invoked
* @return new menu item
*/
public static MenuItem menuItem(@Nullable String text, Runnable action, boolean enabled) {
MenuItem mi = new MenuItem(text);
mi.setDisable(!enabled);
mi.setOnAction(evt -> action.run());
return mi;
}
/**
* Sets the initial directory for a file or directory chooser.
*
* @param setInitialDirectory a Consumer to set the initial directory
* @param dir the initial directory path, or null if not specified
*/
static void setInitialDirectory(Consumer setInitialDirectory, @Nullable Path dir) {
if (dir != null) {
// NOTE there's an inconsistency between Paths.get("").toFile() and new File(""), so convert Path to File
// before testing for directory and do not use Files.isDirectory(Path)
try {
File initialFile = dir.toFile();
if (initialFile.isDirectory()) {
setInitialDirectory.accept(initialFile);
}
} catch (UnsupportedOperationException e) {
LOG.warn("could not set initial directory", e);
}
}
}
}
