Dialogs (Jmix-ui 1.0 API)

All Known Implementing Classes:

DialogsImpl
```
public interface Dialogs
```
Utility dialogs API.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Dialogs.BackgroundWorkDialogBuilder<T extends java.lang.Number,V>` Builder of background work dialog.
`static interface`	`Dialogs.DialogBuilder<T extends Dialogs.DialogBuilder>` Base class for all Dialog Builders.
`static interface`	`Dialogs.ExceptionDialogBuilder` Builder of unhandled exception dialog.
`static interface`	`Dialogs.HasCaption<T>` Marker interface for Dialog Builders that have caption.
`static interface`	`Dialogs.HasContentMode<T>` Marker interface for Dialog Builders that have content mode setting.
`static interface`	`Dialogs.HasHtmlSanitizer<T>` Marker interface for Dialog Builders that have html sanitizer for dialog content.
`static interface`	`Dialogs.HasMessage<T>` Marker interface for Dialog Builders that have message.
`static interface`	`Dialogs.HasModal<T>` Marker interface for Dialog Builders that have modal setting.
`static interface`	`Dialogs.HasSize<T>` Marker interface for Dialog Builders that have size setting.
`static interface`	`Dialogs.HasStyleName<T>` Marker interface for Dialog Builders that have stylename setting.
`static interface`	`Dialogs.HasWindowMode<T>` Marker interface for Dialog Builders that have window mode for dialog window.
`static interface`	`Dialogs.InputDialogBuilder` Builder for dialogs with inputs.
`static interface`	`Dialogs.MessageDialogBuilder` Builder of information dialog.
`static interface`	`Dialogs.OptionDialogBuilder` Builder of dialog with option buttons.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`<T extends java.lang.Number,V> Dialogs.BackgroundWorkDialogBuilder<T,V>`	`createBackgroundWorkDialog(FrameOwner owner, BackgroundTask<T,V> backgroundTask)` Creates background work dialog builder.
`Dialogs.ExceptionDialogBuilder`	`createExceptionDialog()` Creates exception dialog builder.
`Dialogs.InputDialogBuilder`	`createInputDialog(FrameOwner owner)` Creates input dialog builder.
`Dialogs.MessageDialogBuilder`	`createMessageDialog()` Creates message dialog builder.
`Dialogs.OptionDialogBuilder`	`createOptionDialog()` Creates option dialog builder.

Method Detail

createOptionDialog

Dialogs.OptionDialogBuilder createOptionDialog()

Creates option dialog builder.
Example of showing an option dialog:


 dialogs.createOptionDialog()
         .withCaption("Question")
         .withMessage("Do you want to discard data?")
         .withActions(
                 new DialogAction(DialogAction.Type.YES).withHandler(e -> {
                     // YES option selected
                 }),
                 new DialogAction(DialogAction.Type.NO).withHandler(e -> {
                     // NO option selected
                 })
         )
         .show();

Returns:: builder

createMessageDialog

Dialogs.MessageDialogBuilder createMessageDialog()

Creates message dialog builder.
Example of showing a message dialog:


 dialogs.createMessageDialog()
         .withCaption("Alert")
         .withMessage("Report has been saved")
         .show();

Returns:: builder

createExceptionDialog

Dialogs.ExceptionDialogBuilder createExceptionDialog()

Creates exception dialog builder.
Example of showing an exception dialog:


 dialogs.createExceptionDialog()
         .withCaption("Alert")
         .withMessage("Report has been saved")
         .withThrowable(exception)
         .show();

Returns:: builder

createInputDialog

Dialogs.InputDialogBuilder createInputDialog(FrameOwner owner)

Creates input dialog builder.

Example of showing an input dialog:


 dialogs.createInputDialog(this)
         .withParameters(
                 stringParameter("name").withCaption("Name"),
                 intParameter("count").withCaption("Count"))
         .withActions(DialogActions.OK_CANCEL)
         .withCloseListener(closeEvent ->
                 notifications.create(Notifications.NotificationType.TRAY)
                         .withCaption("Dialog is closed")
                         .show())
         .withCaption("Goods")
         .show();

Parameters:: owner - origin screen from input dialog is invoked
Returns:: builder

createBackgroundWorkDialog

<T extends java.lang.Number,V> Dialogs.BackgroundWorkDialogBuilder<T,V> createBackgroundWorkDialog(FrameOwner owner,
                                                                                                   BackgroundTask<T,V> backgroundTask)

Creates background work dialog builder.

Example of showing a background work dialog:


 dialogs.createBackgroundWorkDialog(this, backgroundTask)
         .withCaption("Task")
         .withMessage("My Task is Running")
         .withTotal(total)
         .withShowProgressInPercentage(true)
         .withCancelAllowed(true)
         .show();

Parameters:: owner - origin screen from the dialog is invoked
Returns:: builder

Interface Dialogs