com.haulmont.bpm.gui.procactions

Class ProcActionsFrame

java.lang.Object

com.haulmont.cuba.gui.screen.ScreenFragment

com.haulmont.cuba.gui.components.AbstractFrame

com.haulmont.bpm.gui.procactions.ProcActionsFrame

All Implemented Interfaces:

com.haulmont.cuba.gui.components.ActionsHolder, com.haulmont.cuba.gui.components.Component, com.haulmont.cuba.gui.components.Component.BelongToFrame, com.haulmont.cuba.gui.components.Component.HasCaption, com.haulmont.cuba.gui.components.Component.HasDescription, com.haulmont.cuba.gui.components.Component.HasIcon, com.haulmont.cuba.gui.components.Component.HasXmlDescriptor, com.haulmont.cuba.gui.components.Component.Wrapper, com.haulmont.cuba.gui.components.ComponentContainer, com.haulmont.cuba.gui.components.ExpandingLayout, com.haulmont.cuba.gui.components.Frame, com.haulmont.cuba.gui.components.Frame.Wrapper, com.haulmont.cuba.gui.components.HasMargin, com.haulmont.cuba.gui.components.HasSpacing, com.haulmont.cuba.gui.components.HasSubParts, com.haulmont.cuba.gui.components.HasWindowManager, com.haulmont.cuba.gui.components.OrderedContainer, com.haulmont.cuba.gui.components.SupportsExpandRatio, com.haulmont.cuba.gui.screen.compatibility.LegacyFrame, com.haulmont.cuba.gui.screen.FrameOwner

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 class com.haulmont.cuba.gui.screen.ScreenFragment

com.haulmont.cuba.gui.screen.ScreenFragment.AfterInitEvent, com.haulmont.cuba.gui.screen.ScreenFragment.InitEvent

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.Alignment, com.haulmont.cuba.gui.components.Component.BelongToFrame, com.haulmont.cuba.gui.components.Component.Disposable, com.haulmont.cuba.gui.components.Component.Editable, com.haulmont.cuba.gui.components.Component.Focusable, com.haulmont.cuba.gui.components.Component.HasCaption, com.haulmont.cuba.gui.components.Component.HasDescription, com.haulmont.cuba.gui.components.Component.HasIcon, com.haulmont.cuba.gui.components.Component.HasXmlDescriptor, com.haulmont.cuba.gui.components.Component.OptionsStyleProvider

Field Summary

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

NAME

Fields inherited from interface com.haulmont.cuba.gui.screen.FrameOwner

NO_OPTIONS, WINDOW_CLOSE_ACTION, WINDOW_COMMIT_AND_CLOSE_ACTION, WINDOW_DISCARD_AND_CLOSE_ACTION

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

Constructor Summary

Constructors

Constructor and Description
ProcActionsFrame()

Method Summary

Modifier and Type	Method and Description
void	addActionButton(com.haulmont.cuba.gui.components.Button button) Method adds a button to the end of the action buttons box.
CancelProcessAction	getCancelProcessAction()
ClaimProcTaskAction	getClaimProcTaskAction()
java.util.List<CompleteProcTaskAction>	getCompleteProcTaskActions()
ProcInstance	getProcInstance()
StartProcessAction	getStartProcessAction()
ProcActionsFrame.Initializer	initializer() Returns a new instance of frame initializer

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

add, add, addAction, addAction, addStyleName, dispose, expand, expand, getAction, getActions, getAlignment, getCaption, getCompanion, getComponent, getComponent, getComponent, getComponents, getComposition, getContext, getDescription, getDsContext, getExpandDirection, getExpandRatio, getFrame, getFrameOwner, getHeight, getHeightSizeUnit, getIcon, getMargin, getMessagesPack, getOwnComponent, getOwnComponents, getOwnComponentsStream, getParent, getSpacing, getStyleName, getWidth, getWidthSizeUnit, getWindowManager, getWrappedFrame, indexOf, init, isEnabled, isEnabledRecursive, isExpanded, isResponsive, isValid, isVisible, isVisibleRecursive, remove, removeAction, removeAction, removeAll, removeAllActions, removeStyleName, resetExpanded, setAlignment, setCaption, setCompanion, setDescription, setDsContext, setEnabled, setExpandRatio, setFrame, setHeight, setIcon, setIconFromSet, setId, setMargin, setMessagesPack, setParent, setResponsive, setSpacing, setStyleName, setVisible, setWidth, setWrappedFrame, showValidationErrors, unwrap, unwrapComposition, validate, validate, validateAll

Methods inherited from class com.haulmont.cuba.gui.screen.ScreenFragment

getFragment, getHostController, getId, init

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.haulmont.cuba.gui.screen.compatibility.LegacyFrame

getXmlDescriptor, setXmlDescriptor

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

getActionNN, getSubPart

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

setMargin, setMargin

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

getComponentNN

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

add, focusFirstComponent, getComponentNN, remove

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

getHeightUnits, getId, getWidthUnits, isEnabledItself, isVisibleItself, requestFocus, setHeightAuto, setHeightFull, setSizeAuto, setSizeFull, setWidthAuto, setWidthFull

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

Constructor Detail

ProcActionsFrame

public ProcActionsFrame()

Method Detail

getStartProcessAction

@Nullable
public StartProcessAction getStartProcessAction()

getCompleteProcTaskActions

public java.util.List<CompleteProcTaskAction> getCompleteProcTaskActions()

getClaimProcTaskAction

@Nullable
public ClaimProcTaskAction getClaimProcTaskAction()

getCancelProcessAction

@Nullable
public CancelProcessAction getCancelProcessAction()

addActionButton

public void addActionButton(com.haulmont.cuba.gui.components.Button button)

Method adds a button to the end of the action buttons box. The new button will be displayed below automatically generated action buttons

initializer

public ProcActionsFrame.Initializer initializer()

Returns a new instance of frame initializer

getProcInstance

public ProcInstance getProcInstance()