Package io.jmix.ui.sys

Class DialogsImpl.BackgroundWorkDialogBuilderImpl<T extends 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 Number,V>
extends Object
implements Dialogs.BackgroundWorkDialogBuilder<T,V>

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

backgroundWorkDialog

protected BackgroundWorkDialog<T extends Number,V> backgroundWorkDialog

Constructor Details

BackgroundWorkDialogBuilderImpl

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

Method Details

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 Number,V>

Parameters:

cancelAllowed - true if dialog is closeable

Returns:

builder

isCancelAllowed

public boolean isCancelAllowed()

Specified by:

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

Returns:

true if the dialog can be closed

withTotal

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

Specified by:

withTotal in interface Dialogs.BackgroundWorkDialogBuilder<T extends 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 Number getTotal()

Specified by:

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

Returns:

total

withShowProgressInPercentage

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

Specified by:

withShowProgressInPercentage in interface Dialogs.BackgroundWorkDialogBuilder<T extends 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 Number,V>

Returns:

true if progress should is shown in percents

withCaption

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

Description copied from interface: Dialogs.HasCaption

Sets caption text.

Specified by:

withCaption in interface Dialogs.HasCaption<T extends Number>

Parameters:

caption - caption text

Returns:

builder

getCaption

@Nullable
public String getCaption()

Specified by:

getCaption in interface Dialogs.HasCaption<T extends Number>

Returns:

caption text

withMessage

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

Description copied from interface: Dialogs.HasMessage

Sets message text.

Specified by:

withMessage in interface Dialogs.HasMessage<T extends Number>

Parameters:

message - message text

Returns:

builder

getMessage

public String getMessage()

Specified by:

getMessage in interface Dialogs.HasMessage<T extends Number>

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 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 Number,V>

Returns:

background work dialog