Modul com.dua3.utility.fx.controls

Package com.dua3.utility.fx.controls

Schnittstelle InputControl<T>

Typparameter:

T - the input result type

Alle bekannten Implementierungsklassen:

ChoiceInputControl, ComboBoxEx, FileInput, OptionsPane, RadioPane, SimpleInputControl

public interface InputControl<T>

Interface for an input field.

Eigenschaftsübersicht

Eigenschaften

Typ	Eigenschaft	Beschreibung
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<@Nullable T>	value	Provides the property representing the value of this input control.

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Schnittstelle	Beschreibung
static class	InputControl.State<R>	State class encapsulates a value, validation logic, error message, and validity state.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
static SimpleInputControl<CheckBox,Boolean>	checkBoxInput(Supplier<@Nullable Boolean> dflt, String text, Function<@Nullable 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<@Nullable Double> dflt, Function<@Nullable 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 @Nullable T	get()	Get value.
default void	init()	Set/update control state.
static SimpleInputControl<TextField,Integer>	integerInput(Supplier<@Nullable Integer> dflt, Function<@Nullable 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(@Nullable T 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<@Nullable T,Optional<String>> validate, StringConverter<@Nullable 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<@Nullable T>	valueProperty()	Provides the property representing the value of this input control.

Eigenschaftsdetails

value

Property<@Nullable T> valueProperty

Provides the property representing the value of this input control.

Siehe auch:

• valueProperty()

valid

ReadOnlyBooleanProperty validProperty

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

Siehe auch:

• isValid()
• validProperty()

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.

Siehe auch:

• errorProperty()

Methodendetails

stringInput

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

Creates a SimpleInputControl for a TextField with String input.

Parameter:

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

Gibt zurück:

a SimpleInputControl containing the TextField and associated properties

stringInput

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

Creates a new SimpleInputControl for a TextField with bidirectional binding.

Typparameter:

T - The type of the value.

Parameter:

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.

Gibt zurück:

A SimpleInputControl containing the TextField and associated properties.

integerInput

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

Creates a SimpleInputControl for integer values.

Parameter:

dflt - the default value Supplier

validate - the Function to validate the integer input

Gibt zurück:

a SimpleInputControl for integer input

decimalInput

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

Creates a SimpleInputControl for decimal input using a TextField.

Parameter:

dflt - the Supplier providing the default value for the input

validate - the Function to validate the input value

Gibt zurück:

a SimpleInputControl that manages a TextField for Decimal input

checkBoxInput

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

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

Parameter:

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

Gibt zurück:

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.

Typparameter:

T - the type of the items in the ComboBox

Parameter:

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

Gibt zurück:

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.

Typparameter:

T - the type of items contained in the ComboBoxEx

Parameter:

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

Gibt zurück:

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.

Parameter:

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.

Gibt zurück:

An InputControl instance for file selection.

node

Node node()

Get the Node for this input element.

Gibt zurück:

the node

get

default @Nullable T get()

Get value.

Gibt zurück:

the current value

valueProperty

Property<@Nullable T> valueProperty()

Provides the property representing the value of this input control.

Gibt zurück:

the property containing the current value

set

default void set(@Nullable T arg)

Set value.

Parameter:

arg - the value to set

isValid

default boolean isValid()

Test if content is valid.

Gibt zurück:

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.

Gibt zurück:

a ReadOnlyBooleanProperty that is true if the input is valid and false otherwise

Siehe auch:

• 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.

Gibt zurück:

a ReadOnlyStringProperty containing the error message if there is a validation error, otherwise empty