io.jmix.ui.sys

Class DialogsImpl.BackgroundWorkDialogBuilderImpl<T extends java.lang.Number,V>

java.lang.Object

io.jmix.ui.sys.DialogsImpl.BackgroundWorkDialogBuilderImpl<T,V>

All Implemented Interfaces:

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

Enclosing class:

DialogsImpl

public class DialogsImpl.BackgroundWorkDialogBuilderImpl<T extends java.lang.Number,V>
extends java.lang.Object
implements Dialogs.BackgroundWorkDialogBuilder<T,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected BackgroundWorkDialog<T,V>	backgroundWorkDialog

Constructor Summary

Constructors

Constructor and Description
BackgroundWorkDialogBuilderImpl(FrameOwner owner, BackgroundTask<T,V> task)

Method Summary

Modifier and Type	Method and Description
BackgroundWorkDialog<T,V>	build() Builds the dialog.
java.lang.String	getCaption()
java.lang.String	getMessage()
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>	withCaption(java.lang.String caption) Sets caption text.
Dialogs.BackgroundWorkDialogBuilder<T,V>	withMessage(java.lang.String message) Sets message text.
Dialogs.BackgroundWorkDialogBuilder<T,V>	withShowProgressInPercentage(boolean percentProgress)
Dialogs.BackgroundWorkDialogBuilder<T,V>	withTotal(java.lang.Number total)

Methods inherited from class java.lang.Object

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

Field Detail

backgroundWorkDialog

protected BackgroundWorkDialog<T extends java.lang.Number,V> backgroundWorkDialog

Constructor Detail

BackgroundWorkDialogBuilderImpl

public BackgroundWorkDialogBuilderImpl(FrameOwner owner,
                                       BackgroundTask<T,V> task)

Method Detail

withCancelAllowed

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

Description copied from interface: Dialogs.BackgroundWorkDialogBuilder

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

Specified by:

withCancelAllowed in interface Dialogs.BackgroundWorkDialogBuilder<T extends java.lang.Number,V>

Parameters:

cancelAllowed - true if dialog is closeable

Returns:

builder

isCancelAllowed

public boolean isCancelAllowed()

Specified by:

isCancelAllowed in interface Dialogs.BackgroundWorkDialogBuilder<T extends java.lang.Number,V>

Returns:

true if the dialog can be closed

withTotal

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

Specified by:

withTotal in interface Dialogs.BackgroundWorkDialogBuilder<T extends java.lang.Number,V>

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

public java.lang.Number getTotal()

Specified by:

getTotal in interface Dialogs.BackgroundWorkDialogBuilder<T extends java.lang.Number,V>

Returns:

total

withShowProgressInPercentage

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

Specified by:

withShowProgressInPercentage in interface Dialogs.BackgroundWorkDialogBuilder<T extends java.lang.Number,V>

Parameters:

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

Returns:

builder

isShowProgressInPercentage

public boolean isShowProgressInPercentage()

Specified by:

isShowProgressInPercentage in interface Dialogs.BackgroundWorkDialogBuilder<T extends java.lang.Number,V>

Returns:

true if progress should is shown in percents

withCaption

public Dialogs.BackgroundWorkDialogBuilder<T,V> withCaption(java.lang.String caption)

Description copied from interface: Dialogs.HasCaption

Sets caption text.

Specified by:

withCaption in interface Dialogs.HasCaption<Dialogs.BackgroundWorkDialogBuilder<T extends java.lang.Number,V>>

Parameters:

caption - caption text

Returns:

builder

getCaption

@Nullable
public java.lang.String getCaption()

Specified by:

getCaption in interface Dialogs.HasCaption<Dialogs.BackgroundWorkDialogBuilder<T extends java.lang.Number,V>>

Returns:

caption text

withMessage

public Dialogs.BackgroundWorkDialogBuilder<T,V> withMessage(java.lang.String message)

Description copied from interface: Dialogs.HasMessage

Sets message text.

Specified by:

withMessage in interface Dialogs.HasMessage<Dialogs.BackgroundWorkDialogBuilder<T extends java.lang.Number,V>>

Parameters:

message - message text

Returns:

builder

getMessage

public java.lang.String getMessage()

Specified by:

getMessage in interface Dialogs.HasMessage<Dialogs.BackgroundWorkDialogBuilder<T extends java.lang.Number,V>>

Returns:

message text

show

public BackgroundWorkDialog<T,V> show()

Description copied from interface: Dialogs.BackgroundWorkDialogBuilder

Shows the dialog.

Specified by:

show in interface Dialogs.BackgroundWorkDialogBuilder<T extends java.lang.Number,V>

Returns:

background work dialog

build

public BackgroundWorkDialog<T,V> build()

Description copied from interface: Dialogs.BackgroundWorkDialogBuilder

Builds the dialog.

Specified by:

build in interface Dialogs.BackgroundWorkDialogBuilder<T extends java.lang.Number,V>

Returns:

background work dialog