com.haulmont.cuba.gui.backgroundwork

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

java.lang.Object

io.jmix.ui.screen.Screen

com.haulmont.cuba.gui.components.AbstractWindow

com.haulmont.cuba.gui.backgroundwork.BackgroundWorkProgressWindow<T,V>

Type Parameters:

T - measure unit which shows progress of task

V - result type

All Implemented Interfaces:

Frame.Wrapper, HasWindowManager, Window.Wrapper, LegacyFrame, CubaLegacySettings, io.jmix.ui.component.ActionsHolder, io.jmix.ui.component.Component, io.jmix.ui.component.Component.BelongToFrame, io.jmix.ui.component.Component.HasCaption, io.jmix.ui.component.Component.HasDescription, io.jmix.ui.component.Component.HasIcon, io.jmix.ui.component.Component.HasXmlDescriptor, io.jmix.ui.component.Component.Wrapper, io.jmix.ui.component.ComponentContainer, io.jmix.ui.component.ExpandingLayout, io.jmix.ui.component.Frame, io.jmix.ui.component.HasComponents, io.jmix.ui.component.HasMargin, io.jmix.ui.component.HasSpacing, io.jmix.ui.component.HasSubParts, io.jmix.ui.component.OrderedContainer, io.jmix.ui.component.SecuredActionsHolder, io.jmix.ui.component.SupportsExpandRatio, io.jmix.ui.component.Window, io.jmix.ui.screen.ChangeTracker, io.jmix.ui.screen.FrameOwner

public class BackgroundWorkProgressWindow<T extends java.lang.Number,V>
extends AbstractWindow

Window 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

io.jmix.ui.screen.Screen.AfterCloseEvent, io.jmix.ui.screen.Screen.AfterDetachEvent, io.jmix.ui.screen.Screen.AfterInitEvent, io.jmix.ui.screen.Screen.AfterShowEvent, io.jmix.ui.screen.Screen.BeforeCloseEvent, io.jmix.ui.screen.Screen.BeforeShowEvent, io.jmix.ui.screen.Screen.InitEvent

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Window

Window.BeforeCloseWithCloseButtonEvent, Window.BeforeCloseWithShortcutEvent, Window.CloseListener, Window.CloseWithCommitListener, Window.Editor<T>, Window.HasFoldersPane, Window.Lookup<T>, Window.TopLevelWindow, Window.Wrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.Window

io.jmix.ui.component.Window.BeforeCloseEvent, io.jmix.ui.component.Window.CloseOrigin, io.jmix.ui.component.Window.Committable, io.jmix.ui.component.Window.ContentSwitchMode, io.jmix.ui.component.Window.HasUserIndicator, io.jmix.ui.component.Window.HasWorkArea

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Frame

Frame.MessageMode, Frame.MessageType, Frame.NotificationType

Nested classes/interfaces inherited from interface io.jmix.ui.component.ExpandingLayout

io.jmix.ui.component.ExpandingLayout.ExpandDirection

Field Summary

Fields

Modifier and Type	Field and Description
protected io.jmix.ui.executor.BackgroundWorker	backgroundWorker
protected boolean	cancelAllowed
protected io.jmix.ui.component.Button	cancelButton
protected io.jmix.core.Messages	messages
protected boolean	percentProgress
protected Label<java.lang.String>	progressText
protected io.jmix.ui.executor.BackgroundTaskHandler<V>	taskHandler
protected io.jmix.ui.component.ProgressBar	taskProgressBar
protected Label<java.lang.String>	text
protected T	totalProgress

Fields inherited from class com.haulmont.cuba.gui.components.AbstractWindow

frame, messageTools, UNKNOWN_CLOSE_ACTION_ID

Fields inherited from interface io.jmix.ui.component.Window

BROWSE_WINDOW_SUFFIX, CLOSE_ACTION_ID, COMMIT_ACTION_ID, CREATE_WINDOW_SUFFIX, EDITOR_WINDOW_SUFFIX, LOOKUP_WINDOW_SUFFIX, SELECT_ACTION_ID

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
BackgroundWorkProgressWindow()

Method Summary

Modifier and Type	Method and Description
void	cancel()
void	init(java.util.Map<java.lang.String,java.lang.Object> params) Called by the framework after creation of all components and before showing the screen.
protected boolean	preClose(java.lang.String actionId) Hook to be implemented in subclasses.
static <T extends java.lang.Number,V> void	show(io.jmix.ui.executor.BackgroundTask<T,V> task, java.lang.Number total) Show modal window with default title and message which will last until task completes.
static <T extends java.lang.Number,V> void	show(io.jmix.ui.executor.BackgroundTask<T,V> task, java.lang.Number total, boolean cancelAllowed) Show modal window with default title and message which will last until task completes.
static <T extends java.lang.Number,V> void	show(io.jmix.ui.executor.BackgroundTask<T,V> task, java.lang.String title, java.lang.String message, java.lang.Number total) Show modal window with message which will last until task completes.
static <T extends java.lang.Number,V> void	show(io.jmix.ui.executor.BackgroundTask<T,V> task, java.lang.String title, java.lang.String message, java.lang.Number total, boolean cancelAllowed) Show modal window with message which will last until task completes.
static <T extends java.lang.Number,V> void	show(io.jmix.ui.executor.BackgroundTask<T,V> task, java.lang.String title, java.lang.String message, java.lang.Number total, boolean cancelAllowed, boolean percentProgress) Show modal window with message which will last until task completes.
protected void	showProgress(java.lang.Number processedValue)

Methods inherited from class com.haulmont.cuba.gui.components.AbstractWindow

add, add, addAction, addAction, addBeforeWindowCloseListener, addFacet, addStyleName, afterShow, applyDataLoadingSettings, applySettings, beforeClose, closeWithDiscard, deleteSettings, expand, expand, formatMessage, getAction, getActions, getActionsPermissions, getAlignment, getCaption, getCompanion, getComponent, getComponent, getComponent, getComponents, getComposition, getContentSwitchMode, getContext, getDescription, getDialogOptions, getDsContext, getExpandDirection, getExpandRatio, getFacet, getFacets, getFocusComponent, getFrame, getFrameOwner, getHeight, getHeightSizeUnit, getIcon, getMargin, getMaxHeight, getMaxWidth, getMessage, getMessagesPack, getMinHeight, getMinWidth, getOwnComponent, getOwnComponents, getOwnComponentsStream, getParent, getScreenHashCode, getSettings, getSpacing, getStyleName, getWidth, getWidthSizeUnit, getWindowManager, getWrappedFrame, getWrappedWindow, getXmlDescriptor, handleValidationErrors, hasUnsavedChanges, indexOf, init, initEnableEditingActionStub, isAttributeAccessControlEnabled, isCloseable, isEnabled, isEnabledRecursive, isExpanded, isResponsive, isSameScreen, isValid, isVisible, isVisibleRecursive, onAfterDetach, postValidate, ready, remove, removeAction, removeAction, removeAll, removeAllActions, removeBeforeWindowCloseListener, removeFacet, removeStyleName, resetExpanded, saveSettings, setAlignment, setCaption, setCloseable, setCompanion, setContentSwitchMode, setDescription, setDsContext, setEnabled, setExpandRatio, setFocusComponent, setFrame, setHeight, setIcon, setIconFromSet, setId, setMargin, setMaxHeight, setMaxWidth, setMessagesPack, setMinHeight, setMinWidth, setParent, setResponsive, setSpacing, setStyleName, setVisible, setWidth, setWindow, setXmlDescriptor, showValidationErrors, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, validate, validate, validateAdditionalRules, validateAll, withUnwrapped, withUnwrappedComposition

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, setApplicationContext, setExtensions, setScreenData, setUiEventListeners, show

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.haulmont.cuba.gui.components.Window

addBeforeCloseWithCloseButtonListener, addBeforeCloseWithShortcutListener, addCloseListener, addCloseWithCommitListener, addListener, close, close, removeBeforeCloseWithCloseButtonListener, removeBeforeCloseWithShortcutListener, removeCloseListener, removeListener

Methods inherited from interface io.jmix.ui.component.Frame

getFacetNN

Methods inherited from interface io.jmix.ui.component.OrderedContainer

getComponentNN

Methods inherited from interface io.jmix.ui.component.HasMargin

setMargin, setMargin

Methods inherited from interface io.jmix.ui.component.ActionsHolder

getActionNN, getSubPart

Methods inherited from interface io.jmix.ui.component.ComponentContainer

add, remove

Methods inherited from interface io.jmix.ui.component.HasComponents

focusFirstComponent, getComponentNN

Methods inherited from interface com.haulmont.cuba.gui.components.HasWindowManager

openEditor, openEditor, openEditor, openEditor, openEditor, openEditor, openEditor, openFrame, openFrame, openLookup, openLookup, openLookup, openLookup, openWindow, openWindow, showMessageDialog, showNotification, showNotification, showNotification, showOptionDialog, showOptionDialog, showWebPage

Field Detail

text

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

progressText

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

cancelButton

@Autowired
protected io.jmix.ui.component.Button cancelButton

taskProgressBar

@Autowired
protected io.jmix.ui.component.ProgressBar taskProgressBar

backgroundWorker

@Autowired
protected io.jmix.ui.executor.BackgroundWorker backgroundWorker

messages

@Autowired
protected io.jmix.core.Messages messages

taskHandler

protected io.jmix.ui.executor.BackgroundTaskHandler<V> taskHandler

cancelAllowed

protected boolean cancelAllowed

totalProgress

protected T extends java.lang.Number totalProgress

percentProgress

protected boolean percentProgress

Constructor Detail

BackgroundWorkProgressWindow

public BackgroundWorkProgressWindow()

Method Detail

show

public static <T extends java.lang.Number,V> void show(io.jmix.ui.executor.BackgroundTask<T,V> task,
                                                       @Nullable
                                                       java.lang.String title,
                                                       @Nullable
                                                       java.lang.String message,
                                                       java.lang.Number total,
                                                       boolean cancelAllowed,
                                                       boolean percentProgress)

Show modal window with message which will last until task completes. Optionally cancel button can be displayed. By pressing cancel button user can cancel task execution.

Type Parameters:

V - task result type

Parameters:

task - background task containing long operation

title - window title, optional

message - window message, optional

total - total number of items, that will be processed

cancelAllowed - show or not cancel button

percentProgress - show progress in percents

show

public static <T extends java.lang.Number,V> void show(io.jmix.ui.executor.BackgroundTask<T,V> task,
                                                       @Nullable
                                                       java.lang.String title,
                                                       @Nullable
                                                       java.lang.String message,
                                                       java.lang.Number total,
                                                       boolean cancelAllowed)

Show modal window with message which will last until task completes. Optionally cancel button can be displayed. By pressing cancel button user can cancel task execution.

Type Parameters:

V - task result type

Parameters:

task - background task containing long operation

title - window title, optional

message - window message, optional

total - total number of items, that will be processed

cancelAllowed - show or not cancel button

show

public static <T extends java.lang.Number,V> void show(io.jmix.ui.executor.BackgroundTask<T,V> task,
                                                       java.lang.String title,
                                                       java.lang.String message,
                                                       java.lang.Number total)

Show modal window with message which will last until task completes. Cancel button is not shown.

Type Parameters:

V - task result type

Parameters:

task - background task containing long operation

title - window title, optional

message - window message, optional

total - total number of items, that will be processed

show

public static <T extends java.lang.Number,V> void show(io.jmix.ui.executor.BackgroundTask<T,V> task,
                                                       java.lang.Number total,
                                                       boolean cancelAllowed)

Show modal window with default title and message which will last until task completes. Cancel button is not shown.

Type Parameters:

V - task result type

Parameters:

task - background task containing long operation

total - total number of items, that will be processed

cancelAllowed - show or not cancel button

show

public static <T extends java.lang.Number,V> void show(io.jmix.ui.executor.BackgroundTask<T,V> task,
                                                       java.lang.Number total)

Show modal window with default title and message which will last until task completes. Cancel button is not shown.

Type Parameters:

V - task result type

Parameters:

task - background task containing long operation

total - total number of items, that will be processed

init

public void init(java.util.Map<java.lang.String,java.lang.Object> params)

Description copied from class: AbstractWindow

Called by the framework after creation of all components and before showing the screen.
Override this method and put initialization logic here.

Overrides:

init in class AbstractWindow

Parameters:

params - parameters passed from caller's code, usually from HasWindowManager.openWindow(String, WindowManager.OpenType) and similar methods, or set in screens.xml for this registered screen

cancel

public void cancel()

preClose

protected boolean preClose(java.lang.String actionId)

Description copied from class: AbstractWindow

Hook to be implemented in subclasses. Called by the framework before closing the screen.

Overrides:

preClose in class AbstractWindow

Parameters:

actionId - a string that is passed to one of Screen.close(io.jmix.ui.screen.CloseAction) methods by calling code to identify itself. Can be an Action ID, or a constant like Window.COMMIT_ACTION_ID or Window.CLOSE_ACTION_ID.

Returns:

true to proceed with closing, false to interrupt and leave the screen open

showProgress

protected void showProgress(java.lang.Number processedValue)