io.jmix.bpmui.uicomponent.bpmnviewer

Interface BpmnViewer

All Superinterfaces:

io.jmix.ui.component.Component

All Known Implementing Classes:

BpmnViewerImpl

public interface BpmnViewer
extends io.jmix.ui.component.Component

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

io.jmix.ui.component.Component.Alignment, io.jmix.ui.component.Component.BelongToFrame, io.jmix.ui.component.Component.Disposable, io.jmix.ui.component.Component.Editable, io.jmix.ui.component.Component.Focusable, io.jmix.ui.component.Component.HasCaption, io.jmix.ui.component.Component.HasDescription, io.jmix.ui.component.Component.HasIcon, io.jmix.ui.component.Component.HasXmlDescriptor, io.jmix.ui.component.Component.Wrapper

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method and 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(java.lang.String bpmnXml, java.util.function.Consumer<BpmnXmlSetResult> 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 io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

setBpmnXml

void setBpmnXml(java.lang.String bpmnXml,
                java.util.function.Consumer<BpmnXmlSetResult> callback)

The callback will be called after the BPMN XML was actually set to the component. Invoke the setElementColor(io.jmix.bpmui.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.