Package de.xima.fc.common.workflow.bpmn
Class WorkflowBpmnLayoutSettings
- java.lang.Object
-
- de.xima.fc.common.workflow.bpmn.WorkflowBpmnLayoutSettings
-
- All Implemented Interfaces:
IWorkflowBpmnLayoutSettings,Serializable
public final class WorkflowBpmnLayoutSettings extends Object implements IWorkflowBpmnLayoutSettings, Serializable
Default implementation ofIWorkflowBpmnLayoutSettingswith a builder.- Since:
- 8.4.0
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classWorkflowBpmnLayoutSettings.BuilderSimple builder for aWorkflowBpmnLayoutSettingsinstance.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description intassociationColor()The default color forassociations, as a hex RGB value, e.g.intboundaryEventColor()The default color forboundary events, as a hex RGB value, e.g.doubleboundaryEventDiameter()The default diameter ofboundary eventsin the BPMN diagram.doubleboundaryEventTextAnnotationDistance()The distance between aboundary eventand itstext annotation.WorkflowBpmnTextLayoutSettingsboundaryEventTextSettings()The default text settings for (the label of)boundary eventsin the BPMN diagram.static WorkflowBpmnLayoutSettings.Builderbuilder()Create a new builder for the layout settings to use when creating a BPMN diagram of the workflow.booleancollapseSubProcesses()Whether to set theexpandedattribute of aBPMN shapeto false forSubProcess.booleancolorize()When true, addscolorsto the BPMN diagram, as specified by the BPMN in Color Specification.intcomplexGatewayColor()The default color forcomplex gateways, as a hex RGB value, e.g.doublecomplexGatewayHeight()The default height ofcomplex gatewaysin the BPMN diagram.doublecomplexGatewayTextAnnotationDistance()The distance between acomplex gatewaysand itstext annotation.WorkflowBpmnTextLayoutSettingscomplexGatewayTextSettings()The default text settings for (the label of)complex gatewaysin the BPMN diagram.doublecomplexGatewayWidth()The default width ofcomplex gatewaysin the BPMN diagram.doublecrossFlowDirectionSpacing()Spacing in the direction orthogonal to the flow.intdataObjectColor()The default color fordata objects, as a hex RGB value, e.g.doubledataObjectHeight()The default height ofdata objectsin the BPMN diagram.doubledataObjectTextAnnotationDistance()The distance between adata objectand itstext annotation.WorkflowBpmnTextLayoutSettingsdataObjectTextSettings()The default text settings for (the label of)data objectsin the BPMN diagram.doubledataObjectWidth()The default width ofdata objectsin the BPMN diagram.intdataStoreColor()The default color fordata stores, as a hex RGB value, e.g.doubledataStoreHeight()The default height ofdata storesin the BPMN diagram.doubledataStoreTextAnnotationDistance()The distance between adata storeand itstext annotation.WorkflowBpmnTextLayoutSettingsdataStoreTextSettings()The default text settings for (the label of)data storesin the BPMN diagram.doubledataStoreWidth()The default width ofdata storesin the BPMN diagram.doubledefaultFlowMarkerLength()The length from the start of adefaultsequence flowto the end of the default flow marker (a slash).ECardinalDirection2Ddirection()The flow direction in which the model should be laid out.intendEventColor()The default color forend events, as a hex RGB value, e.g.doubleendEventDiameter()The default diameter ofend eventsin the BPMN diagram.doubleendEventTextAnnotationDistance()The distance between anend eventand itstext annotation.WorkflowBpmnTextLayoutSettingsendEventTextSettings()The default text settings for (the label of)start eventsin the BPMN diagram.inteventBasedGatewayColor()The default color forevent based gateways, as a hex RGB value, e.g.doubleeventBasedGatewayHeight()The default height ofevent based gatewaysin the BPMN diagram.doubleeventBasedGatewayTextAnnotationDistance()The distance between aevent based gatewaysand itstext annotation.WorkflowBpmnTextLayoutSettingseventBasedGatewayTextSettings()The default text settings for (the label of)event based gatewaysin the BPMN diagram.doubleeventBasedGatewayWidth()The default width ofevent based gatewaysin the BPMN diagram.intexclusiveGatewayColor()The default color forexclusive gateways, as a hex RGB value, e.g.doubleexclusiveGatewayHeight()The default height ofexclusive gatewaysin the BPMN diagram.doubleexclusiveGatewayTextAnnotationDistance()The distance between aexclusive gatewaysand itstext annotation.WorkflowBpmnTextLayoutSettingsexclusiveGatewayTextSettings()The default text settings for (the label of)exclusive gatewaysin the BPMN diagram.doubleexclusiveGatewayWidth()The default width ofexclusive gatewaysin the BPMN diagram.doubleflowDirectionSpacing()Spacing in the direction of the flow.LengthfontSizeUnit()The unit for font sizes in the BPMN diagram.intinclusiveGatewayColor()The default color forinclusive gateways, as a hex RGB value, e.g.doubleinclusiveGatewayHeight()The default height ofinclusive gatewaysin the BPMN diagram.doubleinclusiveGatewayTextAnnotationDistance()The distance between ainclusive gatewaysand itstext annotation.WorkflowBpmnTextLayoutSettingsinclusiveGatewayTextSettings()The default text settings for (the label of)inclusive gatewaysin the BPMN diagram.doubleinclusiveGatewayWidth()The default width ofinclusive gatewaysin the BPMN diagram.intintermediateCatchEventColor()The default color forintermediate catch events, as a hex RGB value, e.g.doubleintermediateCatchEventDiameter()The default diameter ofintermediate catch eventsin the BPMN diagram.doubleintermediateCatchEventTextAnnotationDistance()The distance between anintermediate catch eventand itstext annotation.WorkflowBpmnTextLayoutSettingsintermediateCatchEventTextSettings()The default text settings for (the label of)intermediate catch eventsin the BPMN diagram.intintermediateThrowEventColor()The default color forintermediate throw events, as a hex RGB value, e.g.doubleintermediateThrowEventDiameter()The default diameter ofintermediate throw eventsin the BPMN diagram.doubleintermediateThrowEventTextAnnotationDistance()The distance between anintermediate throw eventand itstext annotation.WorkflowBpmnTextLayoutSettingsintermediateThrowEventTextSettings()The default text settings for (the label of)intermediate throw eventsin the BPMN diagram.WorkflowBpmnTextLayoutSettingslaneTextSettings()The default text settings for (the label of)lanesin the BPMN diagram.doublenameDistance()The distance between anamed elementand its name.ICardinalDirection2DMapDoublenonAbstractTaskMinPadding()The minimum amount of padding to apply tonon-abstracttasks in the BPMN diagram.doubleotherTextAnnotationDistance()The distance between anelementand itstext annotation.intparallelGatewayColor()The default color forparallel gateways, as a hex RGB value, e.g.doubleparallelGatewayHeight()The default height ofparallel gatewaysin the BPMN diagram.doubleparallelGatewayTextAnnotationDistance()The distance between aparallel gatewaysand itstext annotation.WorkflowBpmnTextLayoutSettingsparallelGatewayTextSettings()The default text settings for (the label of)parallel gatewaysin the BPMN diagram.doubleparallelGatewayWidth()The default width ofparallel gatewaysin the BPMN diagram.doubleparticipantHeaderPadding()The padding for the header of aparticipant(sometimes called pool) in the BPMN diagram.WorkflowBpmnTextLayoutSettingsparticipantTextSettings()The default text settings for (the label of)participantsin the BPMN diagram.intsequenceFlowColor()The default color forsequence flows, as a hex RGB value, e.g.doublesequenceFlowLabelSpacing()When placing a label next to a sequence flow, the spacing between the sequence flow line and the label text.WorkflowBpmnTextLayoutSettingssequenceFlowTextSettings()The default text settings for (the label of)sequence flowsin the BPMN diagram.intstartEventColor()The default color forstart events, as a hex RGB value, e.g.doublestartEventDiameter()The default diameter ofstart eventsin the BPMN diagram.doublestartEventTextAnnotationDistance()The distance between astart eventand itstext annotation.WorkflowBpmnTextLayoutSettingsstartEventTextSettings()The default text settings for (the label of)start eventsin the BPMN diagram.doublesubProcessHeaderPadding()The padding for the header of asub processin the BPMN diagram.doublesubProcessNameAlignmentOffset()Controls the alignment of asub process's name in the BPMN diagram in the horizontal direction, together withsubProcessNameAlignmentRatio.doublesubProcessNameAlignmentRatio()Controls the alignment of asub process's name in the BPMN diagram in the horizontal direction, together withsubProcessNameAlignmentOffset.doublesubProcessTextAnnotationDistance()The distance between asub processand itstext annotation.WorkflowBpmnTextLayoutSettingssubProcessTextSettings()The default text settings for (the label of)sub processesin the BPMN diagram.inttaskColor()The default color fortasks, as a hex RGB value, e.g.doubletaskHeight()The default height oftasksin the BPMN diagram.ICardinalDirection2DMapDoubletaskPadding()The padding to apply to tasks in the BPMN diagram.doubletaskTextAnnotationDistance()The distance between ataskand itstext annotation.WorkflowBpmnTextLayoutSettingstaskTextSettings()The default text settings for (the label of)tasksin the BPMN diagram.doubletaskWidth()The default width oftasksin the BPMN diagram.inttextAnnotationColor()The default color fortext annotations, as a hex RGB value, e.g.ICardinalDirection2DMapDoubletextAnnotationPadding()The padding to apply to text annotations in the BPMN diagram.WorkflowBpmnTextLayoutSettingstextAnnotationTextSettings()The default text settings for (the text of)text annotationsin the BPMN diagram.
-
-
-
Method Detail
-
associationColor
public int associationColor()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default color forassociations, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
associationColorin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default color for associations.
-
boundaryEventColor
public int boundaryEventColor()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default color forboundary events, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
boundaryEventColorin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default color for boundary events.
-
boundaryEventDiameter
public double boundaryEventDiameter()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default diameter ofboundary eventsin the BPMN diagram. BPMN diagrams represent events as circles.- Specified by:
boundaryEventDiameterin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default diameter of events in the BPMN diagram.
-
boundaryEventTextAnnotationDistance
public double boundaryEventTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe distance between aboundary eventand itstext annotation.- Specified by:
boundaryEventTextAnnotationDistancein interfaceIWorkflowBpmnLayoutSettings- Returns:
- The distance between a boundary event and its text annotation.
-
boundaryEventTextSettings
public WorkflowBpmnTextLayoutSettings boundaryEventTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default text settings for (the label of)boundary eventsin the BPMN diagram.- Specified by:
boundaryEventTextSettingsin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default text settings for boundary events in the BPMN diagram.
-
collapseSubProcesses
public boolean collapseSubProcesses()
Description copied from interface:IWorkflowBpmnLayoutSettingsWhether to set theexpandedattribute of aBPMN shapeto false forSubProcess. May improve the readability of the BPMN diagram in general, and may also improve compatibility with some tools that prefer collapsed subprocesses.- Specified by:
collapseSubProcessesin interfaceIWorkflowBpmnLayoutSettings- Returns:
- Whether to collapse mark subprocesses.
-
colorize
public boolean colorize()
Description copied from interface:IWorkflowBpmnLayoutSettingsWhen true, addscolorsto the BPMN diagram, as specified by the BPMN in Color Specification. When false, do not add colors.- Specified by:
colorizein interfaceIWorkflowBpmnLayoutSettings- Returns:
- True if the BPMN diagram should be colorized, false otherwise.
-
complexGatewayColor
public int complexGatewayColor()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default color forcomplex gateways, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
complexGatewayColorin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default color for event based gateways.
-
complexGatewayHeight
public double complexGatewayHeight()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default height ofcomplex gatewaysin the BPMN diagram. BPMN diagrams represent complex gateways as rhombi.- Specified by:
complexGatewayHeightin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default height of complex gateways in the BPMN diagram.
-
complexGatewayTextAnnotationDistance
public double complexGatewayTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe distance between acomplex gatewaysand itstext annotation.- Specified by:
complexGatewayTextAnnotationDistancein interfaceIWorkflowBpmnLayoutSettings- Returns:
- The distance between a complex gateway and its text annotation.
-
complexGatewayTextSettings
public WorkflowBpmnTextLayoutSettings complexGatewayTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default text settings for (the label of)complex gatewaysin the BPMN diagram.- Specified by:
complexGatewayTextSettingsin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default text settings for complex gateways in the BPMN diagram.
-
complexGatewayWidth
public double complexGatewayWidth()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default width ofcomplex gatewaysin the BPMN diagram. BPMN diagrams represent complex gateways as rhombi.- Specified by:
complexGatewayWidthin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default width of complex gateways in the BPMN diagram.
-
crossFlowDirectionSpacing
public double crossFlowDirectionSpacing()
Description copied from interface:IWorkflowBpmnLayoutSettingsSpacing in the direction orthogonal to the flow. Flow direction here refers toIWorkflowBpmnLayoutSettings.direction().- Specified by:
crossFlowDirectionSpacingin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The spacing in the direction of the flow.
-
dataObjectColor
public int dataObjectColor()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default color fordata objects, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
dataObjectColorin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default color for data objects.
-
dataObjectHeight
public double dataObjectHeight()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default height ofdata objectsin the BPMN diagram. BPMN diagrams represent data objects as rectangles.- Specified by:
dataObjectHeightin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default height of data objects in the BPMN diagram.
-
dataObjectTextAnnotationDistance
public double dataObjectTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe distance between adata objectand itstext annotation.- Specified by:
dataObjectTextAnnotationDistancein interfaceIWorkflowBpmnLayoutSettings- Returns:
- The distance between a data object and its text annotation.
-
dataObjectTextSettings
public WorkflowBpmnTextLayoutSettings dataObjectTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default text settings for (the label of)data objectsin the BPMN diagram.- Specified by:
dataObjectTextSettingsin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default text settings for data objects in the BPMN diagram.
-
dataObjectWidth
public double dataObjectWidth()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default width ofdata objectsin the BPMN diagram. BPMN diagrams represent data objects as rectangles.- Specified by:
dataObjectWidthin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default width of data objects in the BPMN diagram.
-
dataStoreColor
public int dataStoreColor()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default color fordata stores, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
dataStoreColorin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default color for data stores.
-
dataStoreHeight
public double dataStoreHeight()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default height ofdata storesin the BPMN diagram. BPMN diagrams represent data stores as rectangular shapes.- Specified by:
dataStoreHeightin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default height of data stores in the BPMN diagram.
-
dataStoreTextAnnotationDistance
public double dataStoreTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe distance between adata storeand itstext annotation.- Specified by:
dataStoreTextAnnotationDistancein interfaceIWorkflowBpmnLayoutSettings- Returns:
- The distance between a data store and its text annotation.
-
dataStoreTextSettings
public WorkflowBpmnTextLayoutSettings dataStoreTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default text settings for (the label of)data storesin the BPMN diagram.- Specified by:
dataStoreTextSettingsin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default text settings for data stores in the BPMN diagram.
-
dataStoreWidth
public double dataStoreWidth()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default width ofdata storesin the BPMN diagram. BPMN diagrams represent data stores as rectangular shapes.- Specified by:
dataStoreWidthin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default width of data stores in the BPMN diagram.
-
defaultFlowMarkerLength
public double defaultFlowMarkerLength()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe length from the start of adefaultsequence flowto the end of the default flow marker (a slash). This is used e.g. to offset labels on the sequence flow so that they don't overlap with the default flow marker.- Specified by:
defaultFlowMarkerLengthin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default length from the start of a flow to the end of the default flow marker.
-
direction
public ECardinalDirection2D direction()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe flow direction in which the model should be laid out. Items are aligned along theaxis, and in the specifieddirection.A concept closely related to the flow direction is the cross flow direction. The cross flow direction is the direction orthogonal to the flow, facing left when looking in the flow direction.
- When the flow direction is the positive x direction, the cross flow direction is the positive y direction.
- When the flow direction is the negative x direction, the cross flow direction is the negative y direction.
- When the flow direction is the positive y direction, the cross flow direction is the negative x direction.
- When the flow direction is the negative y direction, the cross flow direction is the positive x direction.
For example:
^ cross flow direction | | | | -----------------------------> flow direction | | |
- Specified by:
directionin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The direction in which the model should be laid out, never null.
-
endEventColor
public int endEventColor()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default color forend events, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
endEventColorin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default color for end events.
-
endEventDiameter
public double endEventDiameter()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default diameter ofend eventsin the BPMN diagram. BPMN diagrams represent events as circles.- Specified by:
endEventDiameterin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default diameter of events in the BPMN diagram.
-
endEventTextAnnotationDistance
public double endEventTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe distance between anend eventand itstext annotation.- Specified by:
endEventTextAnnotationDistancein interfaceIWorkflowBpmnLayoutSettings- Returns:
- The distance between an end event and its text annotation.
-
endEventTextSettings
public WorkflowBpmnTextLayoutSettings endEventTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default text settings for (the label of)start eventsin the BPMN diagram.- Specified by:
endEventTextSettingsin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default text settings for end events in the BPMN diagram.
-
eventBasedGatewayColor
public int eventBasedGatewayColor()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default color forevent based gateways, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
eventBasedGatewayColorin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default color for event based gateways.
-
eventBasedGatewayHeight
public double eventBasedGatewayHeight()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default height ofevent based gatewaysin the BPMN diagram. BPMN diagrams represent event based gateways as rhombi.- Specified by:
eventBasedGatewayHeightin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default height of event based gateways in the BPMN diagram.
-
eventBasedGatewayTextAnnotationDistance
public double eventBasedGatewayTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe distance between aevent based gatewaysand itstext annotation.- Specified by:
eventBasedGatewayTextAnnotationDistancein interfaceIWorkflowBpmnLayoutSettings- Returns:
- The distance between an event based gateway and its text annotation.
-
eventBasedGatewayTextSettings
public WorkflowBpmnTextLayoutSettings eventBasedGatewayTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default text settings for (the label of)event based gatewaysin the BPMN diagram.- Specified by:
eventBasedGatewayTextSettingsin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default text settings for event based gateways in the BPMN diagram.
-
eventBasedGatewayWidth
public double eventBasedGatewayWidth()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default width ofevent based gatewaysin the BPMN diagram. BPMN diagrams represent event based gateways as rhombi.- Specified by:
eventBasedGatewayWidthin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default width of event based gateways in the BPMN diagram.
-
exclusiveGatewayColor
public int exclusiveGatewayColor()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default color forexclusive gateways, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
exclusiveGatewayColorin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default color for exclusive gateways.
-
exclusiveGatewayHeight
public double exclusiveGatewayHeight()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default height ofexclusive gatewaysin the BPMN diagram. BPMN diagrams represent exclusive gateways as rhombi.- Specified by:
exclusiveGatewayHeightin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default height of exclusive gateways in the BPMN diagram.
-
exclusiveGatewayTextAnnotationDistance
public double exclusiveGatewayTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe distance between aexclusive gatewaysand itstext annotation.- Specified by:
exclusiveGatewayTextAnnotationDistancein interfaceIWorkflowBpmnLayoutSettings- Returns:
- The distance between an exclusive gateway and its text annotation.
-
exclusiveGatewayTextSettings
public WorkflowBpmnTextLayoutSettings exclusiveGatewayTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default text settings for (the label of)exclusive gatewaysin the BPMN diagram.- Specified by:
exclusiveGatewayTextSettingsin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default text settings for exclusive gateways in the BPMN diagram.
-
exclusiveGatewayWidth
public double exclusiveGatewayWidth()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default width ofexclusive gatewaysin the BPMN diagram. BPMN diagrams represent exclusive gateways as rhombi.- Specified by:
exclusiveGatewayWidthin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default width of exclusive gateways in the BPMN diagram.
-
flowDirectionSpacing
public double flowDirectionSpacing()
Description copied from interface:IWorkflowBpmnLayoutSettingsSpacing in the direction of the flow. Flow direction here refers toIWorkflowBpmnLayoutSettings.direction().- Specified by:
flowDirectionSpacingin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The spacing in the direction of the flow.
-
fontSizeUnit
public Length fontSizeUnit()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe unit for font sizes in the BPMN diagram. Often pixels, but can also be points or other units. As per the BPMN spec, the font size is a unitless number in some unspecified unit. This is the unit that determines how that unitless number is calculated.- Specified by:
fontSizeUnitin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The unit for font sizes in the BPMN diagram.
-
inclusiveGatewayColor
public int inclusiveGatewayColor()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default color forinclusive gateways, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
inclusiveGatewayColorin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default color for inclusive gateways.
-
inclusiveGatewayHeight
public double inclusiveGatewayHeight()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default height ofinclusive gatewaysin the BPMN diagram. BPMN diagrams represent inclusive gateways as rhombi.- Specified by:
inclusiveGatewayHeightin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default height of inclusive gateways in the BPMN diagram.
-
inclusiveGatewayTextAnnotationDistance
public double inclusiveGatewayTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe distance between ainclusive gatewaysand itstext annotation.- Specified by:
inclusiveGatewayTextAnnotationDistancein interfaceIWorkflowBpmnLayoutSettings- Returns:
- The distance between an inclusive gateway and its text annotation.
-
inclusiveGatewayTextSettings
public WorkflowBpmnTextLayoutSettings inclusiveGatewayTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default text settings for (the label of)inclusive gatewaysin the BPMN diagram.- Specified by:
inclusiveGatewayTextSettingsin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default text settings for inclusive gateways in the BPMN diagram.
-
inclusiveGatewayWidth
public double inclusiveGatewayWidth()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default width ofinclusive gatewaysin the BPMN diagram. BPMN diagrams represent inclusive gateways as rhombi.- Specified by:
inclusiveGatewayWidthin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default width of inclusive gateways in the BPMN diagram.
-
intermediateCatchEventColor
public int intermediateCatchEventColor()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default color forintermediate catch events, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
intermediateCatchEventColorin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default color for intermediate catch events.
-
intermediateCatchEventDiameter
public double intermediateCatchEventDiameter()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default diameter ofintermediate catch eventsin the BPMN diagram. BPMN diagrams represent events as circles.- Specified by:
intermediateCatchEventDiameterin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default diameter of events in the BPMN diagram.
-
intermediateCatchEventTextAnnotationDistance
public double intermediateCatchEventTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe distance between anintermediate catch eventand itstext annotation.- Specified by:
intermediateCatchEventTextAnnotationDistancein interfaceIWorkflowBpmnLayoutSettings- Returns:
- The distance between an intermediate catch event and its text annotation.
-
intermediateCatchEventTextSettings
public WorkflowBpmnTextLayoutSettings intermediateCatchEventTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default text settings for (the label of)intermediate catch eventsin the BPMN diagram.- Specified by:
intermediateCatchEventTextSettingsin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default text settings for intermediate catch events in the BPMN diagram.
-
intermediateThrowEventColor
public int intermediateThrowEventColor()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default color forintermediate throw events, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
intermediateThrowEventColorin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default color for intermediate throw events.
-
intermediateThrowEventDiameter
public double intermediateThrowEventDiameter()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default diameter ofintermediate throw eventsin the BPMN diagram. BPMN diagrams represent events as circles.- Specified by:
intermediateThrowEventDiameterin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default diameter of events in the BPMN diagram.
-
intermediateThrowEventTextAnnotationDistance
public double intermediateThrowEventTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe distance between anintermediate throw eventand itstext annotation.- Specified by:
intermediateThrowEventTextAnnotationDistancein interfaceIWorkflowBpmnLayoutSettings- Returns:
- The distance between an intermediate throw event and its text annotation.
-
intermediateThrowEventTextSettings
public WorkflowBpmnTextLayoutSettings intermediateThrowEventTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default text settings for (the label of)intermediate throw eventsin the BPMN diagram.- Specified by:
intermediateThrowEventTextSettingsin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default text settings for intermediate throw events in the BPMN diagram.
-
laneTextSettings
public WorkflowBpmnTextLayoutSettings laneTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default text settings for (the label of)lanesin the BPMN diagram.- Specified by:
laneTextSettingsin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default text settings for lanes in the BPMN diagram.
-
nameDistance
public double nameDistance()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe distance between anamed elementand its name.- Specified by:
nameDistancein interfaceIWorkflowBpmnLayoutSettings- Returns:
- The distance between a named element and its name.
-
nonAbstractTaskMinPadding
public ICardinalDirection2DMapDouble nonAbstractTaskMinPadding()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe minimum amount of padding to apply tonon-abstracttasks in the BPMN diagram. Used e.g. to make room for the marker icon that indicates the task's type, such as a gear icon for a service task, or a user icon for a user task.- Specified by:
nonAbstractTaskMinPaddingin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The minimum padding for non-abstract tasks in the BPMN diagram.
-
otherTextAnnotationDistance
public double otherTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe distance between anelementand itstext annotation. This is used when none of the more specific distances are applicable, such asIWorkflowBpmnLayoutSettings.startEventTextAnnotationDistance().- Specified by:
otherTextAnnotationDistancein interfaceIWorkflowBpmnLayoutSettings- Returns:
- The distance between an element and its text annotation.
-
parallelGatewayColor
public int parallelGatewayColor()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default color forparallel gateways, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
parallelGatewayColorin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default color for parallel gateways.
-
parallelGatewayHeight
public double parallelGatewayHeight()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default height ofparallel gatewaysin the BPMN diagram. BPMN diagrams represent parallel gateways as rhombi.- Specified by:
parallelGatewayHeightin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default height of parallel gateways in the BPMN diagram.
-
parallelGatewayTextAnnotationDistance
public double parallelGatewayTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe distance between aparallel gatewaysand itstext annotation.- Specified by:
parallelGatewayTextAnnotationDistancein interfaceIWorkflowBpmnLayoutSettings- Returns:
- The distance between a parallel gateway and its text annotation.
-
parallelGatewayTextSettings
public WorkflowBpmnTextLayoutSettings parallelGatewayTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default text settings for (the label of)parallel gatewaysin the BPMN diagram.- Specified by:
parallelGatewayTextSettingsin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default text settings for parallel gateways in the BPMN diagram.
-
parallelGatewayWidth
public double parallelGatewayWidth()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default width ofparallel gatewaysin the BPMN diagram. BPMN diagrams represent parallel gateways as rhombi.- Specified by:
parallelGatewayWidthin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default width of parallel gateways in the BPMN diagram.
-
participantHeaderPadding
public double participantHeaderPadding()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe padding for the header of aparticipant(sometimes called pool) in the BPMN diagram. The header contains the name of the participant and is rendered either to the left or on top of the participant's lanes, depending on theflow direction. The BPMN spec does not specify a padding, some tools work with arbitrary values, some tools require a specific value.- Specified by:
participantHeaderPaddingin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The padding for the header of a participant in the BPMN diagram.
-
participantTextSettings
public WorkflowBpmnTextLayoutSettings participantTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default text settings for (the label of)participantsin the BPMN diagram.- Specified by:
participantTextSettingsin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default text settings for participants in the BPMN diagram.
-
sequenceFlowColor
public int sequenceFlowColor()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default color forsequence flows, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
sequenceFlowColorin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default color for sequence flows.
-
sequenceFlowLabelSpacing
public double sequenceFlowLabelSpacing()
Description copied from interface:IWorkflowBpmnLayoutSettingsWhen placing a label next to a sequence flow, the spacing between the sequence flow line and the label text.- Specified by:
sequenceFlowLabelSpacingin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The spacing between the sequence flow line and the label text.
-
sequenceFlowTextSettings
public WorkflowBpmnTextLayoutSettings sequenceFlowTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default text settings for (the label of)sequence flowsin the BPMN diagram.- Specified by:
sequenceFlowTextSettingsin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default text settings for sequence flows in the BPMN diagram.
-
startEventColor
public int startEventColor()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default color forstart events, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
startEventColorin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default color for start events.
-
startEventDiameter
public double startEventDiameter()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default diameter ofstart eventsin the BPMN diagram. BPMN diagrams represent events as circles.- Specified by:
startEventDiameterin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default diameter of events in the BPMN diagram.
-
startEventTextAnnotationDistance
public double startEventTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe distance between astart eventand itstext annotation.- Specified by:
startEventTextAnnotationDistancein interfaceIWorkflowBpmnLayoutSettings- Returns:
- The distance between a start event and its text annotation.
-
startEventTextSettings
public WorkflowBpmnTextLayoutSettings startEventTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default text settings for (the label of)start eventsin the BPMN diagram.- Specified by:
startEventTextSettingsin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default text settings for start events in the BPMN diagram.
-
subProcessHeaderPadding
public double subProcessHeaderPadding()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe padding for the header of asub processin the BPMN diagram. The header contains the name of the sub process and is rendered below the top edge of the sub process. This is the padding from the top edge of the sub process to the top edge of the name in the header.- Specified by:
subProcessHeaderPaddingin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The padding for the header of a sub process in the BPMN diagram.
-
subProcessNameAlignmentOffset
public double subProcessNameAlignmentOffset()
Description copied from interface:IWorkflowBpmnLayoutSettingsControls the alignment of asub process's name in the BPMN diagram in the horizontal direction, together withsubProcessNameAlignmentRatio. Defaults to 0, which corresponds to no offset.To determine the position of the name, the name is first positioned according to the ration, the offset by given amount.
- The ration is a value between 0 and 1, where 0 means the name is aligned to the left edge of the sub process, and 1 means the name is aligned to the right edge of the sub process.
- The offset is an absolute value in pixels, which is added to the position of the name after it has been aligned. A positive offset moves the name to the right, a negative offset moves it to the left.
- Specified by:
subProcessNameAlignmentOffsetin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The alignment offset of the sub process name in the BPMN diagram.
-
subProcessNameAlignmentRatio
public double subProcessNameAlignmentRatio()
Description copied from interface:IWorkflowBpmnLayoutSettingsControls the alignment of asub process's name in the BPMN diagram in the horizontal direction, together withsubProcessNameAlignmentOffset. Defaults to 0.5, which centers the name.To determine the position of the name, the name is first positioned according to the ration, the offset by given amount.
- The ration is a value between 0 and 1, where 0 means the name is aligned to the left edge of the sub process, and 1 means the name is aligned to the right edge of the sub process.
- The offset is an absolute value in pixels, which is added to the position of the name after it has been aligned. A positive offset moves the name to the right, a negative offset moves it to the left.
- Specified by:
subProcessNameAlignmentRatioin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The alignment ratio of the sub process name in the BPMN diagram.
-
subProcessTextAnnotationDistance
public double subProcessTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe distance between asub processand itstext annotation.- Specified by:
subProcessTextAnnotationDistancein interfaceIWorkflowBpmnLayoutSettings- Returns:
- The distance between a sub process and its text annotation.
-
subProcessTextSettings
public WorkflowBpmnTextLayoutSettings subProcessTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default text settings for (the label of)sub processesin the BPMN diagram.- Specified by:
subProcessTextSettingsin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default text settings for sub processes in the BPMN diagram.
-
taskColor
public int taskColor()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default color fortasks, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
taskColorin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default color for start events.
-
taskHeight
public double taskHeight()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default height oftasksin the BPMN diagram. BPMN diagrams represent tasks as rectangles.- Specified by:
taskHeightin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default height of tasks in the BPMN diagram.
-
taskPadding
public ICardinalDirection2DMapDouble taskPadding()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe padding to apply to tasks in the BPMN diagram. This is the padding of the text inside the task box, not the padding around the task box itself.+---------------------------------------+ | | | north padding | | +-------------------+ | | | | | | west | | east | | padding | label text | padding | | | | | | | | | | +-------------------+ | | south padding | | | +---------------------------------------+ Text annotationTheBpmnShapeof theTaskcontainsBounds, these describe the size of the task box, including the padding. The BPMN shape also contains aBpmnLabel, which also contains nestedBounds, these describe the size of the label text inside the text box (without the padding).- Specified by:
taskPaddingin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The padding to apply to tasks in the BPMN diagram.
-
taskTextAnnotationDistance
public double taskTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe distance between ataskand itstext annotation.- Specified by:
taskTextAnnotationDistancein interfaceIWorkflowBpmnLayoutSettings- Returns:
- The distance between a task and its text annotation.
-
taskTextSettings
public WorkflowBpmnTextLayoutSettings taskTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default text settings for (the label of)tasksin the BPMN diagram.- Specified by:
taskTextSettingsin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default text settings for tasks in the BPMN diagram.
-
taskWidth
public double taskWidth()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default width oftasksin the BPMN diagram. BPMN diagrams represent tasks as rectangles.- Specified by:
taskWidthin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default width of tasks in the BPMN diagram.
-
textAnnotationColor
public int textAnnotationColor()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default color fortext annotations, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
textAnnotationColorin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default color for text annotations.
-
textAnnotationPadding
public ICardinalDirection2DMapDouble textAnnotationPadding()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe padding to apply to text annotations in the BPMN diagram. This is the padding of the text inside the annotation box, not the padding around the annotation box itself.+---------------------------------------+ | | | north padding | | +-------------------+ | | | | | | west | | east | | padding | text annotation | padding | | | | | | | | | | +-------------------+ | | south padding | | | +---------------------------------------+ TaskTheBpmnShapeof theTextAnnotationcontainsBounds, which describe the size of the text annotation box, including the padding. The BPMN shape also contains aBpmnLabel, which also contains nestedBounds, which describe the size of the text inside the annotation box (without the padding).- Specified by:
textAnnotationPaddingin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The padding to apply to text annotations in the BPMN diagram.
-
textAnnotationTextSettings
public WorkflowBpmnTextLayoutSettings textAnnotationTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettingsThe default text settings for (the text of)text annotationsin the BPMN diagram.- Specified by:
textAnnotationTextSettingsin interfaceIWorkflowBpmnLayoutSettings- Returns:
- The default text settings for text annotations in the BPMN diagram.
-
builder
public static WorkflowBpmnLayoutSettings.Builder builder()
Create a new builder for the layout settings to use when creating a BPMN diagram of the workflow.- Returns:
- A new builder.
-
-