Package io.jmix.bpmflowui.uicomponent.bpmnviewer

Interface BpmnViewer

All Superinterfaces:
com.vaadin.flow.component.HasElement, Serializable
All Known Implementing Classes:
BpmnViewerImpl
public interface BpmnViewer extends com.vaadin.flow.component.HasElement

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    NAME
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addMarker(AddMarkerCmd addMarkerCmd)
    Adds a marker to an element (basically a css class).
    void
    removeMarker(RemoveMarkerCmd removeMarkerCmd)
    Removes a marker (css class) from an element.
    void
    setBpmnXml(String bpmnXml, com.vaadin.flow.function.SerializableConsumer<elemental.json.JsonValue> callback)
    The callback will be called after the BPMN XML was actually set to the component.
    void
    setElementColor(SetElementColorCmd cmd)
    Sets an element color.

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

    getElement

  • Field Details

  • Method Details

    • setBpmnXml

      void setBpmnXml(String bpmnXml, com.vaadin.flow.function.SerializableConsumer<elemental.json.JsonValue> callback)
      The callback will be called after the BPMN XML was actually set to the component. Invoke the setElementColor(io.jmix.bpmflowui.uicomponent.bpmnviewer.command.SetElementColorCmd) in the callback

    • setElementColor

      void setElementColor(SetElementColorCmd cmd)
      Sets an element color.

      Usage example: 

       bpmnViewer.setElementColor(new SetElementColorCmd(elementId,
    "#000", //stroke color
    "#c2d5ed" //fill color
 ));

    • addMarker

      void addMarker(AddMarkerCmd addMarkerCmd)
      Adds a marker to an element (basically a css class).

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

    • removeMarker

      void removeMarker(RemoveMarkerCmd removeMarkerCmd)
      Removes a marker (css class) from an element.