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 ofIWorkflowBpmnLayoutSettings
with a builder.- Since:
- 8.4.0
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
WorkflowBpmnLayoutSettings.Builder
Simple builder for aWorkflowBpmnLayoutSettings
instance.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
associationColor()
The default color forassociations
, as a hex RGB value, e.g.int
boundaryEventColor()
The default color forboundary events
, as a hex RGB value, e.g.double
boundaryEventDiameter()
The default diameter ofboundary events
in the BPMN diagram.double
boundaryEventTextAnnotationDistance()
The distance between aboundary event
and itstext annotation
.WorkflowBpmnTextLayoutSettings
boundaryEventTextSettings()
The default text settings for (the label of)boundary events
in the BPMN diagram.static WorkflowBpmnLayoutSettings.Builder
builder()
Create a new builder for the layout settings to use when creating a BPMN diagram of the workflow.boolean
collapseSubProcesses()
Whether to set theexpanded
attribute of aBPMN shape
to false forSubProcess
.boolean
colorize()
When true, addscolors
to the BPMN diagram, as specified by the BPMN in Color Specification.int
complexGatewayColor()
The default color forcomplex gateways
, as a hex RGB value, e.g.double
complexGatewayHeight()
The default height ofcomplex gateways
in the BPMN diagram.double
complexGatewayTextAnnotationDistance()
The distance between acomplex gateways
and itstext annotation
.WorkflowBpmnTextLayoutSettings
complexGatewayTextSettings()
The default text settings for (the label of)complex gateways
in the BPMN diagram.double
complexGatewayWidth()
The default width ofcomplex gateways
in the BPMN diagram.double
crossFlowDirectionSpacing()
Spacing in the direction orthogonal to the flow.int
dataObjectColor()
The default color fordata objects
, as a hex RGB value, e.g.double
dataObjectHeight()
The default height ofdata objects
in the BPMN diagram.double
dataObjectTextAnnotationDistance()
The distance between adata object
and itstext annotation
.WorkflowBpmnTextLayoutSettings
dataObjectTextSettings()
The default text settings for (the label of)data objects
in the BPMN diagram.double
dataObjectWidth()
The default width ofdata objects
in the BPMN diagram.int
dataStoreColor()
The default color fordata stores
, as a hex RGB value, e.g.double
dataStoreHeight()
The default height ofdata stores
in the BPMN diagram.double
dataStoreTextAnnotationDistance()
The distance between adata store
and itstext annotation
.WorkflowBpmnTextLayoutSettings
dataStoreTextSettings()
The default text settings for (the label of)data stores
in the BPMN diagram.double
dataStoreWidth()
The default width ofdata stores
in the BPMN diagram.double
defaultFlowMarkerLength()
The length from the start of adefault
sequence flow
to the end of the default flow marker (a slash).ECardinalDirection2D
direction()
The flow direction in which the model should be laid out.int
endEventColor()
The default color forend events
, as a hex RGB value, e.g.double
endEventDiameter()
The default diameter ofend events
in the BPMN diagram.double
endEventTextAnnotationDistance()
The distance between anend event
and itstext annotation
.WorkflowBpmnTextLayoutSettings
endEventTextSettings()
The default text settings for (the label of)start events
in the BPMN diagram.int
eventBasedGatewayColor()
The default color forevent based gateways
, as a hex RGB value, e.g.double
eventBasedGatewayHeight()
The default height ofevent based gateways
in the BPMN diagram.double
eventBasedGatewayTextAnnotationDistance()
The distance between aevent based gateways
and itstext annotation
.WorkflowBpmnTextLayoutSettings
eventBasedGatewayTextSettings()
The default text settings for (the label of)event based gateways
in the BPMN diagram.double
eventBasedGatewayWidth()
The default width ofevent based gateways
in the BPMN diagram.int
exclusiveGatewayColor()
The default color forexclusive gateways
, as a hex RGB value, e.g.double
exclusiveGatewayHeight()
The default height ofexclusive gateways
in the BPMN diagram.double
exclusiveGatewayTextAnnotationDistance()
The distance between aexclusive gateways
and itstext annotation
.WorkflowBpmnTextLayoutSettings
exclusiveGatewayTextSettings()
The default text settings for (the label of)exclusive gateways
in the BPMN diagram.double
exclusiveGatewayWidth()
The default width ofexclusive gateways
in the BPMN diagram.double
flowDirectionSpacing()
Spacing in the direction of the flow.Length
fontSizeUnit()
The unit for font sizes in the BPMN diagram.int
inclusiveGatewayColor()
The default color forinclusive gateways
, as a hex RGB value, e.g.double
inclusiveGatewayHeight()
The default height ofinclusive gateways
in the BPMN diagram.double
inclusiveGatewayTextAnnotationDistance()
The distance between ainclusive gateways
and itstext annotation
.WorkflowBpmnTextLayoutSettings
inclusiveGatewayTextSettings()
The default text settings for (the label of)inclusive gateways
in the BPMN diagram.double
inclusiveGatewayWidth()
The default width ofinclusive gateways
in the BPMN diagram.int
intermediateCatchEventColor()
The default color forintermediate catch events
, as a hex RGB value, e.g.double
intermediateCatchEventDiameter()
The default diameter ofintermediate catch events
in the BPMN diagram.double
intermediateCatchEventTextAnnotationDistance()
The distance between anintermediate catch event
and itstext annotation
.WorkflowBpmnTextLayoutSettings
intermediateCatchEventTextSettings()
The default text settings for (the label of)intermediate catch events
in the BPMN diagram.int
intermediateThrowEventColor()
The default color forintermediate throw events
, as a hex RGB value, e.g.double
intermediateThrowEventDiameter()
The default diameter ofintermediate throw events
in the BPMN diagram.double
intermediateThrowEventTextAnnotationDistance()
The distance between anintermediate throw event
and itstext annotation
.WorkflowBpmnTextLayoutSettings
intermediateThrowEventTextSettings()
The default text settings for (the label of)intermediate throw events
in the BPMN diagram.WorkflowBpmnTextLayoutSettings
laneTextSettings()
The default text settings for (the label of)lanes
in the BPMN diagram.double
nameDistance()
The distance between anamed element
and its name.ICardinalDirection2DMapDouble
nonAbstractTaskMinPadding()
The minimum amount of padding to apply tonon-abstract
tasks in the BPMN diagram.double
otherTextAnnotationDistance()
The distance between anelement
and itstext annotation
.int
parallelGatewayColor()
The default color forparallel gateways
, as a hex RGB value, e.g.double
parallelGatewayHeight()
The default height ofparallel gateways
in the BPMN diagram.double
parallelGatewayTextAnnotationDistance()
The distance between aparallel gateways
and itstext annotation
.WorkflowBpmnTextLayoutSettings
parallelGatewayTextSettings()
The default text settings for (the label of)parallel gateways
in the BPMN diagram.double
parallelGatewayWidth()
The default width ofparallel gateways
in the BPMN diagram.double
participantHeaderPadding()
The padding for the header of aparticipant
(sometimes called pool) in the BPMN diagram.WorkflowBpmnTextLayoutSettings
participantTextSettings()
The default text settings for (the label of)participants
in the BPMN diagram.int
sequenceFlowColor()
The default color forsequence flows
, as a hex RGB value, e.g.double
sequenceFlowLabelSpacing()
When placing a label next to a sequence flow, the spacing between the sequence flow line and the label text.WorkflowBpmnTextLayoutSettings
sequenceFlowTextSettings()
The default text settings for (the label of)sequence flows
in the BPMN diagram.int
startEventColor()
The default color forstart events
, as a hex RGB value, e.g.double
startEventDiameter()
The default diameter ofstart events
in the BPMN diagram.double
startEventTextAnnotationDistance()
The distance between astart event
and itstext annotation
.WorkflowBpmnTextLayoutSettings
startEventTextSettings()
The default text settings for (the label of)start events
in the BPMN diagram.double
subProcessHeaderPadding()
The padding for the header of asub process
in the BPMN diagram.double
subProcessNameAlignmentOffset()
Controls the alignment of asub process
's name in the BPMN diagram in the horizontal direction, together withsubProcessNameAlignmentRatio
.double
subProcessNameAlignmentRatio()
Controls the alignment of asub process
's name in the BPMN diagram in the horizontal direction, together withsubProcessNameAlignmentOffset
.double
subProcessTextAnnotationDistance()
The distance between asub process
and itstext annotation
.WorkflowBpmnTextLayoutSettings
subProcessTextSettings()
The default text settings for (the label of)sub processes
in the BPMN diagram.int
taskColor()
The default color fortasks
, as a hex RGB value, e.g.double
taskHeight()
The default height oftasks
in the BPMN diagram.ICardinalDirection2DMapDouble
taskPadding()
The padding to apply to tasks in the BPMN diagram.double
taskTextAnnotationDistance()
The distance between atask
and itstext annotation
.WorkflowBpmnTextLayoutSettings
taskTextSettings()
The default text settings for (the label of)tasks
in the BPMN diagram.double
taskWidth()
The default width oftasks
in the BPMN diagram.int
textAnnotationColor()
The default color fortext annotations
, as a hex RGB value, e.g.ICardinalDirection2DMapDouble
textAnnotationPadding()
The padding to apply to text annotations in the BPMN diagram.WorkflowBpmnTextLayoutSettings
textAnnotationTextSettings()
The default text settings for (the text of)text annotations
in the BPMN diagram.
-
-
-
Method Detail
-
associationColor
public int associationColor()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default color forassociations
, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
associationColor
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default color for associations.
-
boundaryEventColor
public int boundaryEventColor()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default color forboundary events
, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
boundaryEventColor
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default color for boundary events.
-
boundaryEventDiameter
public double boundaryEventDiameter()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default diameter ofboundary events
in the BPMN diagram. BPMN diagrams represent events as circles.- Specified by:
boundaryEventDiameter
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default diameter of events in the BPMN diagram.
-
boundaryEventTextAnnotationDistance
public double boundaryEventTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettings
The distance between aboundary event
and itstext annotation
.- Specified by:
boundaryEventTextAnnotationDistance
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The distance between a boundary event and its text annotation.
-
boundaryEventTextSettings
public WorkflowBpmnTextLayoutSettings boundaryEventTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default text settings for (the label of)boundary events
in the BPMN diagram.- Specified by:
boundaryEventTextSettings
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default text settings for boundary events in the BPMN diagram.
-
collapseSubProcesses
public boolean collapseSubProcesses()
Description copied from interface:IWorkflowBpmnLayoutSettings
Whether to set theexpanded
attribute of aBPMN shape
to 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:
collapseSubProcesses
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- Whether to collapse mark subprocesses.
-
colorize
public boolean colorize()
Description copied from interface:IWorkflowBpmnLayoutSettings
When true, addscolors
to the BPMN diagram, as specified by the BPMN in Color Specification. When false, do not add colors.- Specified by:
colorize
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- True if the BPMN diagram should be colorized, false otherwise.
-
complexGatewayColor
public int complexGatewayColor()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default color forcomplex gateways
, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
complexGatewayColor
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default color for event based gateways.
-
complexGatewayHeight
public double complexGatewayHeight()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default height ofcomplex gateways
in the BPMN diagram. BPMN diagrams represent complex gateways as rhombi.- Specified by:
complexGatewayHeight
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default height of complex gateways in the BPMN diagram.
-
complexGatewayTextAnnotationDistance
public double complexGatewayTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettings
The distance between acomplex gateways
and itstext annotation
.- Specified by:
complexGatewayTextAnnotationDistance
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The distance between a complex gateway and its text annotation.
-
complexGatewayTextSettings
public WorkflowBpmnTextLayoutSettings complexGatewayTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default text settings for (the label of)complex gateways
in the BPMN diagram.- Specified by:
complexGatewayTextSettings
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default text settings for complex gateways in the BPMN diagram.
-
complexGatewayWidth
public double complexGatewayWidth()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default width ofcomplex gateways
in the BPMN diagram. BPMN diagrams represent complex gateways as rhombi.- Specified by:
complexGatewayWidth
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default width of complex gateways in the BPMN diagram.
-
crossFlowDirectionSpacing
public double crossFlowDirectionSpacing()
Description copied from interface:IWorkflowBpmnLayoutSettings
Spacing in the direction orthogonal to the flow. Flow direction here refers toIWorkflowBpmnLayoutSettings.direction()
.- Specified by:
crossFlowDirectionSpacing
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The spacing in the direction of the flow.
-
dataObjectColor
public int dataObjectColor()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default color fordata objects
, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
dataObjectColor
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default color for data objects.
-
dataObjectHeight
public double dataObjectHeight()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default height ofdata objects
in the BPMN diagram. BPMN diagrams represent data objects as rectangles.- Specified by:
dataObjectHeight
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default height of data objects in the BPMN diagram.
-
dataObjectTextAnnotationDistance
public double dataObjectTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettings
The distance between adata object
and itstext annotation
.- Specified by:
dataObjectTextAnnotationDistance
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The distance between a data object and its text annotation.
-
dataObjectTextSettings
public WorkflowBpmnTextLayoutSettings dataObjectTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default text settings for (the label of)data objects
in the BPMN diagram.- Specified by:
dataObjectTextSettings
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default text settings for data objects in the BPMN diagram.
-
dataObjectWidth
public double dataObjectWidth()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default width ofdata objects
in the BPMN diagram. BPMN diagrams represent data objects as rectangles.- Specified by:
dataObjectWidth
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default width of data objects in the BPMN diagram.
-
dataStoreColor
public int dataStoreColor()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default color fordata stores
, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
dataStoreColor
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default color for data stores.
-
dataStoreHeight
public double dataStoreHeight()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default height ofdata stores
in the BPMN diagram. BPMN diagrams represent data stores as rectangular shapes.- Specified by:
dataStoreHeight
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default height of data stores in the BPMN diagram.
-
dataStoreTextAnnotationDistance
public double dataStoreTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettings
The distance between adata store
and itstext annotation
.- Specified by:
dataStoreTextAnnotationDistance
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The distance between a data store and its text annotation.
-
dataStoreTextSettings
public WorkflowBpmnTextLayoutSettings dataStoreTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default text settings for (the label of)data stores
in the BPMN diagram.- Specified by:
dataStoreTextSettings
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default text settings for data stores in the BPMN diagram.
-
dataStoreWidth
public double dataStoreWidth()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default width ofdata stores
in the BPMN diagram. BPMN diagrams represent data stores as rectangular shapes.- Specified by:
dataStoreWidth
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default width of data stores in the BPMN diagram.
-
defaultFlowMarkerLength
public double defaultFlowMarkerLength()
Description copied from interface:IWorkflowBpmnLayoutSettings
The length from the start of adefault
sequence flow
to 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:
defaultFlowMarkerLength
in 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:IWorkflowBpmnLayoutSettings
The 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:
direction
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The direction in which the model should be laid out, never null.
-
endEventColor
public int endEventColor()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default color forend events
, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
endEventColor
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default color for end events.
-
endEventDiameter
public double endEventDiameter()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default diameter ofend events
in the BPMN diagram. BPMN diagrams represent events as circles.- Specified by:
endEventDiameter
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default diameter of events in the BPMN diagram.
-
endEventTextAnnotationDistance
public double endEventTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettings
The distance between anend event
and itstext annotation
.- Specified by:
endEventTextAnnotationDistance
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The distance between an end event and its text annotation.
-
endEventTextSettings
public WorkflowBpmnTextLayoutSettings endEventTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default text settings for (the label of)start events
in the BPMN diagram.- Specified by:
endEventTextSettings
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default text settings for end events in the BPMN diagram.
-
eventBasedGatewayColor
public int eventBasedGatewayColor()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default color forevent based gateways
, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
eventBasedGatewayColor
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default color for event based gateways.
-
eventBasedGatewayHeight
public double eventBasedGatewayHeight()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default height ofevent based gateways
in the BPMN diagram. BPMN diagrams represent event based gateways as rhombi.- Specified by:
eventBasedGatewayHeight
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default height of event based gateways in the BPMN diagram.
-
eventBasedGatewayTextAnnotationDistance
public double eventBasedGatewayTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettings
The distance between aevent based gateways
and itstext annotation
.- Specified by:
eventBasedGatewayTextAnnotationDistance
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The distance between an event based gateway and its text annotation.
-
eventBasedGatewayTextSettings
public WorkflowBpmnTextLayoutSettings eventBasedGatewayTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default text settings for (the label of)event based gateways
in the BPMN diagram.- Specified by:
eventBasedGatewayTextSettings
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default text settings for event based gateways in the BPMN diagram.
-
eventBasedGatewayWidth
public double eventBasedGatewayWidth()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default width ofevent based gateways
in the BPMN diagram. BPMN diagrams represent event based gateways as rhombi.- Specified by:
eventBasedGatewayWidth
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default width of event based gateways in the BPMN diagram.
-
exclusiveGatewayColor
public int exclusiveGatewayColor()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default color forexclusive gateways
, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
exclusiveGatewayColor
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default color for exclusive gateways.
-
exclusiveGatewayHeight
public double exclusiveGatewayHeight()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default height ofexclusive gateways
in the BPMN diagram. BPMN diagrams represent exclusive gateways as rhombi.- Specified by:
exclusiveGatewayHeight
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default height of exclusive gateways in the BPMN diagram.
-
exclusiveGatewayTextAnnotationDistance
public double exclusiveGatewayTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettings
The distance between aexclusive gateways
and itstext annotation
.- Specified by:
exclusiveGatewayTextAnnotationDistance
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The distance between an exclusive gateway and its text annotation.
-
exclusiveGatewayTextSettings
public WorkflowBpmnTextLayoutSettings exclusiveGatewayTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default text settings for (the label of)exclusive gateways
in the BPMN diagram.- Specified by:
exclusiveGatewayTextSettings
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default text settings for exclusive gateways in the BPMN diagram.
-
exclusiveGatewayWidth
public double exclusiveGatewayWidth()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default width ofexclusive gateways
in the BPMN diagram. BPMN diagrams represent exclusive gateways as rhombi.- Specified by:
exclusiveGatewayWidth
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default width of exclusive gateways in the BPMN diagram.
-
flowDirectionSpacing
public double flowDirectionSpacing()
Description copied from interface:IWorkflowBpmnLayoutSettings
Spacing in the direction of the flow. Flow direction here refers toIWorkflowBpmnLayoutSettings.direction()
.- Specified by:
flowDirectionSpacing
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The spacing in the direction of the flow.
-
fontSizeUnit
public Length fontSizeUnit()
Description copied from interface:IWorkflowBpmnLayoutSettings
The 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:
fontSizeUnit
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The unit for font sizes in the BPMN diagram.
-
inclusiveGatewayColor
public int inclusiveGatewayColor()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default color forinclusive gateways
, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
inclusiveGatewayColor
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default color for inclusive gateways.
-
inclusiveGatewayHeight
public double inclusiveGatewayHeight()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default height ofinclusive gateways
in the BPMN diagram. BPMN diagrams represent inclusive gateways as rhombi.- Specified by:
inclusiveGatewayHeight
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default height of inclusive gateways in the BPMN diagram.
-
inclusiveGatewayTextAnnotationDistance
public double inclusiveGatewayTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettings
The distance between ainclusive gateways
and itstext annotation
.- Specified by:
inclusiveGatewayTextAnnotationDistance
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The distance between an inclusive gateway and its text annotation.
-
inclusiveGatewayTextSettings
public WorkflowBpmnTextLayoutSettings inclusiveGatewayTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default text settings for (the label of)inclusive gateways
in the BPMN diagram.- Specified by:
inclusiveGatewayTextSettings
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default text settings for inclusive gateways in the BPMN diagram.
-
inclusiveGatewayWidth
public double inclusiveGatewayWidth()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default width ofinclusive gateways
in the BPMN diagram. BPMN diagrams represent inclusive gateways as rhombi.- Specified by:
inclusiveGatewayWidth
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default width of inclusive gateways in the BPMN diagram.
-
intermediateCatchEventColor
public int intermediateCatchEventColor()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default color forintermediate catch events
, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
intermediateCatchEventColor
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default color for intermediate catch events.
-
intermediateCatchEventDiameter
public double intermediateCatchEventDiameter()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default diameter ofintermediate catch events
in the BPMN diagram. BPMN diagrams represent events as circles.- Specified by:
intermediateCatchEventDiameter
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default diameter of events in the BPMN diagram.
-
intermediateCatchEventTextAnnotationDistance
public double intermediateCatchEventTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettings
The distance between anintermediate catch event
and itstext annotation
.- Specified by:
intermediateCatchEventTextAnnotationDistance
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The distance between an intermediate catch event and its text annotation.
-
intermediateCatchEventTextSettings
public WorkflowBpmnTextLayoutSettings intermediateCatchEventTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default text settings for (the label of)intermediate catch events
in the BPMN diagram.- Specified by:
intermediateCatchEventTextSettings
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default text settings for intermediate catch events in the BPMN diagram.
-
intermediateThrowEventColor
public int intermediateThrowEventColor()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default color forintermediate throw events
, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
intermediateThrowEventColor
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default color for intermediate throw events.
-
intermediateThrowEventDiameter
public double intermediateThrowEventDiameter()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default diameter ofintermediate throw events
in the BPMN diagram. BPMN diagrams represent events as circles.- Specified by:
intermediateThrowEventDiameter
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default diameter of events in the BPMN diagram.
-
intermediateThrowEventTextAnnotationDistance
public double intermediateThrowEventTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettings
The distance between anintermediate throw event
and itstext annotation
.- Specified by:
intermediateThrowEventTextAnnotationDistance
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The distance between an intermediate throw event and its text annotation.
-
intermediateThrowEventTextSettings
public WorkflowBpmnTextLayoutSettings intermediateThrowEventTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default text settings for (the label of)intermediate throw events
in the BPMN diagram.- Specified by:
intermediateThrowEventTextSettings
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default text settings for intermediate throw events in the BPMN diagram.
-
laneTextSettings
public WorkflowBpmnTextLayoutSettings laneTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default text settings for (the label of)lanes
in the BPMN diagram.- Specified by:
laneTextSettings
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default text settings for lanes in the BPMN diagram.
-
nameDistance
public double nameDistance()
Description copied from interface:IWorkflowBpmnLayoutSettings
The distance between anamed element
and its name.- Specified by:
nameDistance
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The distance between a named element and its name.
-
nonAbstractTaskMinPadding
public ICardinalDirection2DMapDouble nonAbstractTaskMinPadding()
Description copied from interface:IWorkflowBpmnLayoutSettings
The minimum amount of padding to apply tonon-abstract
tasks 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:
nonAbstractTaskMinPadding
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The minimum padding for non-abstract tasks in the BPMN diagram.
-
otherTextAnnotationDistance
public double otherTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettings
The distance between anelement
and itstext annotation
. This is used when none of the more specific distances are applicable, such asIWorkflowBpmnLayoutSettings.startEventTextAnnotationDistance()
.- Specified by:
otherTextAnnotationDistance
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The distance between an element and its text annotation.
-
parallelGatewayColor
public int parallelGatewayColor()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default color forparallel gateways
, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
parallelGatewayColor
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default color for parallel gateways.
-
parallelGatewayHeight
public double parallelGatewayHeight()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default height ofparallel gateways
in the BPMN diagram. BPMN diagrams represent parallel gateways as rhombi.- Specified by:
parallelGatewayHeight
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default height of parallel gateways in the BPMN diagram.
-
parallelGatewayTextAnnotationDistance
public double parallelGatewayTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettings
The distance between aparallel gateways
and itstext annotation
.- Specified by:
parallelGatewayTextAnnotationDistance
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The distance between a parallel gateway and its text annotation.
-
parallelGatewayTextSettings
public WorkflowBpmnTextLayoutSettings parallelGatewayTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default text settings for (the label of)parallel gateways
in the BPMN diagram.- Specified by:
parallelGatewayTextSettings
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default text settings for parallel gateways in the BPMN diagram.
-
parallelGatewayWidth
public double parallelGatewayWidth()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default width ofparallel gateways
in the BPMN diagram. BPMN diagrams represent parallel gateways as rhombi.- Specified by:
parallelGatewayWidth
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default width of parallel gateways in the BPMN diagram.
-
participantHeaderPadding
public double participantHeaderPadding()
Description copied from interface:IWorkflowBpmnLayoutSettings
The 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:
participantHeaderPadding
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The padding for the header of a participant in the BPMN diagram.
-
participantTextSettings
public WorkflowBpmnTextLayoutSettings participantTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default text settings for (the label of)participants
in the BPMN diagram.- Specified by:
participantTextSettings
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default text settings for participants in the BPMN diagram.
-
sequenceFlowColor
public int sequenceFlowColor()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default color forsequence flows
, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
sequenceFlowColor
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default color for sequence flows.
-
sequenceFlowLabelSpacing
public double sequenceFlowLabelSpacing()
Description copied from interface:IWorkflowBpmnLayoutSettings
When placing a label next to a sequence flow, the spacing between the sequence flow line and the label text.- Specified by:
sequenceFlowLabelSpacing
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The spacing between the sequence flow line and the label text.
-
sequenceFlowTextSettings
public WorkflowBpmnTextLayoutSettings sequenceFlowTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default text settings for (the label of)sequence flows
in the BPMN diagram.- Specified by:
sequenceFlowTextSettings
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default text settings for sequence flows in the BPMN diagram.
-
startEventColor
public int startEventColor()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default color forstart events
, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
startEventColor
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default color for start events.
-
startEventDiameter
public double startEventDiameter()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default diameter ofstart events
in the BPMN diagram. BPMN diagrams represent events as circles.- Specified by:
startEventDiameter
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default diameter of events in the BPMN diagram.
-
startEventTextAnnotationDistance
public double startEventTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettings
The distance between astart event
and itstext annotation
.- Specified by:
startEventTextAnnotationDistance
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The distance between a start event and its text annotation.
-
startEventTextSettings
public WorkflowBpmnTextLayoutSettings startEventTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default text settings for (the label of)start events
in the BPMN diagram.- Specified by:
startEventTextSettings
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default text settings for start events in the BPMN diagram.
-
subProcessHeaderPadding
public double subProcessHeaderPadding()
Description copied from interface:IWorkflowBpmnLayoutSettings
The padding for the header of asub process
in 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:
subProcessHeaderPadding
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The padding for the header of a sub process in the BPMN diagram.
-
subProcessNameAlignmentOffset
public double subProcessNameAlignmentOffset()
Description copied from interface:IWorkflowBpmnLayoutSettings
Controls 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:
subProcessNameAlignmentOffset
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The alignment offset of the sub process name in the BPMN diagram.
-
subProcessNameAlignmentRatio
public double subProcessNameAlignmentRatio()
Description copied from interface:IWorkflowBpmnLayoutSettings
Controls 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:
subProcessNameAlignmentRatio
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The alignment ratio of the sub process name in the BPMN diagram.
-
subProcessTextAnnotationDistance
public double subProcessTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettings
The distance between asub process
and itstext annotation
.- Specified by:
subProcessTextAnnotationDistance
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The distance between a sub process and its text annotation.
-
subProcessTextSettings
public WorkflowBpmnTextLayoutSettings subProcessTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default text settings for (the label of)sub processes
in the BPMN diagram.- Specified by:
subProcessTextSettings
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default text settings for sub processes in the BPMN diagram.
-
taskColor
public int taskColor()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default color fortasks
, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
taskColor
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default color for start events.
-
taskHeight
public double taskHeight()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default height oftasks
in the BPMN diagram. BPMN diagrams represent tasks as rectangles.- Specified by:
taskHeight
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default height of tasks in the BPMN diagram.
-
taskPadding
public ICardinalDirection2DMapDouble taskPadding()
Description copied from interface:IWorkflowBpmnLayoutSettings
The 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 annotation
TheBpmnShape
of theTask
containsBounds
, 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:
taskPadding
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The padding to apply to tasks in the BPMN diagram.
-
taskTextAnnotationDistance
public double taskTextAnnotationDistance()
Description copied from interface:IWorkflowBpmnLayoutSettings
The distance between atask
and itstext annotation
.- Specified by:
taskTextAnnotationDistance
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The distance between a task and its text annotation.
-
taskTextSettings
public WorkflowBpmnTextLayoutSettings taskTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default text settings for (the label of)tasks
in the BPMN diagram.- Specified by:
taskTextSettings
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default text settings for tasks in the BPMN diagram.
-
taskWidth
public double taskWidth()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default width oftasks
in the BPMN diagram. BPMN diagrams represent tasks as rectangles.- Specified by:
taskWidth
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default width of tasks in the BPMN diagram.
-
textAnnotationColor
public int textAnnotationColor()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default color fortext annotations
, as a hex RGB value, e.g. 0xFF0000 for red.- Specified by:
textAnnotationColor
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The default color for text annotations.
-
textAnnotationPadding
public ICardinalDirection2DMapDouble textAnnotationPadding()
Description copied from interface:IWorkflowBpmnLayoutSettings
The 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 | | | +---------------------------------------+ Task
TheBpmnShape
of theTextAnnotation
containsBounds
, 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:
textAnnotationPadding
in interfaceIWorkflowBpmnLayoutSettings
- Returns:
- The padding to apply to text annotations in the BPMN diagram.
-
textAnnotationTextSettings
public WorkflowBpmnTextLayoutSettings textAnnotationTextSettings()
Description copied from interface:IWorkflowBpmnLayoutSettings
The default text settings for (the text of)text annotations
in the BPMN diagram.- Specified by:
textAnnotationTextSettings
in 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.
-
-