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

Class FieldsDialogBuilder

java.lang.Object

com.amalgamasimulation.desktop.ui.editor.dialogs.FieldsDialogBuilder

public class FieldsDialogBuilder
extends Object

Builder of a dialog with any number of fields, created by Dialogues.fields(Shell, String). Each field reads its value from valueExtractor when the dialog opens. Handlers get the new values only after OK, in the order of the fields. Cancel calls no handler.

Author:

Ionov Ivan

Method Summary

Modifier and Type	Method	Description
FieldsDialogBuilder	button(String label, ISimpleButtonProperties button)	Sets the button of the field with the label.
FieldsDialogBuilder	doubleValue(String label, Supplier<Double> valueExtractor, Consumer<Double> handler)	Adds a double field.
FieldsDialogBuilder	file(String label, Supplier<String> valueExtractor, Consumer<String> handler)	Adds a file path field with the Buttons.openFile() button.
FieldsDialogBuilder	folder(String label, Supplier<String> valueExtractor, Consumer<String> handler)	Adds a folder path field with the Buttons.openDirectory() button.
FieldsDialogBuilder	integer(String label, Supplier<Integer> valueExtractor, Consumer<Integer> handler)	Adds an int field.
FieldsDialogBuilder	message(String message)	Sets the message under the title.
boolean	open()	Opens the dialog and waits until it is closed.
FieldsDialogBuilder	strategy(String label, ValidationStrategy<?,String> strategy)	Replaces the validation strategy of the field with the label.
FieldsDialogBuilder	string(String label, Supplier<String> valueExtractor, Consumer<String> handler)	Adds a String field.

Methods inherited from class java.lang.Object

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

Method Details

integer

public FieldsDialogBuilder integer(String label,
 Supplier<Integer> valueExtractor,
 Consumer<Integer> handler)

Adds an int field. The default strategy is ValidationStrategies.integerPositive().

Parameters:

label - label of the field

valueExtractor - reads the initial value; null leaves the field empty

handler - gets the new value after OK

Returns:

this builder

doubleValue

public FieldsDialogBuilder doubleValue(String label,
 Supplier<Double> valueExtractor,
 Consumer<Double> handler)

Adds a double field. The default strategy is ValidationStrategies.doublePositive().

Parameters:

label - label of the field

valueExtractor - reads the initial value; null leaves the field empty

handler - gets the new value after OK

Returns:

this builder

string

public FieldsDialogBuilder string(String label,
 Supplier<String> valueExtractor,
 Consumer<String> handler)

Adds a String field. The default strategy is ValidationStrategies.stringIsNotEmpty().

Parameters:

label - label of the field

valueExtractor - reads the initial value; null leaves the field empty

handler - gets the new value after OK

Returns:

this builder

file

public FieldsDialogBuilder file(String label,
 Supplier<String> valueExtractor,
 Consumer<String> handler)

Adds a file path field with the Buttons.openFile() button. The default strategy is ValidationStrategies.stringIsNotEmpty().

Parameters:

label - label of the field

valueExtractor - reads the initial path; null leaves the field empty

handler - gets the new path after OK

Returns:

this builder

folder

public FieldsDialogBuilder folder(String label,
 Supplier<String> valueExtractor,
 Consumer<String> handler)

Adds a folder path field with the Buttons.openDirectory() button. The default strategy is ValidationStrategies.stringIsNotEmpty().

Parameters:

label - label of the field

valueExtractor - reads the initial path; null leaves the field empty

handler - gets the new path after OK

Returns:

this builder

strategy

public FieldsDialogBuilder strategy(String label,
 ValidationStrategy<?,String> strategy)

Replaces the validation strategy of the field with the label. The model type of the strategy must be the type of the field.

Parameters:

label - label of the field

strategy - checks and converts the text of the field

Returns:

this builder

Throws:

IllegalArgumentException - if no field has the label

button

public FieldsDialogBuilder button(String label,
 ISimpleButtonProperties button)

Sets the button of the field with the label. For a file or folder field it replaces the default button, for example with Buttons.openFile().extensions(...).

Parameters:

label - label of the field

button - the button; one instance belongs to one field

Returns:

this builder

Throws:

IllegalArgumentException - if no field has the label

message

public FieldsDialogBuilder message(String message)

Sets the message under the title.

Parameters:

message - the message; null shows no message

Returns:

this builder

open

public boolean open()

Opens the dialog and waits until it is closed.

Returns:

true after OK, when the handlers have got the new values; false after Cancel