Package com.amalgamasimulation.desktop.ui.editor.dialogs

Class RecordDialogBuilder<R extends Record>

java.lang.Object

com.amalgamasimulation.desktop.ui.editor.dialogs.RecordDialogBuilder<R>

Type Parameters:

R - type of the record

public class RecordDialogBuilder<R extends Record>
extends Object

Builder of a dialog with one field per record component, created by Dialogues.record(Shell, String, Record). The field kind depends on the component type: int and Integer give an integer field, double and Double a double field, String a text field, Path a file field. The label of a field is the component name until label(String, String) replaces it.

The fields show the values of the given record. After OK open() returns a new record made by the canonical constructor; the given record stays the same.

Author:

Ionov Ivan

Method Summary

Modifier and Type	Method	Description
RecordDialogBuilder<R>	folder(String component)	Turns the field of a String or Path component into a folder field with the Buttons.openDirectory() button.
RecordDialogBuilder<R>	label(String component, String label)	Sets the label of the field of a component.
RecordDialogBuilder<R>	message(String message)	Sets the message under the title.
Optional<R>	open()	Opens the dialog and waits until it is closed.
RecordDialogBuilder<R>	strategy(String component, ValidationStrategy<?,String> strategy)	Replaces the validation strategy of the field of a component.

Methods inherited from class java.lang.Object

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

Method Details

label

public RecordDialogBuilder<R> label(String component,
 String label)

Sets the label of the field of a component.

Parameters:

component - name of the record component

label - label of the field

Returns:

this builder

Throws:

IllegalArgumentException - if the record has no such component

folder

public RecordDialogBuilder<R> folder(String component)

Turns the field of a String or Path component into a folder field with the Buttons.openDirectory() button.

Parameters:

component - name of the record component

Returns:

this builder

Throws:

IllegalArgumentException - if the record has no such component or its type is not String or Path

strategy

public RecordDialogBuilder<R> strategy(String component,
 ValidationStrategy<?,String> strategy)

Replaces the validation strategy of the field of a component. The defaults are ValidationStrategies.integerPositive(), ValidationStrategies.doublePositive() and ValidationStrategies.stringIsNotEmpty().

The model type of the strategy must be Integer for an int or Integer component, Double for double or Double, and String for String and Path components. The type cannot be checked here. With a wrong type open() throws ClassCastException when the component has a value; when the value is null, OK throws it and the dialog stays open.

Parameters:

component - name of the record component

strategy - checks and converts the text of the field

Returns:

this builder

Throws:

IllegalArgumentException - if the record has no such component

message

public RecordDialogBuilder<R> message(String message)

Sets the message under the title.

Parameters:

message - the message; null shows no message

Returns:

this builder

open

public Optional<R> open()

Opens the dialog and waits until it is closed. Each time the fields show the values of the record given to Dialogues.record(Shell, String, Record).

The text of a Path field becomes a path by Path.of(String, String...), which throws InvalidPathException on OK for an invalid path.

Returns:

a new record with the entered values after OK; an empty Optional after Cancel

Throws:

RuntimeException - the exception of the canonical constructor, for example its check of the values