Package io.jmix.bpmflowui.view.modeler.properties.asyncexecution

Class AsyncExecutionPropertiesFragment

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.Composite<JmixFormLayout>

io.jmix.flowui.fragment.Fragment<JmixFormLayout>

io.jmix.bpmflowui.view.modeler.properties.asyncexecution.AsyncExecutionPropertiesFragment

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasStyle, FacetOwner, FragmentOwner, Serializable

public class AsyncExecutionPropertiesFragment
extends Fragment<JmixFormLayout>

Reusable checkbox group for the four Flowable asynchronous-execution flags. Renders only the fields; the host decides how to frame them (e.g. wraps the fragment in its own section). The host calls setModeler(BpmnModeler) then setParentElement(HasAsyncExecution), and (optionally) observes whether the element produces an async job via addAsyncJobStateChangeListener(Consumer).

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.flowui.fragment.Fragment

Fragment.ReadyEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected InstanceContainer<AsyncExecutionModel>	asyncExecutionDc
protected @Nullable Consumer<Boolean>	asyncJobStateListener
protected JmixCheckbox	asyncLeaveCheckBox
protected JmixCheckbox	asyncLeaveExclusiveCheckBox
protected JmixCheckbox	exclusiveCheckBox
protected @Nullable BpmnModeler	modeler
protected @Nullable HasAsyncExecution	parentElement

Fields inherited from class io.jmix.flowui.fragment.Fragment

fragmentActions, fragmentData, fragmentFacets, parentController, uiComponents

Constructor Summary

Constructors

Constructor	Description
AsyncExecutionPropertiesFragment()

Method Summary

Modifier and Type	Method	Description
void	addAsyncJobStateChangeListener(Consumer<Boolean> listener)	Registers a listener notified when the element's async-job state changes — that is, when async or asyncLeave toggles.
protected void	onAsyncExecutionDcItemPropertyChange(InstanceContainer.ItemPropertyChangeEvent<AsyncExecutionModel> event)
protected void	pushToModeler(AsyncExecutionModel model)
void	setAsyncLeaveSupported(boolean supported)	Controls whether the "asynchronous leave" pair (asyncLeave and asyncLeaveExclusive) is shown.
void	setModeler(@Nullable BpmnModeler modeler)
void	setParentElement(HasAsyncExecution parentElement)	Binds the section to the given element and initializes the checkbox states.

Methods inherited from class io.jmix.flowui.fragment.Fragment

addReadyListener, findInnerComponent, getFragmentActions, getFragmentData, getFragmentFacets, getInnerComponent, getParentController, initContent, onAttach, onDetach, setFragmentActions, setFragmentData, setFragmentFacets, setParentController, setUiComponents

Methods inherited from class com.vaadin.flow.component.Composite

getChildren, getContent, getElement

Methods inherited from class com.vaadin.flow.component.Component

addListener, bindVisible, findAncestor, fireEvent, from, get, getEventBus, getId, getListeners, getLocale, getParent, getTestId, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setTestId, setVisible, whenAttached

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface io.jmix.flowui.facet.FacetOwner

getId

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, bindClassName, bindClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Field Details

asyncExecutionDc

@ViewComponent
protected InstanceContainer<AsyncExecutionModel> asyncExecutionDc

exclusiveCheckBox

@ViewComponent
protected JmixCheckbox exclusiveCheckBox

asyncLeaveCheckBox

@ViewComponent
protected JmixCheckbox asyncLeaveCheckBox

asyncLeaveExclusiveCheckBox

@ViewComponent
protected JmixCheckbox asyncLeaveExclusiveCheckBox

modeler

protected @Nullable BpmnModeler modeler

parentElement

protected @Nullable HasAsyncExecution parentElement

asyncJobStateListener

protected @Nullable Consumer<Boolean> asyncJobStateListener

Constructor Details

AsyncExecutionPropertiesFragment

public AsyncExecutionPropertiesFragment()

Method Details

setModeler

public void setModeler(@Nullable BpmnModeler modeler)

setAsyncLeaveSupported

public void setAsyncLeaveSupported(boolean supported)

Controls whether the "asynchronous leave" pair (asyncLeave and asyncLeaveExclusive) is shown. It is hidden for end-position nodes that have no outgoing sequence flow, where an asynchronous leave is meaningless. Enabled by default.

Parameters:

supported - whether the element can have an asynchronous leave

setParentElement

public void setParentElement(HasAsyncExecution parentElement)

Binds the section to the given element and initializes the checkbox states.

Parameters:

parentElement - the BPMN element model whose async flags are edited

addAsyncJobStateChangeListener

public void addAsyncJobStateChangeListener(Consumer<Boolean> listener)

Registers a listener notified when the element's async-job state changes — that is, when async or asyncLeave toggles. The value is whether the element now produces an async job (async || asyncLeave). Used by hosts with job-dependent UI, e.g. the service task retry-cycle field.

Parameters:

listener - receives whether the element now produces an async job

onAsyncExecutionDcItemPropertyChange

@Subscribe(id="asyncExecutionDc",
           target=DATA_CONTAINER)
protected void onAsyncExecutionDcItemPropertyChange(InstanceContainer.ItemPropertyChangeEvent<AsyncExecutionModel> event)

pushToModeler

protected void pushToModeler(AsyncExecutionModel model)