Package io.jmix.bpmflowui.uicomponent.bpmnmodeler

Interface BpmnModeler

All Superinterfaces:
com.vaadin.flow.component.HasComponents, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, Serializable
All Known Implementing Classes:
BpmnModelerImpl
public interface BpmnModeler extends com.vaadin.flow.component.HasComponents
Interface for a BPMN modeler component that allows modeling and interaction with BPMN diagrams. This interface extends HasComponents to integrate with Vaadin Flow.

  • Field Details

  • Method Details

    • addSelectedElementChangedListener

      void addSelectedElementChangedListener(com.vaadin.flow.component.ComponentEventListener<SelectionChangedEvent> listener)
      Adds a listener to handle BPMN diagram element selection changes.
      Parameters:
      listener - The listener to handle selection changes.

    • addSchemaChangedListener

      void addSchemaChangedListener(com.vaadin.flow.component.ComponentEventListener<XmlSchemaChangedEvent> listener)
      Adds a listener to handle BPMN diagram schema changes.
      Parameters:
      listener - The listener to handle schema changes.

    • setBpmnXml

      void setBpmnXml(String bpmnXml)
      Sets the BPMN XML for the modeler component.
      Parameters:
      bpmnXml - The BPMN XML to be set.

    • getBpmnXml

      String getBpmnXml()
      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 requestForBpmnXml().

      Returns:
      The current BPMN XML.
      See Also:

    • hasChanged

      boolean hasChanged()
      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.
      Returns:
      true if changes have been made, false otherwise.

    • setHasChanged

      void setHasChanged(boolean hasChanges)
      Sets the flag indicating whether changes have been made to the BPMN model. This method can be invoked by the frontend (client code) if the XML schema has changed.
      Parameters:
      hasChanges - true if changes have been made, false otherwise.

    • requestForBpmnXml

      CompletableFuture<String> requestForBpmnXml()
      Asynchronously requests the current BPMN XML from the modeler component inm frontend client.
      Returns:
      A CompletableFuture containing the current BPMN XML.

    • updateElementProperties

      void updateElementProperties(UpdateElementPropertiesCmd updateElementPropertiesCmd)

    • createOrUpdateNestedObject

      void createOrUpdateNestedObject(CreateOrUpdateNestedObjectCmd createOrUpdateNestedObjectCmd)

    • createOrUpdateFormData

      void createOrUpdateFormData(CreateOrUpdateFormDataCmd createOrUpdateFormDataCmd)

    • createOrUpdateExtensionElement

      void createOrUpdateExtensionElement(CreateOrUpdateExtensionElementCmd createOrUpdateExtensionElementCmd)

    • setMultiInstanceFormalExpression

      void setMultiInstanceFormalExpression(SetMultiInstanceFormalExpressionCmd cmd)

    • updateTimerEventDefinition

      void updateTimerEventDefinition(UpdateTimerDefinitionCmd cmd)

    • updateEventDefinition

      void updateEventDefinition(UpdateEventDefinitionCmd cmd)

    • updateEventDefinitionProperties

      void updateEventDefinitionProperties(UpdateEventDefinitionPropertiesCmd cmd)

    • createOrUpdateRootElement

      void createOrUpdateRootElement(CreateOrUpdateRootElementCmd createOrUpdateRootElementCmd)

    • removeRootElement

      void removeRootElement(RemoveRootElementCmd removeRootElementCmd)

    • createOrUpdateSpringBean

      void createOrUpdateSpringBean(CreateOrUpdateSpringBeanCmd cmd)

    • removeSpringBean

      void removeSpringBean(RemoveSpringBeanCmd cmd)

    • createOrUpdateProcessVariable

      void createOrUpdateProcessVariable(CreateOrUpdateProcessVariableCmd cmd)

    • createOrUpdateExtensionProperty

      void createOrUpdateExtensionProperty(CreateOrUpdateExtensionPropertyCmd cmd)

    • removeExtensionProperty

      void removeExtensionProperty(RemoveExtensionPropertyCmd cmd)

    • createAndSetListProperty

      void createAndSetListProperty(CreateAndSetListPropertyCmd cmd)

    • removeProcessVariable

      void removeProcessVariable(RemoveProcessVariableCmd cmd)

    • updateProcessDocumentation

      void updateProcessDocumentation(UpdateProcessDocumentationCmd cmd)

    • removeExtensionElements

      void removeExtensionElements(RemoveExtensionElementsCmd cmd)

    • createListener

      void createListener(CreateListenerCmd cmd)

    • removeParticipantProcessExtensionElements

      void removeParticipantProcessExtensionElements(RemoveExtensionElementsCmd cmd)

    • createOrUpdateParticipantProcessExtensionElement

      void createOrUpdateParticipantProcessExtensionElement(CreateOrUpdateExtensionElementCmd cmd)