Package io.jmix.bpmflowui.uicomponent.bpmnmodeler

Class BpmnModelerImpl

java.lang.Object

com.vaadin.flow.component.Component

io.jmix.bpmflowui.uicomponent.bpmnmodeler.BpmnModelerImpl

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasComponents, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasStyle, BpmnModeler, Serializable

@Tag("jmix-bpmn-modeler")
@NpmPackage(value="bpmn-js",
            version="12.1.0")
@CssImport("bpmn-js/dist/assets/bpmn-font/css/bpmn-embedded.css") @CssImport("bpmn-js/dist/assets/bpmn-font/css/bpmn.css") @CssImport("bpmn-js/dist/assets/bpmn-font/css/bpmn-codes.css") @CssImport("bpmn-js/dist/assets/diagram-js.css")
@JsModule("./src/bpmn-modeler/bpmn-modeler.ts")
public class BpmnModelerImpl
extends com.vaadin.flow.component.Component
implements BpmnModeler

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	bpmnXml

Fields inherited from interface io.jmix.bpmflowui.uicomponent.bpmnmodeler.BpmnModeler

NAME

Constructor Summary

Constructors

Constructor	Description
BpmnModelerImpl()

Method Summary

Modifier and Type	Method	Description
void	addSchemaChangedListener(com.vaadin.flow.component.ComponentEventListener<XmlSchemaChangedEvent> listener)	Adds a listener to handle BPMN diagram schema changes.
void	addSelectedElementChangedListener(com.vaadin.flow.component.ComponentEventListener<SelectionChangedEvent> listener)	Adds a listener to handle BPMN diagram element selection changes.
void	createAndSetListProperty(CreateAndSetListPropertyCmd cmd)
void	createListener(CreateListenerCmd cmd)
void	createOrUpdateExtensionElement(CreateOrUpdateExtensionElementCmd cmd)
void	createOrUpdateExtensionProperty(CreateOrUpdateExtensionPropertyCmd cmd)
void	createOrUpdateFormData(CreateOrUpdateFormDataCmd cmd)
void	createOrUpdateNestedObject(CreateOrUpdateNestedObjectCmd cmd)
void	createOrUpdateParticipantProcessExtensionElement(CreateOrUpdateExtensionElementCmd cmd)
void	createOrUpdateProcessVariable(CreateOrUpdateProcessVariableCmd cmd)
void	createOrUpdateRootElement(CreateOrUpdateRootElementCmd cmd)
void	createOrUpdateSpringBean(CreateOrUpdateSpringBeanCmd cmd)
String	getBpmnXml()	Gets the current BPMN XML from the modeler component.
boolean	hasChanged()	Checks if changes have been made to the BPMN model.
void	removeExtensionElements(RemoveExtensionElementsCmd cmd)
void	removeExtensionProperty(RemoveExtensionPropertyCmd cmd)
void	removeParticipantProcessExtensionElements(RemoveExtensionElementsCmd cmd)
void	removeProcessVariable(RemoveProcessVariableCmd cmd)
void	removeRootElement(RemoveRootElementCmd cmd)
void	removeSpringBean(RemoveSpringBeanCmd cmd)
CompletableFuture<String>	requestForBpmnXml()	Asynchronously requests the current BPMN XML from the modeler component inm frontend client.
void	setBpmnXml(String bpmnXml)	Sets the BPMN XML for the modeler component.
void	setHasChanged(boolean hasChanged)	Sets the state of the modeler component changes Can be called for both java (server) code and from typescript (client)
void	setMultiInstanceFormalExpression(SetMultiInstanceFormalExpressionCmd cmd)
void	updateElementProperties(UpdateElementPropertiesCmd cmd)
void	updateEventDefinition(UpdateEventDefinitionCmd cmd)
void	updateEventDefinitionProperties(UpdateEventDefinitionPropertiesCmd cmd)
void	updateProcessDocumentation(UpdateProcessDocumentationCmd cmd)
void	updateTimerEventDefinition(UpdateTimerDefinitionCmd cmd)

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

addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

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 com.vaadin.flow.component.HasComponents

add, add, add, addComponentAsFirst, addComponentAtIndex, remove, remove, removeAll

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

getElement

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

isEnabled, setEnabled

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

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

Field Details

bpmnXml

protected String bpmnXml

Constructor Details

BpmnModelerImpl

public BpmnModelerImpl()

Method Details

addSelectedElementChangedListener

public void addSelectedElementChangedListener(com.vaadin.flow.component.ComponentEventListener<SelectionChangedEvent> listener)

Description copied from interface: BpmnModeler

Adds a listener to handle BPMN diagram element selection changes.

Specified by:

addSelectedElementChangedListener in interface BpmnModeler

Parameters:

listener - The listener to handle selection changes.

addSchemaChangedListener

public void addSchemaChangedListener(com.vaadin.flow.component.ComponentEventListener<XmlSchemaChangedEvent> listener)

Description copied from interface: BpmnModeler

Adds a listener to handle BPMN diagram schema changes.

Specified by:

addSchemaChangedListener in interface BpmnModeler

Parameters:

listener - The listener to handle schema changes.

setBpmnXml

public void setBpmnXml(String bpmnXml)

Description copied from interface: BpmnModeler

Sets the BPMN XML for the modeler component.

Specified by:

setBpmnXml in interface BpmnModeler

Parameters:

bpmnXml - The BPMN XML to be set.

getBpmnXml

public String getBpmnXml()

Description copied from interface: BpmnModeler

Gets the current BPMN XML from the modeler component. Retrieves data from the internal component state, not directly from the frontend component. Note that it may have outdated data.

For obtaining the most up-to-date BPMN XML, consider using BpmnModeler.requestForBpmnXml().

Specified by:

getBpmnXml in interface BpmnModeler

Returns:

The current BPMN XML.

See Also:

• BpmnModeler.requestForBpmnXml()

hasChanged

public boolean hasChanged()

Description copied from interface: BpmnModeler

Checks if changes have been made to the BPMN model. This method provides real-time information about whether changes have been made. The frontend component notifies the backend by invoking BpmnModeler#setHasChanged(true) every time the schema is updated.

Specified by:

hasChanged in interface BpmnModeler

Returns:

true if changes have been made, false otherwise.

setHasChanged

@ClientCallable
public void setHasChanged(boolean hasChanged)

Sets the state of the modeler component changes Can be called for both java (server) code and from typescript (client)

Specified by:

setHasChanged in interface BpmnModeler

Parameters:

hasChanged - flag for changes statement

See Also:

• Client Callable

requestForBpmnXml

public CompletableFuture<String> requestForBpmnXml()

Description copied from interface: BpmnModeler

Asynchronously requests the current BPMN XML from the modeler component inm frontend client.

Specified by:

requestForBpmnXml in interface BpmnModeler

Returns:

A CompletableFuture containing the current BPMN XML.

updateElementProperties

public void updateElementProperties(UpdateElementPropertiesCmd cmd)

Specified by:

updateElementProperties in interface BpmnModeler

createOrUpdateNestedObject

public void createOrUpdateNestedObject(CreateOrUpdateNestedObjectCmd cmd)

Specified by:

createOrUpdateNestedObject in interface BpmnModeler

createOrUpdateFormData

public void createOrUpdateFormData(CreateOrUpdateFormDataCmd cmd)

Specified by:

createOrUpdateFormData in interface BpmnModeler

createOrUpdateExtensionElement

public void createOrUpdateExtensionElement(CreateOrUpdateExtensionElementCmd cmd)

Specified by:

createOrUpdateExtensionElement in interface BpmnModeler

createOrUpdateRootElement

public void createOrUpdateRootElement(CreateOrUpdateRootElementCmd cmd)

Specified by:

createOrUpdateRootElement in interface BpmnModeler

removeRootElement

public void removeRootElement(RemoveRootElementCmd cmd)

Specified by:

removeRootElement in interface BpmnModeler

setMultiInstanceFormalExpression

public void setMultiInstanceFormalExpression(SetMultiInstanceFormalExpressionCmd cmd)

Specified by:

setMultiInstanceFormalExpression in interface BpmnModeler

updateTimerEventDefinition

public void updateTimerEventDefinition(UpdateTimerDefinitionCmd cmd)

Specified by:

updateTimerEventDefinition in interface BpmnModeler

updateEventDefinition

public void updateEventDefinition(UpdateEventDefinitionCmd cmd)

Specified by:

updateEventDefinition in interface BpmnModeler

updateEventDefinitionProperties

public void updateEventDefinitionProperties(UpdateEventDefinitionPropertiesCmd cmd)

Specified by:

updateEventDefinitionProperties in interface BpmnModeler

removeExtensionElements

public void removeExtensionElements(RemoveExtensionElementsCmd cmd)

Specified by:

removeExtensionElements in interface BpmnModeler

createOrUpdateSpringBean

public void createOrUpdateSpringBean(CreateOrUpdateSpringBeanCmd cmd)

Specified by:

createOrUpdateSpringBean in interface BpmnModeler

removeSpringBean

public void removeSpringBean(RemoveSpringBeanCmd cmd)

Specified by:

removeSpringBean in interface BpmnModeler

createOrUpdateProcessVariable

public void createOrUpdateProcessVariable(CreateOrUpdateProcessVariableCmd cmd)

Specified by:

createOrUpdateProcessVariable in interface BpmnModeler

createOrUpdateExtensionProperty

public void createOrUpdateExtensionProperty(CreateOrUpdateExtensionPropertyCmd cmd)

Specified by:

createOrUpdateExtensionProperty in interface BpmnModeler

removeExtensionProperty

public void removeExtensionProperty(RemoveExtensionPropertyCmd cmd)

Specified by:

removeExtensionProperty in interface BpmnModeler

removeProcessVariable

public void removeProcessVariable(RemoveProcessVariableCmd cmd)

Specified by:

removeProcessVariable in interface BpmnModeler

createAndSetListProperty

public void createAndSetListProperty(CreateAndSetListPropertyCmd cmd)

Specified by:

createAndSetListProperty in interface BpmnModeler

updateProcessDocumentation

public void updateProcessDocumentation(UpdateProcessDocumentationCmd cmd)

Specified by:

updateProcessDocumentation in interface BpmnModeler

createListener

public void createListener(CreateListenerCmd cmd)

Specified by:

createListener in interface BpmnModeler

removeParticipantProcessExtensionElements

public void removeParticipantProcessExtensionElements(RemoveExtensionElementsCmd cmd)

Specified by:

removeParticipantProcessExtensionElements in interface BpmnModeler

createOrUpdateParticipantProcessExtensionElement

public void createOrUpdateParticipantProcessExtensionElement(CreateOrUpdateExtensionElementCmd cmd)

Specified by:

createOrUpdateParticipantProcessExtensionElement in interface BpmnModeler