com.haulmont.bpm.gui.procactions

Class ProcActionsFrame

java.lang.Object

com.haulmont.cuba.gui.components.AbstractFrame

com.haulmont.bpm.gui.procactions.ProcActionsFrame

All Implemented Interfaces:

com.haulmont.cuba.gui.components.Component, com.haulmont.cuba.gui.components.Component.ActionsHolder, com.haulmont.cuba.gui.components.Component.BelongToFrame, com.haulmont.cuba.gui.components.Component.Container, com.haulmont.cuba.gui.components.Component.HasCaption, com.haulmont.cuba.gui.components.Component.HasIcon, com.haulmont.cuba.gui.components.Component.Margin, com.haulmont.cuba.gui.components.Component.OrderedContainer, com.haulmont.cuba.gui.components.Component.Spacing, com.haulmont.cuba.gui.components.Component.Wrapper, com.haulmont.cuba.gui.components.ExpandingLayout, com.haulmont.cuba.gui.components.Frame, com.haulmont.cuba.gui.components.Frame.Wrapper

public class ProcActionsFrame
extends com.haulmont.cuba.gui.components.AbstractFrame

This frame is used for displaying process actions available for the current user. Depending of the process instance associated with the frame, the frame may display buttons that start the process, complete process actions or claim the process task.

The frame must be initialized with the ProcActionsFrame.Initializer instance. Use the initializer() method to get the instance of the initializer object. After setting all required listeners and predicates you can initialize the frame in two ways:

• With the code of ProcDefinition and entity reference using the ProcActionsFrame.Initializer.init(String, Entity) method
• With the ProcInstance object using the ProcActionsFrame.Initializer.init(ProcInstance) method

See the ProcActionsFrame.Initializer.init(String, Entity) and ProcActionsFrame.Initializer.init(ProcInstance) methods for details

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ProcActionsFrame.Initializer Class is used to initialize the frame.

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

com.haulmont.cuba.gui.components.Frame.MessageMode, com.haulmont.cuba.gui.components.Frame.MessageType, com.haulmont.cuba.gui.components.Frame.NotificationType, com.haulmont.cuba.gui.components.Frame.Wrapper

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

com.haulmont.cuba.gui.components.ExpandingLayout.ExpandDirection

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

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

Field Summary

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

NAME

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

Method Summary

Modifier and Type	Method and Description
ProcAction.AfterActionListener	getAfterCancelProcessListener() Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.
ProcAction.AfterActionListener	getAfterClaimTaskListener() Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.
ProcAction.AfterActionListener	getAfterCompleteTaskListener() Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.
ProcAction.AfterActionListener	getAfterStartProcessListener() Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.
ProcAction.BeforeActionPredicate	getBeforeCancelProcessPredicate() Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.
ProcAction.BeforeActionPredicate	getBeforeClaimTaskPredicate() Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.
ProcAction.BeforeActionPredicate	getBeforeCompleteTaskPredicate() Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.
ProcAction.BeforeActionPredicate	getBeforeStartProcessPredicate() Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.
java.lang.String	getButtonWidth() Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.
ProcInstance	getProcInstance()
void	init(ProcInstance procInstance) Deprecated. The method will be declared as protected in next platform releases. Use the ProcActionsFrame.Initializer to initialize the frame.
ProcActionsFrame.Initializer	initializer() Returns a new instance of frame initializer
boolean	isCancelProcessEnabled() Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.
boolean	isClaimTaskEnabled() Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.
boolean	isCompleteTaskEnabled() Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.
boolean	isStartProcessEnabled() Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.
boolean	isTaskInfoEnabled() Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.
void	setAfterCancelProcessListener(ProcAction.AfterActionListener listener) Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.
void	setAfterClaimTaskListener(ProcAction.AfterActionListener listener) Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.
void	setAfterCompleteTaskListener(ProcAction.AfterActionListener listener) Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.
void	setAfterStartProcessListener(ProcAction.AfterActionListener listener) Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.
void	setBeforeCancelProcessPredicate(ProcAction.BeforeActionPredicate predicate) Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.
void	setBeforeClaimTaskPredicate(ProcAction.BeforeActionPredicate predicate) Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.
void	setBeforeCompleteTaskPredicate(ProcAction.BeforeActionPredicate predicate) Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.
void	setBeforeStartProcessPredicate(ProcAction.BeforeActionPredicate predicate) Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.
void	setButtonWidth(java.lang.String buttonWidth) Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.
void	setCancelProcessEnabled(boolean cancelProcessEnabled) Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.
void	setClaimTaskEnabled(boolean claimTaskEnabled) Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.
void	setCompleteTaskEnabled(boolean completeTaskEnabled) Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.
void	setStartProcessEnabled(boolean startProcessEnabled) Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.
void	setTaskInfoEnabled(boolean taskInfoEnabled) Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.

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

add, add, addAction, addAction, addStyleName, expand, expand, getAction, getActions, getAlignment, getCaption, getCompanion, getComponent, getComponent, getComponent, getComponents, getComposition, getContext, getDebugId, getDescription, getDialogParams, getDsContext, getExpandDirection, getFrame, getHeight, getHeightUnits, getIcon, getId, getMargin, getMessagesPack, getOwnComponent, getOwnComponents, getParent, getRegisteredComponent, getSpacing, getStyleName, getUiEventListeners, getWidth, getWidthUnits, getWrappedFrame, indexOf, init, 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, setCaption, setCompanion, setContext, setDebugId, setDescription, setDsContext, setEnabled, setFrame, setHeight, setIcon, setIconFromSet, setId, setMargin, setMessagesPack, setParent, setResponsive, setSpacing, setStyleName, setUiEventListeners, setVisible, setWidth, setWrappedFrame, showMessageDialog, showNotification, showNotification, showNotification, showOptionDialog, showOptionDialog, showValidationErrors, showWebPage, unregisterComponent, unwrap, unwrapComposition, validate, validate, validateAll

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.Component.OrderedContainer

getComponentNN

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

getComponentNN

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

setHeightAuto, setHeightFull, setSizeAuto, setSizeFull, setWidthAuto, setWidthFull

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

setMargin, setMargin

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

getActionNN

Constructor Detail

ProcActionsFrame

public ProcActionsFrame()

Method Detail

init

@Deprecated
public void init(ProcInstance procInstance)

Deprecated. The method will be declared as protected in next platform releases. Use the ProcActionsFrame.Initializer to initialize the frame.

See Also:

ProcActionsFrame.Initializer.init(ProcInstance)

initializer

public ProcActionsFrame.Initializer initializer()

Returns a new instance of frame initializer

getProcInstance

public ProcInstance getProcInstance()

getAfterStartProcessListener

@Deprecated
public ProcAction.AfterActionListener getAfterStartProcessListener()

Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.

setAfterStartProcessListener

@Deprecated
public void setAfterStartProcessListener(ProcAction.AfterActionListener listener)

Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.

getAfterCompleteTaskListener

@Deprecated
public ProcAction.AfterActionListener getAfterCompleteTaskListener()

Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.

setAfterCompleteTaskListener

@Deprecated
public void setAfterCompleteTaskListener(ProcAction.AfterActionListener listener)

Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.

getBeforeStartProcessPredicate

@Deprecated
public ProcAction.BeforeActionPredicate getBeforeStartProcessPredicate()

Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.

setBeforeStartProcessPredicate

@Deprecated
public void setBeforeStartProcessPredicate(ProcAction.BeforeActionPredicate predicate)

Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.

getAfterClaimTaskListener

@Deprecated
public ProcAction.AfterActionListener getAfterClaimTaskListener()

Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.

setAfterClaimTaskListener

@Deprecated
public void setAfterClaimTaskListener(ProcAction.AfterActionListener listener)

Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.

getAfterCancelProcessListener

@Deprecated
public ProcAction.AfterActionListener getAfterCancelProcessListener()

Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.

setAfterCancelProcessListener

@Deprecated
public void setAfterCancelProcessListener(ProcAction.AfterActionListener listener)

Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.

getBeforeCompleteTaskPredicate

@Deprecated
public ProcAction.BeforeActionPredicate getBeforeCompleteTaskPredicate()

Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.

setBeforeCompleteTaskPredicate

@Deprecated
public void setBeforeCompleteTaskPredicate(ProcAction.BeforeActionPredicate predicate)

Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.

getBeforeClaimTaskPredicate

@Deprecated
public ProcAction.BeforeActionPredicate getBeforeClaimTaskPredicate()

Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.

setBeforeClaimTaskPredicate

@Deprecated
public void setBeforeClaimTaskPredicate(ProcAction.BeforeActionPredicate predicate)

Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.

getBeforeCancelProcessPredicate

@Deprecated
public ProcAction.BeforeActionPredicate getBeforeCancelProcessPredicate()

Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.

setBeforeCancelProcessPredicate

@Deprecated
public void setBeforeCancelProcessPredicate(ProcAction.BeforeActionPredicate predicate)

Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.

isStartProcessEnabled

@Deprecated
public boolean isStartProcessEnabled()

Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.

setStartProcessEnabled

@Deprecated
public void setStartProcessEnabled(boolean startProcessEnabled)

Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.

isCancelProcessEnabled

@Deprecated
public boolean isCancelProcessEnabled()

Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.

setCancelProcessEnabled

@Deprecated
public void setCancelProcessEnabled(boolean cancelProcessEnabled)

Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.

isCompleteTaskEnabled

@Deprecated
public boolean isCompleteTaskEnabled()

Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.

setCompleteTaskEnabled

@Deprecated
public void setCompleteTaskEnabled(boolean completeTaskEnabled)

Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.

isClaimTaskEnabled

@Deprecated
public boolean isClaimTaskEnabled()

Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.

setClaimTaskEnabled

@Deprecated
public void setClaimTaskEnabled(boolean claimTaskEnabled)

Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.

isTaskInfoEnabled

@Deprecated
public boolean isTaskInfoEnabled()

Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.

setTaskInfoEnabled

@Deprecated
public void setTaskInfoEnabled(boolean taskInfoEnabled)

Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.

getButtonWidth

@Deprecated
public java.lang.String getButtonWidth()

Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.

setButtonWidth

@Deprecated
public void setButtonWidth(java.lang.String buttonWidth)

Deprecated. Initialize the frame with the ProcActionsFrame.Initializer that can be obtained by the initializer() method.