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

Class Dialogues

java.lang.Object

com.amalgamasimulation.desktop.ui.editor.dialogs.Dialogues

public final class Dialogues
extends Object

Simple dialogs with input fields. You build a dialog with a chain of calls and open it with open.

Kinds of dialog:

• one field: integer, doubleValue, string, file, folder. open returns the entered value. If the user clicks Cancel, open returns an empty Optional.
• any number of fields: fields. Each field reads its value from the supplier. After OK, each field passes the new value to its handler.
• one field for each record component: record. open returns a new record with the entered values.
• one field for each feature of an EMF object: emf. After OK, the dialog sets all features with one command.

While the value of any field fails validation, the OK button is disabled.

Example with one field:

 Optional<Integer> trucks = Dialogues.integer(shell, "Count")
         .label("Trucks")
         .value(5)
         .open();
 

Example with several fields:

 Dialogues.fields(shell, "Settings")
         .integer("Trucks", () -> trucks, value -> trucks = value)
         .doubleValue("Speed", () -> speed, value -> speed = value)
         .open();
 

Author:

Ionov Ivan

Method Summary

Modifier and Type	Method	Description
static ValueDialogBuilder<Double>	doubleValue(org.eclipse.swt.widgets.Shell shell, String title)	Dialog with one double field, see FieldsDialogBuilder.doubleValue(java.lang.String, java.util.function.Supplier<java.lang.Double>, java.util.function.Consumer<java.lang.Double>).
static EmfDialogBuilder	emf(org.eclipse.swt.widgets.Shell shell, String title, org.eclipse.emf.ecore.EObject eObject)	Dialog with one field per added feature of the EMF object, see EmfDialogBuilder.
static FieldsDialogBuilder	fields(org.eclipse.swt.widgets.Shell shell, String title)	Dialog with any number of fields, added by the builder in the given order.
static ValueDialogBuilder<String>	file(org.eclipse.swt.widgets.Shell shell, String title)	Dialog with one file path field, see FieldsDialogBuilder.file(java.lang.String, java.util.function.Supplier<java.lang.String>, java.util.function.Consumer<java.lang.String>).
static ValueDialogBuilder<String>	folder(org.eclipse.swt.widgets.Shell shell, String title)	Dialog with one folder path field, see FieldsDialogBuilder.folder(java.lang.String, java.util.function.Supplier<java.lang.String>, java.util.function.Consumer<java.lang.String>).
static ValueDialogBuilder<Integer>	integer(org.eclipse.swt.widgets.Shell shell, String title)	Dialog with one int field, see FieldsDialogBuilder.integer(java.lang.String, java.util.function.Supplier<java.lang.Integer>, java.util.function.Consumer<java.lang.Integer>).
static <R extends Record> RecordDialogBuilder<R>	record(org.eclipse.swt.widgets.Shell shell, String title, R value)	Dialog with one field per component of the record, see RecordDialogBuilder.
static ValueDialogBuilder<String>	string(org.eclipse.swt.widgets.Shell shell, String title)	Dialog with one String field, see FieldsDialogBuilder.string(java.lang.String, java.util.function.Supplier<java.lang.String>, java.util.function.Consumer<java.lang.String>).

Methods inherited from class java.lang.Object

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

Method Details

integer

public static ValueDialogBuilder<Integer> integer(org.eclipse.swt.widgets.Shell shell,
 String title)

Dialog with one int field, see FieldsDialogBuilder.integer(java.lang.String, java.util.function.Supplier<java.lang.Integer>, java.util.function.Consumer<java.lang.Integer>).

Parameters:

shell - parent shell

title - title of the dialog

Returns:

the builder of the dialog

doubleValue

public static ValueDialogBuilder<Double> doubleValue(org.eclipse.swt.widgets.Shell shell,
 String title)

Dialog with one double field, see FieldsDialogBuilder.doubleValue(java.lang.String, java.util.function.Supplier<java.lang.Double>, java.util.function.Consumer<java.lang.Double>).

Parameters:

shell - parent shell

title - title of the dialog

Returns:

the builder of the dialog

string

public static ValueDialogBuilder<String> string(org.eclipse.swt.widgets.Shell shell,
 String title)

Dialog with one String field, see FieldsDialogBuilder.string(java.lang.String, java.util.function.Supplier<java.lang.String>, java.util.function.Consumer<java.lang.String>).

Parameters:

shell - parent shell

title - title of the dialog

Returns:

the builder of the dialog

file

public static ValueDialogBuilder<String> file(org.eclipse.swt.widgets.Shell shell,
 String title)

Dialog with one file path field, see FieldsDialogBuilder.file(java.lang.String, java.util.function.Supplier<java.lang.String>, java.util.function.Consumer<java.lang.String>).

Parameters:

shell - parent shell

title - title of the dialog

Returns:

the builder of the dialog

folder

public static ValueDialogBuilder<String> folder(org.eclipse.swt.widgets.Shell shell,
 String title)

Dialog with one folder path field, see FieldsDialogBuilder.folder(java.lang.String, java.util.function.Supplier<java.lang.String>, java.util.function.Consumer<java.lang.String>).

Parameters:

shell - parent shell

title - title of the dialog

Returns:

the builder of the dialog

fields

public static FieldsDialogBuilder fields(org.eclipse.swt.widgets.Shell shell,
 String title)

Dialog with any number of fields, added by the builder in the given order.

Parameters:

shell - parent shell

title - title of the dialog

Returns:

the builder of the dialog

record

public static <R extends Record>
RecordDialogBuilder<R> record(org.eclipse.swt.widgets.Shell shell,
 String title,
 R value)

Dialog with one field per component of the record, see RecordDialogBuilder.

Type Parameters:

R - type of the record

Parameters:

shell - parent shell

title - title of the dialog

value - the record whose values the fields show; not null

Returns:

the builder of the dialog

Throws:

IllegalArgumentException - if a component is not int, Integer, double, Double, String or Path; the message names the component

emf

public static EmfDialogBuilder emf(org.eclipse.swt.widgets.Shell shell,
 String title,
 org.eclipse.emf.ecore.EObject eObject)

Dialog with one field per added feature of the EMF object, see EmfDialogBuilder.

Parameters:

shell - parent shell

title - title of the dialog

eObject - the object whose features the fields show and set; not null

Returns:

the builder of the dialog