Package io.jmix.flowui.impl

Class DialogsImpl.BackgroundTaskDialogBuilderImpl<T extends Number,V>

java.lang.Object

io.jmix.flowui.impl.DialogsImpl.BackgroundTaskDialogBuilderImpl<T,V>

Type Parameters:

T - the type of the progress update values provided by the task, extending Number

V - the result type of the background task

All Implemented Interfaces:

Dialogs.BackgroundTaskDialogBuilder<T,V>, Dialogs.Draggable<Dialogs.BackgroundTaskDialogBuilder<T,V>>, Dialogs.HasContent<Dialogs.BackgroundTaskDialogBuilder<T,V>>, Dialogs.HasHeader<Dialogs.BackgroundTaskDialogBuilder<T,V>>, Dialogs.HasPosition<Dialogs.BackgroundTaskDialogBuilder<T,V>>, Dialogs.HasStyle<Dialogs.BackgroundTaskDialogBuilder<T,V>>, Dialogs.HasText<Dialogs.BackgroundTaskDialogBuilder<T,V>>, Dialogs.HasTheme<Dialogs.BackgroundTaskDialogBuilder<T,V>>, Dialogs.Resizable<Dialogs.BackgroundTaskDialogBuilder<T,V>>

Enclosing class:

DialogsImpl

public class DialogsImpl.BackgroundTaskDialogBuilderImpl<T extends Number,V>
extends Object
implements Dialogs.BackgroundTaskDialogBuilder<T,V>

Implementation of Dialogs.BackgroundTaskDialogBuilder that facilitates creating and managing dialogs for running background tasks with progress display, cancel functionality, and customizable UI elements.

Field Summary

Fields

Modifier and Type	Field	Description
protected BackgroundTask<T,V>	backgroundTask
protected boolean	cancelAllowed
protected com.vaadin.flow.component.button.Button	cancelButton
protected com.vaadin.flow.component.Component	content
protected com.vaadin.flow.component.dialog.Dialog	dialog
protected com.vaadin.flow.component.orderedlayout.VerticalLayout	layout
protected com.vaadin.flow.shared.Registration	openedRegistration
protected com.vaadin.flow.component.progressbar.ProgressBar	progressBar
protected com.vaadin.flow.component.html.Span	progressTextSpan
protected boolean	showProgressInPercentage
protected BackgroundTaskHandler<V>	taskHandler
protected Number	total

Constructor Summary

Constructors

Constructor	Description
BackgroundTaskDialogBuilderImpl(BackgroundTask<T,V> backgroundTask)

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.component.dialog.Dialog	build()	Constructs and returns a Dialog instance, configured based on the current state of the builder.
protected com.vaadin.flow.component.dialog.Dialog	createDialog()
protected void	fireDialogOpenedChangeEvent(com.vaadin.flow.component.dialog.Dialog.OpenedChangeEvent openedChangeEvent)
String	getClassName()	Gets the CSS class names for this component.
com.vaadin.flow.component.Component	getContent()
String	getHeader()
String	getLeft()	Gets the left position of the dialog.
String	getMaxHeight()
String	getMaxWidth()
String	getMinHeight()
String	getMinWidth()
String	getText()
String	getThemeName()	Gets the theme names for this component.
String	getTop()	Gets the top position of the dialog.
Number	getTotal()
protected void	handleTaskWrapperCloseView(LocalizedTaskWrapper.CloseViewContext event)
protected void	initDialog(com.vaadin.flow.component.dialog.Dialog dialog)
protected void	initDialogContent(com.vaadin.flow.component.dialog.Dialog dialog)
boolean	isCancelAllowed()
boolean	isDraggable()
protected boolean	isIndeterminateMode()
boolean	isResizable()
boolean	isShowProgressInPercentage()
protected void	onCancelButtonClick(com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button> event)
com.vaadin.flow.component.dialog.Dialog	open()	Opens the background task dialog.
protected void	startExecution()
protected void	updateProgress(Number processedValue)
Dialogs.BackgroundTaskDialogBuilder<T,V>	withCancelAllowed(boolean cancelAllowed)	Determines whether the dialog can be closed.
Dialogs.BackgroundTaskDialogBuilder<T,V>	withClassName(String className)	Sets the CSS class names of this component.
Dialogs.BackgroundTaskDialogBuilder<T,V>	withContent(com.vaadin.flow.component.Component content)	Sets a content.
Dialogs.BackgroundTaskDialogBuilder<T,V>	withDraggable(boolean draggable)	Sets whether dialog is enabled to be dragged by the user or not.
Dialogs.BackgroundTaskDialogBuilder<T,V>	withDraggedListener(com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogDraggedEvent> listener)	Adds a listener that is called after user finishes dragging the dialog.
Dialogs.BackgroundTaskDialogBuilder<T,V>	withHeader(String header)	Sets a header text.
Dialogs.BackgroundTaskDialogBuilder<T,V>	withLeft(String left)	Sets the distance of the dialog from the left of its container.
Dialogs.BackgroundTaskDialogBuilder<T,V>	withMaxHeight(String maxHeight)	Sets a dialog max height.
Dialogs.BackgroundTaskDialogBuilder<T,V>	withMaxWidth(String maxWidth)	Sets a dialog max width.
Dialogs.BackgroundTaskDialogBuilder<T,V>	withMinHeight(String minHeight)	Sets a dialog min height.
Dialogs.BackgroundTaskDialogBuilder<T,V>	withMinWidth(String minWidth)	Sets a dialog min width.
Dialogs.BackgroundTaskDialogBuilder<T,V>	withResizable(boolean resizable)	Sets whether dialog can be resized by user or not.
Dialogs.BackgroundTaskDialogBuilder<T,V>	withResizeListener(com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogResizeEvent> listener)	Adds a listener that is called after user finishes resizing the dialog.
Dialogs.BackgroundTaskDialogBuilder<T,V>	withShowProgressInPercentage(boolean percentProgress)	Sets whether progress should be represented as percentage (rather than as raw number).
Dialogs.BackgroundTaskDialogBuilder<T,V>	withText(String text)	Sets a text.
Dialogs.BackgroundTaskDialogBuilder<T,V>	withThemeName(String themeName)	Sets the theme names of the dialog.
Dialogs.BackgroundTaskDialogBuilder<T,V>	withTop(String top)	Sets the top position of the dialog.
Dialogs.BackgroundTaskDialogBuilder<T,V>	withTotal(Number total)	Sets amount of items to be processed by background task.

Methods inherited from class java.lang.Object

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

Field Details

dialog

protected com.vaadin.flow.component.dialog.Dialog dialog

layout

protected com.vaadin.flow.component.orderedlayout.VerticalLayout layout

content

protected com.vaadin.flow.component.Component content

progressTextSpan

protected com.vaadin.flow.component.html.Span progressTextSpan

progressBar

protected com.vaadin.flow.component.progressbar.ProgressBar progressBar

cancelButton

protected com.vaadin.flow.component.button.Button cancelButton

backgroundTask

protected BackgroundTask<T extends Number,V> backgroundTask

total

protected Number total

showProgressInPercentage

protected boolean showProgressInPercentage

cancelAllowed

protected boolean cancelAllowed

openedRegistration

protected com.vaadin.flow.shared.Registration openedRegistration

taskHandler

protected BackgroundTaskHandler<V> taskHandler

Constructor Details

BackgroundTaskDialogBuilderImpl

public BackgroundTaskDialogBuilderImpl(BackgroundTask<T,V> backgroundTask)

Method Details

createDialog

protected com.vaadin.flow.component.dialog.Dialog createDialog()

initDialog

protected void initDialog(com.vaadin.flow.component.dialog.Dialog dialog)

initDialogContent

protected void initDialogContent(com.vaadin.flow.component.dialog.Dialog dialog)

withCancelAllowed

public Dialogs.BackgroundTaskDialogBuilder<T,V> withCancelAllowed(boolean cancelAllowed)

Description copied from interface: Dialogs.BackgroundTaskDialogBuilder

Determines whether the dialog can be closed.

The default value is false.

Specified by:

withCancelAllowed in interface Dialogs.BackgroundTaskDialogBuilder<T extends Number,V>

Parameters:

cancelAllowed - true if dialog is closeable

Returns:

builder

isCancelAllowed

public boolean isCancelAllowed()

Specified by:

isCancelAllowed in interface Dialogs.BackgroundTaskDialogBuilder<T extends Number,V>

Returns:

true if the dialog can be closed

withTotal

public Dialogs.BackgroundTaskDialogBuilder<T,V> withTotal(Number total)

Description copied from interface: Dialogs.BackgroundTaskDialogBuilder

Sets amount of items to be processed by background task.
Use TaskLifeCycle.publish(Object[]) to notify the dialog about progress completion.

Specified by:

withTotal in interface Dialogs.BackgroundTaskDialogBuilder<T extends Number,V>

Parameters:

total - amount of items to be processed by background task,

Returns:

builder

getTotal

public Number getTotal()

Specified by:

getTotal in interface Dialogs.BackgroundTaskDialogBuilder<T extends Number,V>

Returns:

amount of items to be processed by background task

withShowProgressInPercentage

public Dialogs.BackgroundTaskDialogBuilder<T,V> withShowProgressInPercentage(boolean percentProgress)

Description copied from interface: Dialogs.BackgroundTaskDialogBuilder

Sets whether progress should be represented as percentage (rather than as raw number).

Specified by:

withShowProgressInPercentage in interface Dialogs.BackgroundTaskDialogBuilder<T extends Number,V>

Parameters:

percentProgress - true to show progress in percents

Returns:

builder

isShowProgressInPercentage

public boolean isShowProgressInPercentage()

Specified by:

isShowProgressInPercentage in interface Dialogs.BackgroundTaskDialogBuilder<T extends Number,V>

Returns:

true if progress should is shown in percents

withHeader

public Dialogs.BackgroundTaskDialogBuilder<T,V> withHeader(String header)

Description copied from interface: Dialogs.HasHeader

Sets a header text.

Specified by:

withHeader in interface Dialogs.HasHeader<T extends Number>

Parameters:

header - header text

Returns:

builder

getHeader

@Nullable
public String getHeader()

Specified by:

getHeader in interface Dialogs.HasHeader<T extends Number>

Returns:

header text

withText

public Dialogs.BackgroundTaskDialogBuilder<T,V> withText(String text)

Description copied from interface: Dialogs.HasText

Sets a text.

Specified by:

withText in interface Dialogs.HasText<T extends Number>

Parameters:

text - a text

Returns:

builder

getText

@Nullable
public String getText()

Specified by:

getText in interface Dialogs.HasText<T extends Number>

Returns:

a text

withThemeName

public Dialogs.BackgroundTaskDialogBuilder<T,V> withThemeName(String themeName)

Description copied from interface: Dialogs.HasTheme

Sets the theme names of the dialog. This method overwrites any previous set theme names.

Specified by:

withThemeName in interface Dialogs.HasTheme<T extends Number>

Parameters:

themeName - a space-separated string of theme names to set, or empty string to remove all theme names

Returns:

builder

getThemeName

@Nullable
public String getThemeName()

Description copied from interface: Dialogs.HasTheme

Gets the theme names for this component.

Specified by:

getThemeName in interface Dialogs.HasTheme<T extends Number>

Returns:

a space-separated string of theme names, empty string if there are no theme names or null if attribute (theme) is not set at all

withClassName

public Dialogs.BackgroundTaskDialogBuilder<T,V> withClassName(@Nullable
 String className)

Description copied from interface: Dialogs.HasStyle

Sets the CSS class names of this component. This method overwrites any previous set class names.

Specified by:

withClassName in interface Dialogs.HasStyle<T extends Number>

Parameters:

className - a space-separated string of class names to set, or null to remove all class names

getClassName

@Nullable
public String getClassName()

Description copied from interface: Dialogs.HasStyle

Gets the CSS class names for this component.

Specified by:

getClassName in interface Dialogs.HasStyle<T extends Number>

Returns:

a space-separated string of class names, or null if there are no class names

withDraggable

public Dialogs.BackgroundTaskDialogBuilder<T,V> withDraggable(boolean draggable)

Description copied from interface: Dialogs.Draggable

Sets whether dialog is enabled to be dragged by the user or not.

Specified by:

withDraggable in interface Dialogs.Draggable<T extends Number>

Parameters:

draggable - true to enable dragging of the dialog, false otherwise

Returns:

builder

isDraggable

public boolean isDraggable()

Specified by:

isDraggable in interface Dialogs.Draggable<T extends Number>

Returns:

true if dragging is enabled, false otherwise

withDraggedListener

public Dialogs.BackgroundTaskDialogBuilder<T,V> withDraggedListener(com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogDraggedEvent> listener)

Description copied from interface: Dialogs.Draggable

Adds a listener that is called after user finishes dragging the dialog. It is called only if dragging is enabled.

Note: By default, the component will sync the top/left values after every dragging.

Specified by:

withDraggedListener in interface Dialogs.Draggable<T extends Number>

Parameters:

listener - the listener to add

Returns:

builder

See Also:

• Dialogs.Draggable.withDraggable(boolean)

withResizeListener

public Dialogs.BackgroundTaskDialogBuilder<T,V> withResizeListener(com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.dialog.Dialog.DialogResizeEvent> listener)

Description copied from interface: Dialogs.Resizable

Adds a listener that is called after user finishes resizing the dialog. It is called only if resizing is enabled (see Dialogs.Resizable.withResizable(boolean)).

Note: By default, the component will sync the width/height and top/left values after every resizing.

Specified by:

withResizeListener in interface Dialogs.Resizable<T extends Number>

Parameters:

listener - the listener to add

Returns:

registration for removal of listener

withContent

public Dialogs.BackgroundTaskDialogBuilder<T,V> withContent(com.vaadin.flow.component.Component content)

Description copied from interface: Dialogs.HasContent

Sets a content.

Specified by:

withContent in interface Dialogs.HasContent<T extends Number>

Parameters:

content - a content

Returns:

builder

getContent

public com.vaadin.flow.component.Component getContent()

Specified by:

getContent in interface Dialogs.HasContent<T extends Number>

Returns:

a content

withResizable

public Dialogs.BackgroundTaskDialogBuilder<T,V> withResizable(boolean resizable)

Description copied from interface: Dialogs.Resizable

Sets whether dialog can be resized by user or not.

By default, the dialog is not resizable.

Specified by:

withResizable in interface Dialogs.Resizable<T extends Number>

Parameters:

resizable - true to enabled resizing of the dialog, false otherwise.

Returns:

builder

isResizable

public boolean isResizable()

Specified by:

isResizable in interface Dialogs.Resizable<T extends Number>

Returns:

true if resizing is enabled, false otherwise

withMinWidth

public Dialogs.BackgroundTaskDialogBuilder<T,V> withMinWidth(String minWidth)

Description copied from interface: Dialogs.Resizable

Sets a dialog min width.

Specified by:

withMinWidth in interface Dialogs.Resizable<T extends Number>

Parameters:

minWidth - a dialog min width

Returns:

builder

getMinWidth

public String getMinWidth()

Specified by:

getMinWidth in interface Dialogs.Resizable<T extends Number>

Returns:

dialog min width value

withMinHeight

public Dialogs.BackgroundTaskDialogBuilder<T,V> withMinHeight(String minHeight)

Description copied from interface: Dialogs.Resizable

Sets a dialog min height.

Specified by:

withMinHeight in interface Dialogs.Resizable<T extends Number>

Parameters:

minHeight - a dialog min height

Returns:

builder

getMinHeight

public String getMinHeight()

Specified by:

getMinHeight in interface Dialogs.Resizable<T extends Number>

Returns:

dialog min height value

withMaxWidth

public Dialogs.BackgroundTaskDialogBuilder<T,V> withMaxWidth(String maxWidth)

Description copied from interface: Dialogs.Resizable

Sets a dialog max width.

Specified by:

withMaxWidth in interface Dialogs.Resizable<T extends Number>

Parameters:

maxWidth - a dialog max width

Returns:

builder

getMaxWidth

public String getMaxWidth()

Specified by:

getMaxWidth in interface Dialogs.Resizable<T extends Number>

Returns:

dialog max width value

withMaxHeight

public Dialogs.BackgroundTaskDialogBuilder<T,V> withMaxHeight(String maxHeight)

Description copied from interface: Dialogs.Resizable

Sets a dialog max height.

Specified by:

withMaxHeight in interface Dialogs.Resizable<T extends Number>

Parameters:

maxHeight - a dialog max height

Returns:

builder

getMaxHeight

public String getMaxHeight()

Specified by:

getMaxHeight in interface Dialogs.Resizable<T extends Number>

Returns:

dialog max height value

getLeft

public String getLeft()

Description copied from interface: Dialogs.HasPosition

Gets the left position of the dialog.

Specified by:

getLeft in interface Dialogs.HasPosition<T extends Number>

Returns:

the left position of the dialog

withLeft

public Dialogs.BackgroundTaskDialogBuilder<T,V> withLeft(String left)

Description copied from interface: Dialogs.HasPosition

Sets the distance of the dialog from the left of its container. If a unitless number is provided, pixels are assumed.

Note that the dialog left edge may not be the same as the viewport left edge (e.g. the Lumo theme defines some spacing to prevent the dialog from stretching all the way to the left of the viewport).

Specified by:

withLeft in interface Dialogs.HasPosition<T extends Number>

Parameters:

left - the left position of the dialog

Returns:

builder

getTop

public String getTop()

Description copied from interface: Dialogs.HasPosition

Gets the top position of the dialog.

Specified by:

getTop in interface Dialogs.HasPosition<T extends Number>

Returns:

the top position of the dialog

withTop

public Dialogs.BackgroundTaskDialogBuilder<T,V> withTop(String top)

Description copied from interface: Dialogs.HasPosition

Sets the top position of the dialog. If a unitless number is provided, pixels are assumed.

Note that the dialog top edge may not be the same as the viewport top edge (e.g. the Lumo theme defines some spacing to prevent the dialog from stretching all the way to the top of the viewport).

Specified by:

withTop in interface Dialogs.HasPosition<T extends Number>

Parameters:

top - the top position of the dialog

Returns:

builder

build

public com.vaadin.flow.component.dialog.Dialog build()

Constructs and returns a Dialog instance, configured based on the current state of the builder.

Specified by:

build in interface Dialogs.BackgroundTaskDialogBuilder<T extends Number,V>

Returns:

the configured Dialog instance

open

public com.vaadin.flow.component.dialog.Dialog open()

Description copied from interface: Dialogs.BackgroundTaskDialogBuilder

Opens the background task dialog.

Specified by:

open in interface Dialogs.BackgroundTaskDialogBuilder<T extends Number,V>

isIndeterminateMode

protected boolean isIndeterminateMode()

startExecution

protected void startExecution()

updateProgress

protected void updateProgress(Number processedValue)

onCancelButtonClick

protected void onCancelButtonClick(com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button> event)

handleTaskWrapperCloseView

protected void handleTaskWrapperCloseView(LocalizedTaskWrapper.CloseViewContext event)

fireDialogOpenedChangeEvent

protected void fireDialogOpenedChangeEvent(com.vaadin.flow.component.dialog.Dialog.OpenedChangeEvent openedChangeEvent)