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:
ProcDefinition
and entity reference using the ProcActionsFrame.Initializer.init(String, Entity)
methodProcInstance
object using the ProcActionsFrame.Initializer.init(ProcInstance)
methodProcActionsFrame.Initializer.init(String, Entity)
and ProcActionsFrame.Initializer.init(ProcInstance)
methods for detailsModifier and Type | Class and Description |
---|---|
class |
ProcActionsFrame.Initializer
Class is used to initialize the 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.UiEventListenersHolder, com.haulmont.cuba.gui.components.Frame.Wrapper
com.haulmont.cuba.gui.components.ExpandingLayout.ExpandDirection
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
Constructor and Description |
---|
ProcActionsFrame() |
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
|
add, add, addAction, addAction, addStyleName, dispose, 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
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getComponentNN
getComponentNN
setHeightAuto, setHeightFull, setSizeAuto, setSizeFull, setWidthAuto, setWidthFull
@Nullable public StartProcessAction getStartProcessAction()
public java.util.List<CompleteProcTaskAction> getCompleteProcTaskActions()
@Nullable public ClaimProcTaskAction getClaimProcTaskAction()
@Nullable public CancelProcessAction getCancelProcessAction()
public void addActionButton(com.haulmont.cuba.gui.components.Button button)
public ProcActionsFrame.Initializer initializer()
public ProcInstance getProcInstance()