io.jmix.ui

Interface Dialogs.BackgroundWorkDialogBuilder<T extends java.lang.Number,V>

All Superinterfaces:

Dialogs.HasCaption<Dialogs.BackgroundWorkDialogBuilder<T,V>>, Dialogs.HasMessage<Dialogs.BackgroundWorkDialogBuilder<T,V>>

All Known Implementing Classes:

DialogsImpl.BackgroundWorkDialogBuilderImpl

Enclosing interface:

Dialogs

public static interface Dialogs.BackgroundWorkDialogBuilder<T extends java.lang.Number,V>
extends Dialogs.HasCaption<Dialogs.BackgroundWorkDialogBuilder<T,V>>, Dialogs.HasMessage<Dialogs.BackgroundWorkDialogBuilder<T,V>>

Builder of background work dialog.

Method Summary

Modifier and Type	Method and Description
BackgroundWorkDialog<T,V>	build() Builds the dialog.
java.lang.Number	getTotal()
boolean	isCancelAllowed()
boolean	isShowProgressInPercentage()
BackgroundWorkDialog<T,V>	show() Shows the dialog.
Dialogs.BackgroundWorkDialogBuilder<T,V>	withCancelAllowed(boolean cancelAllowed) Determines whether the dialog can be closed.
Dialogs.BackgroundWorkDialogBuilder<T,V>	withShowProgressInPercentage(boolean percentProgress)
Dialogs.BackgroundWorkDialogBuilder<T,V>	withTotal(java.lang.Number total)

Methods inherited from interface io.jmix.ui.Dialogs.HasCaption

getCaption, withCaption

Methods inherited from interface io.jmix.ui.Dialogs.HasMessage

getMessage, withMessage

Method Detail

withCancelAllowed

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

Determines whether the dialog can be closed. False by default.

Parameters:

cancelAllowed - true if dialog is closeable

Returns:

builder

isCancelAllowed

boolean isCancelAllowed()

Returns:

true if the dialog can be closed

withTotal

Dialogs.BackgroundWorkDialogBuilder<T,V> withTotal(java.lang.Number total)

Parameters:

total - amount of items to be processed by background task, use TaskLifeCycle.publish(Object[]) to notify the dialog about progress completion.

Returns:

builder

getTotal

java.lang.Number getTotal()

Returns:

total

withShowProgressInPercentage

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

Parameters:

percentProgress - true if progress should be represented as percentage (rather than as raw number)

Returns:

builder

isShowProgressInPercentage

boolean isShowProgressInPercentage()

Returns:

true if progress should is shown in percents

show

BackgroundWorkDialog<T,V> show()

Shows the dialog.

Returns:

background work dialog

build

BackgroundWorkDialog<T,V> build()

Builds the dialog.

Returns:

background work dialog