Package io.jmix.flowui.impl

Class DialogsImpl

java.lang.Object

io.jmix.flowui.impl.DialogsImpl

All Implemented Interfaces:

Dialogs

@Component("flowui_Dialogs")
public class DialogsImpl
extends Object
implements Dialogs

Implementation of the Dialogs interface, providing methods for creating different types of dialogs.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	DialogsImpl.BackgroundTaskDialogBuilderImpl<T extends Number,V>	Implementation of Dialogs.BackgroundTaskDialogBuilder that facilitates creating and managing dialogs for running background tasks with progress display, cancel functionality, and customizable UI elements.
class	DialogsImpl.InputDialogBuilderImpl	Implementation of the Dialogs.InputDialogBuilder interface designed to facilitate the creation and customization of InputDialog components.
class	DialogsImpl.MessageDialogBuilderImpl	Implementation of the Dialogs.MessageDialogBuilder interface that provides functionality for building and configuring a message dialog in a fluent manner.
class	DialogsImpl.OptionDialogBuilderImpl	Implementation of the Dialogs.OptionDialogBuilder that enables configuring and building option dialogs.

Nested classes/interfaces inherited from interface io.jmix.flowui.Dialogs

Dialogs.BackgroundTaskDialogBuilder<T extends Number,V>, Dialogs.Closeable<T>, Dialogs.DialogBuilder<T extends Dialogs.DialogBuilder>, Dialogs.Draggable<T>, Dialogs.HasContent<T>, Dialogs.HasHeader<T>, Dialogs.HasModal<T>, Dialogs.HasPosition<T>, Dialogs.HasSize<T>, Dialogs.HasStyle<T>, Dialogs.HasText<T>, Dialogs.HasTheme<T>, Dialogs.InputDialogBuilder, Dialogs.MessageDialogBuilder, Dialogs.OptionDialogBuilder, Dialogs.Resizable<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.context.ApplicationContext	applicationContext
protected BackgroundWorker	backgroundWorker
protected static final String	BUTTON_CLASS_NAMES_POSTFIX
protected DialogWindows	dialogWindows
protected UiViewProperties	flowUiViewProperties
protected Messages	messages
protected static final String	MIN_WIDTH
protected UiComponents	uiComponents

Constructor Summary

Constructors

Constructor	Description
DialogsImpl(org.springframework.context.ApplicationContext applicationContext, Messages messages, UiViewProperties flowUiViewProperties, DialogWindows dialogWindows, UiComponents uiComponents, BackgroundWorker backgroundWorker)

Method Summary

Modifier and Type	Method	Description
<T extends Number, V> Dialogs.BackgroundTaskDialogBuilder<T,V>	createBackgroundTaskDialog(BackgroundTask<T,V> backgroundTask)	Creates background task dialog builder.
protected com.vaadin.flow.component.button.Button	createButton(Action action, com.vaadin.flow.component.dialog.Dialog dialog)
Dialogs.InputDialogBuilder	createInputDialog(View<?> origin)	Creates input dialog builder.
Dialogs.MessageDialogBuilder	createMessageDialog()	Creates message dialog builder.
Dialogs.OptionDialogBuilder	createOptionDialog()	Creates option dialog builder.

Methods inherited from class java.lang.Object

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

Field Details

MIN_WIDTH

protected static final String MIN_WIDTH

See Also:

• Constant Field Values

BUTTON_CLASS_NAMES_POSTFIX

protected static final String BUTTON_CLASS_NAMES_POSTFIX

See Also:

• Constant Field Values

messages

protected Messages messages

flowUiViewProperties

protected UiViewProperties flowUiViewProperties

dialogWindows

protected DialogWindows dialogWindows

uiComponents

protected UiComponents uiComponents

backgroundWorker

protected BackgroundWorker backgroundWorker

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

Constructor Details

DialogsImpl

public DialogsImpl(org.springframework.context.ApplicationContext applicationContext,
 Messages messages,
 UiViewProperties flowUiViewProperties,
 DialogWindows dialogWindows,
 UiComponents uiComponents,
 BackgroundWorker backgroundWorker)

Method Details

createOptionDialog

public Dialogs.OptionDialogBuilder createOptionDialog()

Description copied from interface: Dialogs

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

 dialogs.createOptionDialog()
         .withHeader("Confirm")
         .withText("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
                 })
         )
         .open();
 

Specified by:

createOptionDialog in interface Dialogs

createMessageDialog

public Dialogs.MessageDialogBuilder createMessageDialog()

Description copied from interface: Dialogs

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

 dialogs.createMessageDialog()
         .withHeader("Attention")
         .withText("Report has been saved")
         .open();
 

Specified by:

createMessageDialog in interface Dialogs

Returns:

builder

createInputDialog

public Dialogs.InputDialogBuilder createInputDialog(View<?> origin)

Description copied from interface: Dialogs

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

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

Specified by:

createInputDialog in interface Dialogs

Parameters:

origin - origin view from input dialog is invoked

Returns:

builder

createBackgroundTaskDialog

public <T extends Number,
V>
Dialogs.BackgroundTaskDialogBuilder<T,V> createBackgroundTaskDialog(BackgroundTask<T,V> backgroundTask)

Description copied from interface: Dialogs

Creates background task dialog builder.
Example of showing a background task dialog:

 dialogs.createBackgroundTaskDialog(backgroundTask)
         .withHeader("Task")
         .withText("My Task is Running")
         .withTotal(10)
         .withShowProgressInPercentage(true)
         .withCancelAllowed(true)
         .open();
 

Specified by:

createBackgroundTaskDialog in interface Dialogs

Parameters:

backgroundTask - background task to run

Returns:

builder

createButton

protected com.vaadin.flow.component.button.Button createButton(Action action,
 com.vaadin.flow.component.dialog.Dialog dialog)