Package io.jmix.bpmflowui.uicomponent.bpmnviewer

Class BpmnViewerImpl

java.lang.Object
com.vaadin.flow.component.Component
io.jmix.bpmflowui.uicomponent.bpmnviewer.BpmnViewerImpl
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasStyle, BpmnViewer, Serializable
@Tag("jmix-bpmn-viewer") @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-js.css") @CssImport("bpmn-js/dist/assets/diagram-js.css") @JsModule("./src/bpmn-modeler/bpmn-viewer.ts") public class BpmnViewerImpl extends com.vaadin.flow.component.Component implements BpmnViewer
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected String
    bpmnXml
     

    Fields inherited from interface io.jmix.bpmflowui.uicomponent.bpmnviewer.BpmnViewer

    NAME

  • Constructor Summary

    Constructors
    Constructor
    Description
    BpmnViewerImpl()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addMarker(AddMarkerCmd cmd)
    Adds a marker to a BPMN element using the specified command.
    void
    addSelectedElementChangedListener(com.vaadin.flow.component.ComponentEventListener<SelectionChangedEvent> listener)
    Adds a listener to handle BPMN diagram element selection changes.
    String
    getBpmnXmlFromState()
     
    void
    removeMarker(RemoveMarkerCmd cmd)
    Removes a marker from a BPMN element using the specified command.
    CompletableFuture<String>
    requestForBpmnXml()
     
    void
    setBpmnXml(String bpmnXml)
     
    void
    setBpmnXml(String bpmnXml, com.vaadin.flow.function.SerializableConsumer<elemental.json.JsonValue> callback)
    Sets the BPMN XML for the viewer component and invokes the callback after the BPMN XML is set.
    void
    setElementColor(SetElementColorCmd cmd)
    Sets the color of a BPMN element using the specified command.

    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.HasElement

    getElement

    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

    • BpmnViewerImpl

      public BpmnViewerImpl()

  • Method Details

    • setBpmnXml

      public void setBpmnXml(String bpmnXml)

    • getBpmnXmlFromState

      public String getBpmnXmlFromState()

    • requestForBpmnXml

      public CompletableFuture<String> requestForBpmnXml()

    • setBpmnXml

      public void setBpmnXml(String bpmnXml, com.vaadin.flow.function.SerializableConsumer<elemental.json.JsonValue> callback)
      Description copied from interface: BpmnViewer
      Sets the BPMN XML for the viewer component and invokes the callback after the BPMN XML is set.
      Specified by:
      setBpmnXml in interface BpmnViewer
      Parameters:
      bpmnXml - The BPMN XML to be set.
      callback - A callback to be invoked after the BPMN XML is set.

    • setElementColor

      public void setElementColor(SetElementColorCmd cmd)
      Description copied from interface: BpmnViewer
      Sets the color of a BPMN element using the specified command.

      Usage example: 

       bpmnViewer.setElementColor(new SetElementColorCmd(elementId,
    "#000", //stroke color
    "#c2d5ed" //fill color
 ));
      Specified by:
      setElementColor in interface BpmnViewer
      Parameters:
      cmd - The command to set the element color.

    • addMarker

      public void addMarker(AddMarkerCmd cmd)
      Description copied from interface: BpmnViewer
      Adds a marker to a BPMN element using the specified command.

      A style for the "highlighted" marker is already defined in the viewer component css file.

      Specified by:
      addMarker in interface BpmnViewer
      Parameters:
      cmd - The command to add a marker to an element.

    • removeMarker

      public void removeMarker(RemoveMarkerCmd cmd)
      Description copied from interface: BpmnViewer
      Removes a marker from a BPMN element using the specified command.
      Specified by:
      removeMarker in interface BpmnViewer
      Parameters:
      cmd - The command to remove a marker from an element.

    • addSelectedElementChangedListener

      public void addSelectedElementChangedListener(com.vaadin.flow.component.ComponentEventListener<SelectionChangedEvent> listener)
      Description copied from interface: BpmnViewer
      Adds a listener to handle BPMN diagram element selection changes.
      Specified by:
      addSelectedElementChangedListener in interface BpmnViewer
      Parameters:
      listener - The listener to handle selection changes.