Package io.jmix.bpmui.uicomponent.bpmnviewer

Class BpmnViewerImpl

java.lang.Object

io.jmix.ui.component.impl.AbstractComponent<BpmnViewerJavaScriptComponent>

io.jmix.bpmui.uicomponent.bpmnviewer.BpmnViewerImpl

All Implemented Interfaces:

BpmnViewer, AttachNotifier, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer

public class BpmnViewerImpl
extends AbstractComponent<BpmnViewerJavaScriptComponent>
implements BpmnViewer

Nested Class Summary

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

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

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

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields inherited from class io.jmix.ui.component.impl.AbstractComponent

alignment, applicationContext, component, contextHelpIconClickHandler, contextHelpIconClickListener, descriptionAsHtml, element, frame, htmlSanitizerEnabled, icon, ICON_STYLE, id, parent

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

NAME

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Constructor Summary

Constructors

Constructor	Description
BpmnViewerImpl()

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, Consumer<BpmnXmlSetResult> callback)	The callback will be called after the BPMN XML was actually set to the component.
void	setElementColor(SetElementColorCmd setElementColorCmd)	Sets an element color.

Methods inherited from class io.jmix.ui.component.impl.AbstractComponent

addAttachListener, addDetachListener, addStyleName, assignDebugId, attached, detached, getAlignment, getCaption, getComponent, getComposition, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getDescription, getEventHub, getFrame, getHeight, getHeightSizeUnit, getHtmlSanitizer, getIcon, getIconName, getIconResource, getId, getParent, getStyleName, getUiComponentProperties, getUiProperties, getWidth, getWidthSizeUnit, getXmlDescriptor, hasSubscriptions, hasValidationError, isAttached, isCaptionAsHtml, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, removeStyleName, sanitize, setAlignment, setApplicationContext, setCaption, setCaptionAsHtml, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDebugId, setDescription, setDescriptionAsHtml, setEnabled, setFrame, setHeight, setHtmlSanitizerEnabled, setIcon, setIconFromSet, setId, setParent, setResponsive, setStyleName, setValidationError, setVisible, setWidth, setXmlDescriptor, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Constructor Details

BpmnViewerImpl

public BpmnViewerImpl()

Method Details

setBpmnXml

public void setBpmnXml(String bpmnXml,
 Consumer<BpmnXmlSetResult> callback)

Description copied from interface: BpmnViewer

The callback will be called after the BPMN XML was actually set to the component. Invoke the BpmnViewer.setElementColor(io.jmix.bpmui.uicomponent.bpmnviewer.command.SetElementColorCmd) in the callback

Specified by:

setBpmnXml in interface BpmnViewer

setElementColor

public void setElementColor(SetElementColorCmd setElementColorCmd)

Description copied from interface: BpmnViewer

Sets an element color.

Usage example:

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

Specified by:

setElementColor in interface BpmnViewer

addMarker

public void addMarker(AddMarkerCmd addMarkerCmd)

Description copied from interface: BpmnViewer

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.

Specified by:

addMarker in interface BpmnViewer

removeMarker

public void removeMarker(RemoveMarkerCmd removeMarkerCmd)

Description copied from interface: BpmnViewer

Removes a marker (css class) from an element.

Specified by:

removeMarker in interface BpmnViewer