com.haulmont.bpm.gui.procactionsfragment

Class ProcActionsFragment

java.lang.Object

com.haulmont.cuba.gui.screen.ScreenFragment

com.haulmont.bpm.gui.procactionsfragment.ProcActionsFragment

All Implemented Interfaces:

com.haulmont.cuba.gui.screen.FrameOwner

@UiController(value="bpm_ProcActionsFragment")
 @UiDescriptor(value="proc-actions-fragment.xml")
public class ProcActionsFragment
extends com.haulmont.cuba.gui.screen.ScreenFragment

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

The fragment must be initialized with the ProcActionsFragment.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 fragment in two ways:

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ProcActionsFragment.Initializer Class is used to initialize the fragment.

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.AttachEvent, com.haulmont.cuba.gui.screen.ScreenFragment.DetachEvent, com.haulmont.cuba.gui.screen.ScreenFragment.InitEvent

Field Summary

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

Constructor Summary

Constructors

Constructor and Description
ProcActionsFragment()

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()
ProcActionsFragment.Initializer	initializer() Returns a new instance of fragment initializer

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

Constructor Detail

ProcActionsFragment

public ProcActionsFragment()

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 ProcActionsFragment.Initializer initializer()

Returns a new instance of fragment initializer

getProcInstance

public ProcInstance getProcInstance()