Package io.jmix.flowui

Interface Dialogs.BackgroundTaskDialogBuilder<T extends Number,V>

All Superinterfaces:

Dialogs.Draggable<Dialogs.BackgroundTaskDialogBuilder<T,V>>, Dialogs.HasHeader<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>>

All Known Implementing Classes:

DialogsImpl.BackgroundTaskDialogBuilderImpl

Enclosing interface:

Dialogs

public static interface Dialogs.BackgroundTaskDialogBuilder<T extends Number,V>
extends Dialogs.HasHeader<Dialogs.BackgroundTaskDialogBuilder<T,V>>, Dialogs.HasText<Dialogs.BackgroundTaskDialogBuilder<T,V>>, Dialogs.HasTheme<Dialogs.BackgroundTaskDialogBuilder<T,V>>, Dialogs.HasStyle<Dialogs.BackgroundTaskDialogBuilder<T,V>>, Dialogs.Draggable<Dialogs.BackgroundTaskDialogBuilder<T,V>>, Dialogs.Resizable<Dialogs.BackgroundTaskDialogBuilder<T,V>>

Builder of background task dialog.

Method Summary

Modifier and Type	Method	Description
Number	getTotal()
boolean	isCancelAllowed()
boolean	isShowProgressInPercentage()
void	open()	Opens the dialog.
Dialogs.BackgroundTaskDialogBuilder<T,V>	withCancelAllowed(boolean cancelAllowed)	Determines whether the dialog can be closed.
Dialogs.BackgroundTaskDialogBuilder<T,V>	withShowProgressInPercentage(boolean percentProgress)	Sets whether progress should be represented as percentage (rather than as raw number).
Dialogs.BackgroundTaskDialogBuilder<T,V>	withTotal(Number total)	Sets amount of items to be processed by background task.

Methods inherited from interface io.jmix.flowui.Dialogs.Draggable

isDraggable, withDraggable

Methods inherited from interface io.jmix.flowui.Dialogs.HasHeader

getHeader, withHeader

Methods inherited from interface io.jmix.flowui.Dialogs.HasStyle

getClassName, withClassName

Methods inherited from interface io.jmix.flowui.Dialogs.HasText

getText, withText

Methods inherited from interface io.jmix.flowui.Dialogs.HasTheme

getThemeName, withThemeName

Methods inherited from interface io.jmix.flowui.Dialogs.Resizable

getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, isResizable, withMaxHeight, withMaxWidth, withMinHeight, withMinWidth, withResizable

Method Details

withCancelAllowed

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

Determines whether the dialog can be closed.

The default value is false.

Parameters:

cancelAllowed - true if dialog is closeable

Returns:

builder

isCancelAllowed

boolean isCancelAllowed()

Returns:

true if the dialog can be closed

withTotal

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

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

Parameters:

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

Returns:

builder

getTotal

Number getTotal()

Returns:

amount of items to be processed by background task

withShowProgressInPercentage

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

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

Parameters:

percentProgress - true to show progress in percents

Returns:

builder

isShowProgressInPercentage

boolean isShowProgressInPercentage()

Returns:

true if progress should is shown in percents

open

void open()

Opens the dialog.