Module is.codion.swing.common.ui

Package is.codion.swing.common.ui.dialog

Class Dialogs

java.lang.Object

is.codion.swing.common.ui.dialog.Dialogs

public final class Dialogs
extends Object

A utility class for displaying Dialogs.

Method Summary

Modifier and Type	Method	Description
static <B extends ActionDialogBuilder<B>> ActionDialogBuilder<B>	actionDialog(JComponent component)
static CalendarDialogBuilder	calendarDialog()
static ComponentDialogBuilder	componentDialog(JComponent component)
static void	displayExceptionDialog(Throwable exception, Window dialogParent)	Displays the given exception in a dialog
static ExceptionDialogBuilder	exceptionDialog()
static FileSelectionDialogBuilder	fileSelectionDialog()
static FontSizeSelectionDialogBuilder	fontSizeSelectionDialog(String userPreferencePropertyName)
static <T> InputDialogBuilder<T>	inputDialog(ComponentValue<T,?> componentValue)
static LoginDialogBuilder	loginDialog()
static LookAndFeelSelectionDialogBuilder	lookAndFeelSelectionDialog()
static <T> SelectionDialogBuilder.MultiSelector<T>	multiSelector(Supplier<Collection<T>> valueSupplier)	Returns a SelectionDialogBuilder.MultiSelector implmentation based on a selection dialog.
static OkCancelDialogBuilder	okCancelDialog(JComponent component)
static ProgressDialog.Builder	progressDialog()
static <T, V> ProgressWorkerDialogBuilder<T,V>	progressWorkerDialog(is.codion.swing.common.model.worker.ProgressWorker.ProgressResultTask<T,V> task)	Note, also sets the progress bar type to 'determinate'.
static <T> ProgressWorkerDialogBuilder<T,?>	progressWorkerDialog(is.codion.swing.common.model.worker.ProgressWorker.ResultTask<T> task)
static ProgressWorkerDialogBuilder<?,?>	progressWorkerDialog(Control.Command task)
static <T> SelectionDialogBuilder<T>	selectionDialog(Collection<T> values)
static <T> SelectionDialogBuilder.SingleSelector<T>	singleSelector(Supplier<Collection<T>> valueSupplier)	Returns a SelectionDialogBuilder.SingleSelector implmentation based on a selection dialog.

Methods inherited from class java.lang.Object

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

Method Details

componentDialog

public static ComponentDialogBuilder componentDialog(JComponent component)

Parameters:

component - the component to display

Returns:

a new ComponentDialogBuilder instance.

progressDialog

public static ProgressDialog.Builder progressDialog()

Returns:

a new ProgressDialog.Builder instance.

progressWorkerDialog

public static ProgressWorkerDialogBuilder<?,?> progressWorkerDialog(Control.Command task)

Parameters:

task - the task to run

Returns:

a new indeterminate ProgressWorkerDialogBuilder instance

progressWorkerDialog

public static <T> ProgressWorkerDialogBuilder<T,?> progressWorkerDialog(is.codion.swing.common.model.worker.ProgressWorker.ResultTask<T> task)

Type Parameters:

T - the worker result type

Parameters:

task - the task to run

Returns:

a new indeterminate ProgressWorkerDialogBuilder instance

progressWorkerDialog

public static <T,
V>
ProgressWorkerDialogBuilder<T,V> progressWorkerDialog(is.codion.swing.common.model.worker.ProgressWorker.ProgressResultTask<T,V> task)

Note, also sets the progress bar type to 'determinate'.

Type Parameters:

T - the worker result type

V - the worker intermediate result type

Parameters:

task - the task to run

Returns:

a new determinate ProgressWorkerDialogBuilder instance

See Also:

• ProgressWorkerDialogBuilder.indeterminate(boolean)

loginDialog

public static LoginDialogBuilder loginDialog()

Returns:

a new login dialog builder

exceptionDialog

public static ExceptionDialogBuilder exceptionDialog()

Returns:

a new exception dialog builder

fileSelectionDialog

public static FileSelectionDialogBuilder fileSelectionDialog()

Returns:

a new FileSelectionDialogBuilder

selectionDialog

public static <T> SelectionDialogBuilder<T> selectionDialog(Collection<T> values)

Type Parameters:

T - the value type

Parameters:

values - the values to select from

Returns:

a new selection dialog builder

Throws:

IllegalArgumentException - in case values is empty

okCancelDialog

public static OkCancelDialogBuilder okCancelDialog(JComponent component)

Parameters:

component - the component to display

Returns:

a new OkCancelDialogBuilder

actionDialog

public static <B extends ActionDialogBuilder<B>>
ActionDialogBuilder<B> actionDialog(JComponent component)

Type Parameters:

B - the builder type

Parameters:

component - the component to display

Returns:

a new ActionDialogBuilder

calendarDialog

public static CalendarDialogBuilder calendarDialog()

Returns:

a new CalendarDialogBuilder

lookAndFeelSelectionDialog

public static LookAndFeelSelectionDialogBuilder lookAndFeelSelectionDialog()

Returns:

a builder for a dialog for selecting a look and feel

fontSizeSelectionDialog

public static FontSizeSelectionDialogBuilder fontSizeSelectionDialog(String userPreferencePropertyName)

Parameters:

userPreferencePropertyName - the name of the property to use when saving the selected font size as a user preference

Returns:

a builder for a dialog for selecting the font size

inputDialog

public static <T> InputDialogBuilder<T> inputDialog(ComponentValue<T,?> componentValue)

Type Parameters:

T - the value type

Parameters:

componentValue - the value which component to display

Returns:

a builder for a input dialog

singleSelector

public static <T>
SelectionDialogBuilder.SingleSelector<T> singleSelector(Supplier<Collection<T>> valueSupplier)

Returns a SelectionDialogBuilder.SingleSelector implmentation based on a selection dialog.

Type Parameters:

T - the type of values being looked up

Parameters:

valueSupplier - supplies the values for the selection dialog

Returns:

a new SelectionDialogBuilder.SingleSelector based on a selection dialog

multiSelector

public static <T>
SelectionDialogBuilder.MultiSelector<T> multiSelector(Supplier<Collection<T>> valueSupplier)

Returns a SelectionDialogBuilder.MultiSelector implmentation based on a selection dialog.

Type Parameters:

T - the type of values being looked up

Parameters:

valueSupplier - supplies the values for the selection dialog

Returns:

a new SelectionDialogBuilder.MultiSelector based on a selection dialog

displayExceptionDialog

public static void displayExceptionDialog(Throwable exception,
 Window dialogParent)

Displays the given exception in a dialog

Parameters:

exception - the exception

dialogParent - the dialog parent window