com.haulmont.cuba.gui.backgroundwork

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

java.lang.Object

com.haulmont.cuba.gui.components.AbstractFrame

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:

Component, Component.ActionsHolder, Component.BelongToFrame, Component.Container, Component.HasCaption, Component.HasIcon, Component.HasXmlDescriptor, Component.Margin, Component.OrderedContainer, Component.SecuredActionsHolder, Component.Spacing, Component.Wrapper, ExpandingLayout, Frame, Frame.Wrapper, Window, Window.Wrapper

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 interface com.haulmont.cuba.gui.components.Window

Window.BeforeCloseEvent, Window.BeforeCloseWithCloseButtonEvent, Window.BeforeCloseWithCloseButtonListener, Window.BeforeCloseWithShortcutEvent, Window.BeforeCloseWithShortcutListener, Window.CloseListener, Window.CloseWithCommitListener, Window.Committable, Window.ContentSwitchMode, Window.Editor, Window.HasFoldersPane, Window.HasUserIndicator, Window.HasWorkArea, Window.Lookup, Window.MainWindow, Window.TopLevelWindow, Window.Wrapper

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

Frame.MessageMode, Frame.MessageType, Frame.NotificationType, Frame.UiEventListenersHolder

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

ExpandingLayout.ExpandDirection

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

Component.ActionOwner, Component.ActionsHolder, Component.Alignment, Component.BelongToFrame, Component.Buffered, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.ContextHelpIconClickEvent, Component.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasContextHelp, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasOptionsStyleProvider, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, Component.OptionsStyleProvider, Component.OrderedContainer, Component.OuterMargin, Component.SecuredActionsHolder, Component.ShortcutAction, Component.ShortcutNotifier, Component.ShortcutTriggeredEvent, Component.Spacing, Component.UiPermissionAware, Component.Validatable, Component.ValueChangeEvent, Component.ValueChangeListener

Field Summary

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

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

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, UNITS_PERCENTAGE, UNITS_PIXELS

Constructor Summary

Constructors

Constructor and Description
BackgroundWorkProgressWindow()

Method Summary

Modifier and Type	Method and Description
void	cancel()
boolean	close(java.lang.String actionId) Close the screen.
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.
static <T extends java.lang.Number,V> void	show(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(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(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(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(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.

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

addBeforeCloseWithCloseButtonListener, addBeforeCloseWithShortcutListener, addCloseListener, addCloseWithCommitListener, addListener, addTimer, applySettings, close, closeAndRun, deleteSettings, getActionsPermissions, getCaption, getContentSwitchMode, getContext, getDescription, getDialogOptions, getDsContext, getFocusComponent, getIcon, getSettings, getTimer, getWindowManager, getWrappedWindow, getXmlDescriptor, isAttributeAccessControlEnabled, ready, removeBeforeCloseWithCloseButtonListener, removeBeforeCloseWithShortcutListener, removeCloseListener, removeCloseWithCommitListener, removeListener, saveSettings, setCaption, setContentSwitchMode, setDescription, setDsContext, setFocusComponent, setIcon, setIconFromSet, setWindowManager, setXmlDescriptor, validate, validateAll

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

add, add, addAction, addAction, addStyleName, dispose, expand, expand, getAction, getActions, getAlignment, getCompanion, getComponent, getComponent, getComponent, getComponents, getComposition, getDebugId, getDialogParams, getExpandDirection, getFrame, getHeight, getHeightUnits, getId, getMargin, getMessagesPack, getOwnComponent, getOwnComponents, getParent, getRegisteredComponent, getSpacing, getStyleName, getUiEventListeners, getWidth, getWidthUnits, getWrappedFrame, indexOf, isEnabled, isEnabledItself, isExpanded, isResponsive, isValid, isVisible, isVisibleItself, openEditor, openEditor, openEditor, openEditor, openEditor, openEditor, openEditor, openFrame, openFrame, openLookup, openLookup, openLookup, openLookup, openWindow, openWindow, registerComponent, remove, removeAction, removeAction, removeAll, removeAllActions, removeStyleName, requestFocus, resetExpanded, setAlignment, setCompanion, setContext, setDebugId, setEnabled, setFrame, setHeight, setId, setMargin, setMessagesPack, setParent, setResponsive, setSpacing, setStyleName, setUiEventListeners, setVisible, setWidth, setWrappedFrame, showMessageDialog, showNotification, showNotification, showNotification, showOptionDialog, showOptionDialog, showValidationErrors, showWebPage, unregisterComponent, unwrap, unwrapComposition, validate

Methods inherited from class java.lang.Object

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

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

getDialogParams, getMessagesPack, getRegisteredComponent, isValid, openEditor, openEditor, openEditor, openEditor, openEditor, openEditor, openEditor, openFrame, openFrame, openLookup, openLookup, openLookup, openLookup, openWindow, openWindow, registerComponent, setContext, setMessagesPack, showMessageDialog, showNotification, showNotification, showNotification, showOptionDialog, showOptionDialog, showWebPage, unregisterComponent, validate

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

expand, expand, getExpandDirection, isExpanded, resetExpanded

Methods inherited from interface com.haulmont.cuba.gui.components.Component.OrderedContainer

add, getComponent, getComponentNN, indexOf

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Container

add, getComponent, getComponentNN, getComponents, getOwnComponent, getOwnComponents, remove, removeAll

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

addStyleName, getAlignment, getDebugId, getHeight, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthUnits, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setDebugId, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Spacing

getSpacing, setSpacing

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Margin

getMargin, setMargin, setMargin, setMargin

Methods inherited from interface com.haulmont.cuba.gui.components.Component.ActionsHolder

addAction, addAction, getAction, getActionNN, getActions, removeAction, removeAction, removeAllActions

Constructor Detail

BackgroundWorkProgressWindow

public BackgroundWorkProgressWindow()

Method Detail

show

public static <T extends java.lang.Number,V> void show(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(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(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(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(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: AbstractFrame

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 AbstractFrame

Parameters:

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

cancel

public void cancel()

close

public boolean close(java.lang.String actionId)

Description copied from class: AbstractWindow

Close the screen.
If the screen has uncommitted changes in its DsContext, the confirmation dialog will be shown.
Don't override this method in subclasses, use hook AbstractWindow.preClose(String)

Specified by:

close in interface Window

Overrides:

close in class AbstractWindow

Parameters:

actionId - action ID that will be propagated to attached CloseListeners. Use Window.COMMIT_ACTION_ID if some changes have just been committed, or Window.CLOSE_ACTION_ID otherwise. These constants are recognized by various mechanisms of the framework.