Modul com.dua3.utility.fx.controls

Package com.dua3.utility.fx.controls

Klasse InputGridBuilder

java.lang.Object

com.dua3.utility.fx.controls.InputGridBuilder

Alle implementierten Schnittstellen:

InputBuilder<InputGridBuilder>

public class InputGridBuilder
extends Object
implements InputBuilder<InputGridBuilder>

Builder for Alert Dialogs.

Provides a fluent interface to create Alerts.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
<T> InputGridBuilder	add(String id, Class<T> type, Supplier<T> dflt, InputControl<T> control)	Add an unlabeled input control.
<T> InputGridBuilder	add(String id, String label, Class<T> type, Supplier<T> dflt, InputControl<T> control)	Add a labeled input control.
InputGridBuilder	addNode(String id, @Nullable String label, Node node)	Add a labeled input control.
InputGridBuilder	addNode(String id, Node node)	Add an unlabeled input control.
InputGrid	build()	Builds and returns an InputGrid with the current data and column configuration.
InputGridBuilder	checkBox(String id, String label, Supplier<Boolean> dflt, String text, Function<Boolean,Optional<String>> validate)	Creates a checkbox with the given parameters.
InputGridBuilder	chooseFile(String id, String label, Supplier<Path> dflt, FileDialogMode mode, boolean existingOnly, Collection<FileChooser.ExtensionFilter> filter, Function<Path,Optional<String>> validate)	Add a file chooser dialog to allow the user to select a file.
InputGridBuilder	columns(int columns)	Set the number of columns for layout (default is 1).
<T> InputGridBuilder	comboBox(String id, String label, Supplier<T> dflt, Class<T> cls, Collection<T> items, Function<T,Optional<String>> validate)	Creates a comboBox widget with the given parameters.
<T> InputGridBuilder	comboBoxEx(String id, String label, @Nullable UnaryOperator<T> edit, @Nullable Supplier<T> add, @Nullable BiPredicate<ComboBoxEx<T>,T> remove, Function<T,String> format, Supplier<T> dflt, Class<T> cls, Collection<T> items, Function<T,Optional<String>> validate)	Returns a custom combo box with the specified parameters.
InputGridBuilder	decimal(String id, String label, Supplier<Double> dflt, Function<Double,Optional<String>> validate)	Add a labeled decimal input.
InputGridBuilder	integer(String id, String label, Supplier<Integer> dflt, Function<Integer,Optional<String>> validate)	Add a labeled integer input.
InputGridBuilder	node(String id, String label, Node node)	Add a labeled custom node to the grid.
InputGridBuilder	node(String id, Node node)	Add an unlabeled custom node to the grid.
InputGridBuilder	options(String id, String label, Supplier<com.dua3.utility.options.Arguments> dflt, Supplier<Collection<com.dua3.utility.options.Option<?>>> options)	Add a labeled pane with options.
InputGridBuilder	options(String id, Supplier<com.dua3.utility.options.Arguments> dflt, Supplier<Collection<com.dua3.utility.options.Option<?>>> options)	Add an unlabeled pane with options.
<T> InputGridBuilder	radioList(String id, String label, Supplier<T> dflt, Class<T> cls, Collection<T> items, Function<T,Optional<String>> validate)	Creates a radio list component.
InputGridBuilder	string(String id, String label, Supplier<String> dflt, Function<String,Optional<String>> validate)	Add a labeled string input.

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Von Schnittstelle geerbte Methoden com.dua3.utility.fx.controls.InputBuilder

checkBox, chooseFile, comboBox, comboBoxEx, decimal, integer, radioList, string

Methodendetails

build

public InputGrid build()

Builds and returns an InputGrid with the current data and column configuration.

Gibt zurück:

the constructed InputGrid

add

public <T> InputGridBuilder add(String id,
 String label,
 Class<T> type,
 Supplier<T> dflt,
 InputControl<T> control)

Beschreibung aus Schnittstelle kopiert: InputBuilder

Add a labeled input control.

Angegeben von:

add in Schnittstelle InputBuilder<InputGridBuilder>

Typparameter:

T - the result type

Parameter:

id - the control's ID

label - the label text

type - the result type

dflt - supplier of default value

control - the control

Gibt zurück:

this

add

public <T> InputGridBuilder add(String id,
 Class<T> type,
 Supplier<T> dflt,
 InputControl<T> control)

Beschreibung aus Schnittstelle kopiert: InputBuilder

Add an unlabeled input control.

Angegeben von:

add in Schnittstelle InputBuilder<InputGridBuilder>

Typparameter:

T - the result type

Parameter:

id - the control's ID

type - the result type

dflt - supplier of default value

control - the control

Gibt zurück:

this

addNode

public InputGridBuilder addNode(String id,
 @Nullable String label,
 Node node)

Beschreibung aus Schnittstelle kopiert: InputBuilder

Add a labeled input control.

Angegeben von:

addNode in Schnittstelle InputBuilder<InputGridBuilder>

Parameter:

id - the node's ID

label - the label text

node - the node

Gibt zurück:

this

addNode

public InputGridBuilder addNode(String id,
 Node node)

Beschreibung aus Schnittstelle kopiert: InputBuilder

Add an unlabeled input control.

Angegeben von:

addNode in Schnittstelle InputBuilder<InputGridBuilder>

Parameter:

id - the node's ID

node - the node

Gibt zurück:

this

columns

public InputGridBuilder columns(int columns)

Beschreibung aus Schnittstelle kopiert: InputBuilder

Set the number of columns for layout (default is 1).

Angegeben von:

columns in Schnittstelle InputBuilder<InputGridBuilder>

Parameter:

columns - the number of columns for laying out the input controls

Gibt zurück:

this

string

public InputGridBuilder string(String id,
 String label,
 Supplier<String> dflt,
 Function<String,Optional<String>> validate)

Beschreibung aus Schnittstelle kopiert: InputBuilder

Add a labeled string input.

Angegeben von:

string in Schnittstelle InputBuilder<InputGridBuilder>

Parameter:

id - the ID

label - the label text

dflt - supplier of default value

validate - validation callback, return error message if invalid, empty optional if valid

Gibt zurück:

this

integer

public InputGridBuilder integer(String id,
 String label,
 Supplier<Integer> dflt,
 Function<Integer,Optional<String>> validate)

Beschreibung aus Schnittstelle kopiert: InputBuilder

Add a labeled integer input.

Angegeben von:

integer in Schnittstelle InputBuilder<InputGridBuilder>

Parameter:

id - the ID

label - the label text

dflt - supplier of default value

validate - validation callback, return error message if invalid, empty optional if valid

Gibt zurück:

this

decimal

public InputGridBuilder decimal(String id,
 String label,
 Supplier<Double> dflt,
 Function<Double,Optional<String>> validate)

Beschreibung aus Schnittstelle kopiert: InputBuilder

Add a labeled decimal input.

Angegeben von:

decimal in Schnittstelle InputBuilder<InputGridBuilder>

Parameter:

id - the ID

label - the label text

dflt - supplier of default value

validate - validation callback, return error message if invalid, empty optional if valid

Gibt zurück:

this

checkBox

public InputGridBuilder checkBox(String id,
 String label,
 Supplier<Boolean> dflt,
 String text,
 Function<Boolean,Optional<String>> validate)

Beschreibung aus Schnittstelle kopiert: InputBuilder

Creates a checkbox with the given parameters.

Angegeben von:

checkBox in Schnittstelle InputBuilder<InputGridBuilder>

Parameter:

id - the ID of the checkbox

label - the label for the checkbox

dflt - the default value of the checkbox

text - the text to display next to the checkbox

validate - a function that takes a Boolean value and returns an optional validation message

Gibt zurück:

the created checkbox

comboBox

public <T> InputGridBuilder comboBox(String id,
 String label,
 Supplier<T> dflt,
 Class<T> cls,
 Collection<T> items,
 Function<T,Optional<String>> validate)

Beschreibung aus Schnittstelle kopiert: InputBuilder

Creates a comboBox widget with the given parameters.

Angegeben von:

comboBox in Schnittstelle InputBuilder<InputGridBuilder>

Typparameter:

T - the type of the comboBox items

Parameter:

id - the unique identifier for the comboBox

label - the label to display with the comboBox

dflt - the supplier function to provide the default value for the comboBox

cls - the class type of the comboBox items

items - the collection of items to populate the comboBox

validate - the function to validate the selected item in the comboBox

Gibt zurück:

the comboBox widget

comboBoxEx

public <T> InputGridBuilder comboBoxEx(String id,
 String label,
 @Nullable UnaryOperator<T> edit,
 @Nullable Supplier<T> add,
 @Nullable BiPredicate<ComboBoxEx<T>,T> remove,
 Function<T,String> format,
 Supplier<T> dflt,
 Class<T> cls,
 Collection<T> items,
 Function<T,Optional<String>> validate)

Beschreibung aus Schnittstelle kopiert: InputBuilder

Returns a custom combo box with the specified parameters.

Angegeben von:

comboBoxEx in Schnittstelle InputBuilder<InputGridBuilder>

Typparameter:

T - the type of objects in the combo box

Parameter:

id - the ID of the combo box

label - the label of the combo box

edit - a function to modify the selected item in the combo box, or null if editing is not allowed

add - a supplier to add a new item to the combo box, or null if adding is not allowed

remove - a predicate to remove an item from the combo box, or null if removing is not allowed

format - a function to format the items of the combo box as strings

dflt - a supplier to provide a default item for the combo box

cls - the class of objects in the combo box

items - the collection of items to populate the combo box

validate - a function to validate the items in the combo box and return an optional error message

Gibt zurück:

a custom combo box with the specified parameters

radioList

public <T> InputGridBuilder radioList(String id,
 String label,
 Supplier<T> dflt,
 Class<T> cls,
 Collection<T> items,
 Function<T,Optional<String>> validate)

Beschreibung aus Schnittstelle kopiert: InputBuilder

Creates a radio list component.

Angegeben von:

radioList in Schnittstelle InputBuilder<InputGridBuilder>

Typparameter:

T - the type of items in the radio list

Parameter:

id - the ID of the radio list

label - the label text for the radio list

dflt - a supplier that provides the default value for the radio list

cls - the class of the items in the radio list

items - a collection of items for the radio list

validate - a function to validate the selected item, returning an optional error message

Gibt zurück:

a radio list component

options

public InputGridBuilder options(String id,
 String label,
 Supplier<com.dua3.utility.options.Arguments> dflt,
 Supplier<Collection<com.dua3.utility.options.Option<?>>> options)

Beschreibung aus Schnittstelle kopiert: InputBuilder

Add a labeled pane with options.

Angegeben von:

options in Schnittstelle InputBuilder<InputGridBuilder>

Parameter:

id - the ID

label - the label text

dflt - supplier of default values

options - supplier of options

Gibt zurück:

this

options

public InputGridBuilder options(String id,
 Supplier<com.dua3.utility.options.Arguments> dflt,
 Supplier<Collection<com.dua3.utility.options.Option<?>>> options)

Beschreibung aus Schnittstelle kopiert: InputBuilder

Add an unlabeled pane with options.

Note to implementers: Labels of the options should be aligned properly with labels of the input dialog.

Angegeben von:

options in Schnittstelle InputBuilder<InputGridBuilder>

Parameter:

id - the ID

dflt - supplier of default values

options - supplier of options

Gibt zurück:

this

chooseFile

public InputGridBuilder chooseFile(String id,
 String label,
 Supplier<Path> dflt,
 FileDialogMode mode,
 boolean existingOnly,
 Collection<FileChooser.ExtensionFilter> filter,
 Function<Path,Optional<String>> validate)

Beschreibung aus Schnittstelle kopiert: InputBuilder

Add a file chooser dialog to allow the user to select a file.

Angegeben von:

chooseFile in Schnittstelle InputBuilder<InputGridBuilder>

Parameter:

id - The identifier for the file chooser dialog.

label - The label to display in the file chooser dialog.

dflt - A function that provides the default path to preselect in the file chooser dialog.

mode - The mode of the file dialog, such as OPEN or SAVE.

existingOnly - Whether to only allow selection of existing files.

filter - The file filters to apply in the file chooser dialog.

validate - A function to perform additional validation on the selected file path. It returns an optional error message if the validation fails.

Gibt zurück:

this

node

public InputGridBuilder node(String id,
 Node node)

Beschreibung aus Schnittstelle kopiert: InputBuilder

Add an unlabeled custom node to the grid.

Angegeben von:

node in Schnittstelle InputBuilder<InputGridBuilder>

Parameter:

id - the ID of the node

node - the node

Gibt zurück:

this

node

public InputGridBuilder node(String id,
 String label,
 Node node)

Beschreibung aus Schnittstelle kopiert: InputBuilder

Add a labeled custom node to the grid.

Angegeben von:

node in Schnittstelle InputBuilder<InputGridBuilder>

Parameter:

id - the ID of the node

label - the label text

node - the node

Gibt zurück:

this