Module com.dua3.utility.fx.controls

Package com.dua3.utility.fx.controls

Interface InputControl<R>

Type Parameters:

R - the input result type

All Known Implementing Classes:

ChoiceInputControl, ComboBoxEx, FileInput, OptionsPane, RadioPane, SimpleInputControl

public interface InputControl<R>

Interface for an input field.

Property Summary

Properties

Type	Property	Description
ReadOnlyStringProperty	error	Provides a read-only property representing the error message for this input control.
ReadOnlyBooleanProperty	valid	Provides a read-only property representing the validity of the input.
Property<R>	value	Provides the property representing the value of this input control.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	InputControl.State<R>	State class encapsulates a value, validation logic, error message, and validity state.

Method Summary

Modifier and Type	Method	Description
static SimpleInputControl<CheckBox,Boolean>	checkBoxInput(Supplier<Boolean> dflt, String text, Function<Boolean,Optional<String>> validate)	Creates a SimpleInputControl for a CheckBox with a default value, text, and validation function.
static InputControl<Path>	chooseFile(Supplier<Path> dflt, FileDialogMode mode, boolean existingOnly, Collection<FileChooser.ExtensionFilter> filters, Function<Path,Optional<String>> validate)	Provides a file chooser input control.
static <T> SimpleInputControl<ComboBoxEx<T>,T>	comboBoxExInput(Collection<T> choices, Supplier<T> dflt, @Nullable UnaryOperator<T> edit, @Nullable Supplier<T> add, @Nullable BiPredicate<ComboBoxEx<T>,T> remove, Function<T,String> format, Function<T,Optional<String>> validate)	Creates a new SimpleInputControl for a ComboBoxEx with the specified parameters.
static <T> SimpleInputControl<ComboBox<T>,T>	comboBoxInput(Collection<? extends T> choices, Supplier<T> dflt, Function<T,Optional<String>> validate)	Creates a ComboBox input control with specified choices, default value Supplier, and validation Function.
static SimpleInputControl<TextField,Double>	decimalInput(Supplier<Double> dflt, Function<Double,Optional<String>> validate)	Creates a SimpleInputControl for decimal input using a TextField.
ReadOnlyStringProperty	errorProperty()	Provides a read-only property representing the error message for this input control.
default R	get()	Get value.
default void	init()	Set/update control state.
static SimpleInputControl<TextField,Integer>	integerInput(Supplier<Integer> dflt, Function<Integer,Optional<String>> validate)	Creates a SimpleInputControl for integer values.
default boolean	isValid()	Test if content is valid.
Node	node()	Get the Node for this input element.
void	reset()	Reset value to default
default void	set(R arg)	Set value.
static SimpleInputControl<TextField,String>	stringInput(Supplier<String> dflt, Function<String,Optional<String>> validate)	Creates a SimpleInputControl for a TextField with String input.
static <T> SimpleInputControl<TextField,T>	stringInput(Supplier<T> dflt, Function<T,Optional<String>> validate, StringConverter<T> converter)	Creates a new SimpleInputControl for a TextField with bidirectional binding.
ReadOnlyBooleanProperty	validProperty()	Provides a read-only property representing the validity of the input.
Property<R>	valueProperty()	Provides the property representing the value of this input control.

Property Details

value

Property<R> valueProperty

Provides the property representing the value of this input control.

valid

ReadOnlyBooleanProperty validProperty

Provides a read-only property representing the validity of the input.

See Also:

• isValid()

error

ReadOnlyStringProperty errorProperty

Provides a read-only property representing the error message for this input control.

This property contains an error message if the input is invalid, otherwise it is empty.

Method Details

stringInput

static SimpleInputControl<TextField,String> stringInput(Supplier<String> dflt,
 Function<String,Optional<String>> validate)

Creates a SimpleInputControl for a TextField with String input.

Parameters:

dflt - a Supplier providing the default value for the TextField

validate - a Function that takes a String and returns an Optional containing a validation error message, if any

Returns:

a SimpleInputControl containing the TextField and associated properties

stringInput

static <T> SimpleInputControl<TextField,T> stringInput(Supplier<T> dflt,
 Function<T,Optional<String>> validate,
 StringConverter<T> converter)

Creates a new SimpleInputControl for a TextField with bidirectional binding.

Type Parameters:

T - The type of the value.

Parameters:

dflt - The supplier providing the default value.

validate - A function to validate the value, returning an optional error message.

converter - The StringConverter to convert between the value and its string representation.

Returns:

A SimpleInputControl containing the TextField and associated properties.

integerInput

static SimpleInputControl<TextField,Integer> integerInput(Supplier<Integer> dflt,
 Function<Integer,Optional<String>> validate)

Creates a SimpleInputControl for integer values.

Parameters:

dflt - the default value Supplier

validate - the Function to validate the integer input

Returns:

a SimpleInputControl for integer input

decimalInput

static SimpleInputControl<TextField,Double> decimalInput(Supplier<Double> dflt,
 Function<Double,Optional<String>> validate)

Creates a SimpleInputControl for decimal input using a TextField.

Parameters:

dflt - the Supplier providing the default value for the input

validate - the Function to validate the input value

Returns:

a SimpleInputControl that manages a TextField for Decimal input

checkBoxInput

static SimpleInputControl<CheckBox,Boolean> checkBoxInput(Supplier<Boolean> dflt,
 String text,
 Function<Boolean,Optional<String>> validate)

Creates a SimpleInputControl for a CheckBox with a default value, text, and validation function.

Parameters:

dflt - a Supplier providing the default Boolean value

text - the text to be displayed with the CheckBox

validate - a Function that takes a Boolean value and returns an Optional containing an error message if validation fails

Returns:

a new instance of SimpleInputControl configured with a CheckBox and the provided parameters

comboBoxInput

static <T> SimpleInputControl<ComboBox<T>,T> comboBoxInput(Collection<? extends T> choices,
 Supplier<T> dflt,
 Function<T,Optional<String>> validate)

Creates a ComboBox input control with specified choices, default value Supplier, and validation Function.

Type Parameters:

T - the type of the items in the ComboBox

Parameters:

choices - the collection of available choices for the ComboBox

dflt - a Supplier providing the default value

validate - a Function to validate the selected item which returns an optional error message

Returns:

a SimpleInputControl containing the ComboBox and its value property

comboBoxExInput

static <T> SimpleInputControl<ComboBoxEx<T>,T> comboBoxExInput(Collection<T> choices,
 Supplier<T> dflt,
 @Nullable UnaryOperator<T> edit,
 @Nullable Supplier<T> add,
 @Nullable BiPredicate<ComboBoxEx<T>,T> remove,
 Function<T,String> format,
 Function<T,Optional<String>> validate)

Creates a new SimpleInputControl for a ComboBoxEx with the specified parameters.

Type Parameters:

T - the type of items contained in the ComboBoxEx

Parameters:

choices - the collection of choices to populate the ComboBoxEx

dflt - a Supplier for the default value

edit - a UnaryOperator to perform editing on the selected item (nullable)

add - a Supplier to provide a new item to add (nullable)

remove - a BiPredicate to determine if an item should be removed (nullable)

format - a Function to format the items as strings

validate - a Function to validate the current value

Returns:

a new instance of SimpleInputControl configured with a ComboBoxEx and its value property

chooseFile

static InputControl<Path> chooseFile(Supplier<Path> dflt,
 FileDialogMode mode,
 boolean existingOnly,
 Collection<FileChooser.ExtensionFilter> filters,
 Function<Path,Optional<String>> validate)

Provides a file chooser input control.

Parameters:

dflt - a Supplier providing the default file path.

mode - the FileDialogMode of the dialog (e.g., OPEN, SAVE, DIRECTORY).

existingOnly - specifies if only existing files can be chosen.

filters - a Collection of FileChooser.ExtensionFilter to apply.

validate - a Function that validates the selected file path.

Returns:

An InputControl instance for file selection.

node

Node node()

Get the Node for this input element.

Returns:

the node

get

default R get()

Get value.

Returns:

the current value

valueProperty

Property<R> valueProperty()

Provides the property representing the value of this input control.

set

default void set(R arg)

Set value.

Parameters:

arg - the value to set

isValid

default boolean isValid()

Test if content is valid.

Returns:

true, if content is valid

init

default void init()

Set/update control state.

reset

void reset()

Reset value to default

validProperty

ReadOnlyBooleanProperty validProperty()

Provides a read-only property representing the validity of the input.

See Also:

• isValid()

errorProperty

ReadOnlyStringProperty errorProperty()

Provides a read-only property representing the error message for this input control.

This property contains an error message if the input is invalid, otherwise it is empty.