io.jmix.ui.app.backgroundwork

Class BackgroundWorkDialog<T extends java.lang.Number,V>

java.lang.Object

io.jmix.ui.screen.Screen

io.jmix.ui.app.backgroundwork.BackgroundWorkDialog<T,V>

Type Parameters:

T - measure unit which shows progress of task

V - result type

All Implemented Interfaces:

FrameOwner

@UiController(value="backgroundWorkProgressScreen")
 @UiDescriptor(value="background-work-dialog.xml")
 @DialogMode(forceDialog=true)
public class BackgroundWorkDialog<T extends java.lang.Number,V>
extends Screen

Dialog that indicates progress of the background task, shows progress bar and processed items' message.
Background task should have <T extends Number> as the progress measure unit. Progress measure passed to the publish() method is displayed in processed items'/percents' message. Total number of items should be specified before task execution.

On error:

• Executes handle exception in background task
• Closes background window
• Shows Warning message if for background task specified owner window

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.ui.screen.Screen

Screen.AfterCloseEvent, Screen.AfterDetachEvent, Screen.AfterInitEvent, Screen.AfterShowEvent, Screen.BeforeCloseEvent, Screen.BeforeShowEvent, Screen.InitEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected BackgroundWorker	backgroundWorker
protected boolean	cancelAllowed
protected Button	cancelButton
protected java.lang.String	message
protected io.jmix.core.Messages	messages
protected Label<java.lang.String>	progressText
protected boolean	showProgressInPercentage
protected BackgroundTask<T,V>	task
protected BackgroundTaskHandler<V>	taskHandler
protected ProgressBar	taskProgressBar
protected Label<java.lang.String>	text
protected java.lang.Number	total
protected T	totalProgress

Fields inherited from interface io.jmix.ui.screen.FrameOwner

NO_OPTIONS, WINDOW_CLOSE_ACTION, WINDOW_COMMIT_AND_CLOSE_ACTION, WINDOW_DISCARD_AND_CLOSE_ACTION

Constructor Summary

Constructors

Constructor and Description
BackgroundWorkDialog()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMessage()
BackgroundTask<T,V>	getTask()
java.lang.Number	getTotal()
boolean	isCancelAllowed()
boolean	isShowProgressInPercentage()
void	onAfterShow(Screen.AfterShowEvent event)
void	onBeforeClose(Screen.BeforeCloseEvent event)
void	onCancelButtonClick(Button.ClickEvent event)
void	setCancelAllowed(boolean cancelAllowed)
void	setMessage(java.lang.String message)
void	setShowProgressInPercentage(boolean showProgressInPercentage)
void	setTask(BackgroundTask<T,V> task)
void	setTotal(java.lang.Number total)
protected void	showProgress(java.lang.Number processedValue)

Methods inherited from class io.jmix.ui.screen.Screen

addAfterCloseListener, addAfterDetachListener, addAfterInitListener, addAfterShowListener, addBeforeCloseListener, addBeforeShowListener, addInitListener, addUrlParamsChangeListener, close, close, closeWithDefaultAction, fireEvent, getApplicationContext, getEventHub, getExtensions, getId, getScreenData, getUiEventListeners, getWindow, isMultipleOpen, isSameScreen, setApplicationContext, setExtensions, setId, setScreenData, setUiEventListeners, setWindow, show

Methods inherited from class java.lang.Object

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

Field Detail

backgroundWorker

@Autowired
protected BackgroundWorker backgroundWorker

messages

@Autowired
protected io.jmix.core.Messages messages

text

@Autowired
protected Label<java.lang.String> text

progressText

@Autowired
protected Label<java.lang.String> progressText

cancelButton

@Autowired
protected Button cancelButton

taskProgressBar

@Autowired
protected ProgressBar taskProgressBar

task

protected BackgroundTask<T extends java.lang.Number,V> task

cancelAllowed

protected boolean cancelAllowed

message

protected java.lang.String message

total

protected java.lang.Number total

showProgressInPercentage

protected boolean showProgressInPercentage

taskHandler

protected BackgroundTaskHandler<V> taskHandler

totalProgress

protected T extends java.lang.Number totalProgress

Constructor Detail

BackgroundWorkDialog

public BackgroundWorkDialog()

Method Detail

onAfterShow

@Subscribe
public void onAfterShow(Screen.AfterShowEvent event)

onBeforeClose

@Subscribe
public void onBeforeClose(Screen.BeforeCloseEvent event)

onCancelButtonClick

@Subscribe(value="cancelButton")
public void onCancelButtonClick(Button.ClickEvent event)

getTask

public BackgroundTask<T,V> getTask()

setTask

public void setTask(BackgroundTask<T,V> task)

isCancelAllowed

public boolean isCancelAllowed()

setCancelAllowed

public void setCancelAllowed(boolean cancelAllowed)

getMessage

public java.lang.String getMessage()

setMessage

public void setMessage(java.lang.String message)

isShowProgressInPercentage

public boolean isShowProgressInPercentage()

setShowProgressInPercentage

public void setShowProgressInPercentage(boolean showProgressInPercentage)

getTotal

public java.lang.Number getTotal()

setTotal

public void setTotal(java.lang.Number total)

showProgress

protected void showProgress(java.lang.Number processedValue)