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 of IWorkflowBpmnLayoutSettings with a builder.

Since:

8.4.0

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	WorkflowBpmnLayoutSettings.Builder	Simple builder for a WorkflowBpmnLayoutSettings instance.

Method Summary

Modifier and Type	Method	Description
int	associationColor()	The default color for associations, as a hex RGB value, e.g. 0xFF0000 for red.
int	boundaryEventColor()	The default color for boundary events, as a hex RGB value, e.g. 0xFF0000 for red.
double	boundaryEventDiameter()	The default diameter of boundary events in the BPMN diagram.
double	boundaryEventTextAnnotationDistance()	The distance between a boundary event and its text 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 the expanded attribute of a BPMN shape to false for SubProcess.
boolean	colorize()	When true, adds colors to the BPMN diagram, as specified by the BPMN in Color Specification.
int	complexGatewayColor()	The default color for complex gateways, as a hex RGB value, e.g. 0xFF0000 for red.
double	complexGatewayHeight()	The default height of complex gateways in the BPMN diagram.
double	complexGatewayTextAnnotationDistance()	The distance between a complex gateways and its text annotation.
WorkflowBpmnTextLayoutSettings	complexGatewayTextSettings()	The default text settings for (the label of) complex gateways in the BPMN diagram.
double	complexGatewayWidth()	The default width of complex gateways in the BPMN diagram.
double	crossFlowDirectionSpacing()	Spacing in the direction orthogonal to the flow.
int	dataObjectColor()	The default color for data objects, as a hex RGB value, e.g. 0xFF0000 for red.
double	dataObjectHeight()	The default height of data objects in the BPMN diagram.
double	dataObjectTextAnnotationDistance()	The distance between a data object and its text annotation.
WorkflowBpmnTextLayoutSettings	dataObjectTextSettings()	The default text settings for (the label of) data objects in the BPMN diagram.
double	dataObjectWidth()	The default width of data objects in the BPMN diagram.
int	dataStoreColor()	The default color for data stores, as a hex RGB value, e.g. 0xFF0000 for red.
double	dataStoreHeight()	The default height of data stores in the BPMN diagram.
double	dataStoreTextAnnotationDistance()	The distance between a data store and its text annotation.
WorkflowBpmnTextLayoutSettings	dataStoreTextSettings()	The default text settings for (the label of) data stores in the BPMN diagram.
double	dataStoreWidth()	The default width of data stores in the BPMN diagram.
double	defaultFlowMarkerLength()	The length from the start of a default 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 for end events, as a hex RGB value, e.g. 0xFF0000 for red.
double	endEventDiameter()	The default diameter of end events in the BPMN diagram.
double	endEventTextAnnotationDistance()	The distance between an end event and its text annotation.
WorkflowBpmnTextLayoutSettings	endEventTextSettings()	The default text settings for (the label of) start events in the BPMN diagram.
int	eventBasedGatewayColor()	The default color for event based gateways, as a hex RGB value, e.g. 0xFF0000 for red.
double	eventBasedGatewayHeight()	The default height of event based gateways in the BPMN diagram.
double	eventBasedGatewayTextAnnotationDistance()	The distance between a event based gateways and its text annotation.
WorkflowBpmnTextLayoutSettings	eventBasedGatewayTextSettings()	The default text settings for (the label of) event based gateways in the BPMN diagram.
double	eventBasedGatewayWidth()	The default width of event based gateways in the BPMN diagram.
int	exclusiveGatewayColor()	The default color for exclusive gateways, as a hex RGB value, e.g. 0xFF0000 for red.
double	exclusiveGatewayHeight()	The default height of exclusive gateways in the BPMN diagram.
double	exclusiveGatewayTextAnnotationDistance()	The distance between a exclusive gateways and its text annotation.
WorkflowBpmnTextLayoutSettings	exclusiveGatewayTextSettings()	The default text settings for (the label of) exclusive gateways in the BPMN diagram.
double	exclusiveGatewayWidth()	The default width of exclusive 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 for inclusive gateways, as a hex RGB value, e.g. 0xFF0000 for red.
double	inclusiveGatewayHeight()	The default height of inclusive gateways in the BPMN diagram.
double	inclusiveGatewayTextAnnotationDistance()	The distance between a inclusive gateways and its text annotation.
WorkflowBpmnTextLayoutSettings	inclusiveGatewayTextSettings()	The default text settings for (the label of) inclusive gateways in the BPMN diagram.
double	inclusiveGatewayWidth()	The default width of inclusive gateways in the BPMN diagram.
int	intermediateCatchEventColor()	The default color for intermediate catch events, as a hex RGB value, e.g. 0xFF0000 for red.
double	intermediateCatchEventDiameter()	The default diameter of intermediate catch events in the BPMN diagram.
double	intermediateCatchEventTextAnnotationDistance()	The distance between an intermediate catch event and its text annotation.
WorkflowBpmnTextLayoutSettings	intermediateCatchEventTextSettings()	The default text settings for (the label of) intermediate catch events in the BPMN diagram.
int	intermediateThrowEventColor()	The default color for intermediate throw events, as a hex RGB value, e.g. 0xFF0000 for red.
double	intermediateThrowEventDiameter()	The default diameter of intermediate throw events in the BPMN diagram.
double	intermediateThrowEventTextAnnotationDistance()	The distance between an intermediate throw event and its text 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 a named element and its name.
ICardinalDirection2DMapDouble	nonAbstractTaskMinPadding()	The minimum amount of padding to apply to non-abstract tasks in the BPMN diagram.
double	otherTextAnnotationDistance()	The distance between an element and its text annotation.
int	parallelGatewayColor()	The default color for parallel gateways, as a hex RGB value, e.g. 0xFF0000 for red.
double	parallelGatewayHeight()	The default height of parallel gateways in the BPMN diagram.
double	parallelGatewayTextAnnotationDistance()	The distance between a parallel gateways and its text annotation.
WorkflowBpmnTextLayoutSettings	parallelGatewayTextSettings()	The default text settings for (the label of) parallel gateways in the BPMN diagram.
double	parallelGatewayWidth()	The default width of parallel gateways in the BPMN diagram.
double	participantHeaderPadding()	The padding for the header of a participant (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 for sequence flows, as a hex RGB value, e.g. 0xFF0000 for red.
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 for start events, as a hex RGB value, e.g. 0xFF0000 for red.
double	startEventDiameter()	The default diameter of start events in the BPMN diagram.
double	startEventTextAnnotationDistance()	The distance between a start event and its text 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 a sub process in the BPMN diagram.
double	subProcessNameAlignmentOffset()	Controls the alignment of a sub process's name in the BPMN diagram in the horizontal direction, together with subProcessNameAlignmentRatio.
double	subProcessNameAlignmentRatio()	Controls the alignment of a sub process's name in the BPMN diagram in the horizontal direction, together with subProcessNameAlignmentOffset.
double	subProcessTextAnnotationDistance()	The distance between a sub process and its text annotation.
WorkflowBpmnTextLayoutSettings	subProcessTextSettings()	The default text settings for (the label of) sub processes in the BPMN diagram.
int	taskColor()	The default color for tasks, as a hex RGB value, e.g. 0xFF0000 for red.
double	taskHeight()	The default height of tasks in the BPMN diagram.
ICardinalDirection2DMapDouble	taskPadding()	The padding to apply to tasks in the BPMN diagram.
double	taskTextAnnotationDistance()	The distance between a task and its text annotation.
WorkflowBpmnTextLayoutSettings	taskTextSettings()	The default text settings for (the label of) tasks in the BPMN diagram.
double	taskWidth()	The default width of tasks in the BPMN diagram.
int	textAnnotationColor()	The default color for text annotations, as a hex RGB value, e.g. 0xFF0000 for red.
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.

Methods inherited from class Object

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

Method Details

associationColor

public int associationColor()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default color for associations, as a hex RGB value, e.g. 0xFF0000 for red.

Specified by:

associationColor in interface IWorkflowBpmnLayoutSettings

Returns:

The default color for associations.

boundaryEventColor

public int boundaryEventColor()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default color for boundary events, as a hex RGB value, e.g. 0xFF0000 for red.

Specified by:

boundaryEventColor in interface IWorkflowBpmnLayoutSettings

Returns:

The default color for boundary events.

boundaryEventDiameter

public double boundaryEventDiameter()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default diameter of boundary events in the BPMN diagram. BPMN diagrams represent events as circles.

Specified by:

boundaryEventDiameter in interface IWorkflowBpmnLayoutSettings

Returns:

The default diameter of events in the BPMN diagram.

boundaryEventTextAnnotationDistance

public double boundaryEventTextAnnotationDistance()

Description copied from interface: IWorkflowBpmnLayoutSettings

The distance between a boundary event and its text annotation.

Specified by:

boundaryEventTextAnnotationDistance in interface IWorkflowBpmnLayoutSettings

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 interface IWorkflowBpmnLayoutSettings

Returns:

The default text settings for boundary events in the BPMN diagram.

collapseSubProcesses

public boolean collapseSubProcesses()

Description copied from interface: IWorkflowBpmnLayoutSettings

Whether to set the expanded attribute of a BPMN shape to false for SubProcess. 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 interface IWorkflowBpmnLayoutSettings

Returns:

Whether to collapse mark subprocesses.

colorize

public boolean colorize()

Description copied from interface: IWorkflowBpmnLayoutSettings

When true, adds colors to the BPMN diagram, as specified by the BPMN in Color Specification. When false, do not add colors.

Specified by:

colorize in interface IWorkflowBpmnLayoutSettings

Returns:

True if the BPMN diagram should be colorized, false otherwise.

complexGatewayColor

public int complexGatewayColor()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default color for complex gateways, as a hex RGB value, e.g. 0xFF0000 for red.

Specified by:

complexGatewayColor in interface IWorkflowBpmnLayoutSettings

Returns:

The default color for event based gateways.

complexGatewayHeight

public double complexGatewayHeight()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default height of complex gateways in the BPMN diagram. BPMN diagrams represent complex gateways as rhombi.

Specified by:

complexGatewayHeight in interface IWorkflowBpmnLayoutSettings

Returns:

The default height of complex gateways in the BPMN diagram.

complexGatewayTextAnnotationDistance

public double complexGatewayTextAnnotationDistance()

Description copied from interface: IWorkflowBpmnLayoutSettings

The distance between a complex gateways and its text annotation.

Specified by:

complexGatewayTextAnnotationDistance in interface IWorkflowBpmnLayoutSettings

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 interface IWorkflowBpmnLayoutSettings

Returns:

The default text settings for complex gateways in the BPMN diagram.

complexGatewayWidth

public double complexGatewayWidth()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default width of complex gateways in the BPMN diagram. BPMN diagrams represent complex gateways as rhombi.

Specified by:

complexGatewayWidth in interface IWorkflowBpmnLayoutSettings

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 to IWorkflowBpmnLayoutSettings.direction().

Specified by:

crossFlowDirectionSpacing in interface IWorkflowBpmnLayoutSettings

Returns:

The spacing in the direction of the flow.

dataObjectColor

public int dataObjectColor()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default color for data objects, as a hex RGB value, e.g. 0xFF0000 for red.

Specified by:

dataObjectColor in interface IWorkflowBpmnLayoutSettings

Returns:

The default color for data objects.

dataObjectHeight

public double dataObjectHeight()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default height of data objects in the BPMN diagram. BPMN diagrams represent data objects as rectangles.

Specified by:

dataObjectHeight in interface IWorkflowBpmnLayoutSettings

Returns:

The default height of data objects in the BPMN diagram.

dataObjectTextAnnotationDistance

public double dataObjectTextAnnotationDistance()

Description copied from interface: IWorkflowBpmnLayoutSettings

The distance between a data object and its text annotation.

Specified by:

dataObjectTextAnnotationDistance in interface IWorkflowBpmnLayoutSettings

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 interface IWorkflowBpmnLayoutSettings

Returns:

The default text settings for data objects in the BPMN diagram.

dataObjectWidth

public double dataObjectWidth()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default width of data objects in the BPMN diagram. BPMN diagrams represent data objects as rectangles.

Specified by:

dataObjectWidth in interface IWorkflowBpmnLayoutSettings

Returns:

The default width of data objects in the BPMN diagram.

dataStoreColor

public int dataStoreColor()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default color for data stores, as a hex RGB value, e.g. 0xFF0000 for red.

Specified by:

dataStoreColor in interface IWorkflowBpmnLayoutSettings

Returns:

The default color for data stores.

dataStoreHeight

public double dataStoreHeight()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default height of data stores in the BPMN diagram. BPMN diagrams represent data stores as rectangular shapes.

Specified by:

dataStoreHeight in interface IWorkflowBpmnLayoutSettings

Returns:

The default height of data stores in the BPMN diagram.

dataStoreTextAnnotationDistance

public double dataStoreTextAnnotationDistance()

Description copied from interface: IWorkflowBpmnLayoutSettings

The distance between a data store and its text annotation.

Specified by:

dataStoreTextAnnotationDistance in interface IWorkflowBpmnLayoutSettings

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 interface IWorkflowBpmnLayoutSettings

Returns:

The default text settings for data stores in the BPMN diagram.

dataStoreWidth

public double dataStoreWidth()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default width of data stores in the BPMN diagram. BPMN diagrams represent data stores as rectangular shapes.

Specified by:

dataStoreWidth in interface IWorkflowBpmnLayoutSettings

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 a default 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 interface IWorkflowBpmnLayoutSettings

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 the axis, and in the specified direction.

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 interface IWorkflowBpmnLayoutSettings

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 for end events, as a hex RGB value, e.g. 0xFF0000 for red.

Specified by:

endEventColor in interface IWorkflowBpmnLayoutSettings

Returns:

The default color for end events.

endEventDiameter

public double endEventDiameter()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default diameter of end events in the BPMN diagram. BPMN diagrams represent events as circles.

Specified by:

endEventDiameter in interface IWorkflowBpmnLayoutSettings

Returns:

The default diameter of events in the BPMN diagram.

endEventTextAnnotationDistance

public double endEventTextAnnotationDistance()

Description copied from interface: IWorkflowBpmnLayoutSettings

The distance between an end event and its text annotation.

Specified by:

endEventTextAnnotationDistance in interface IWorkflowBpmnLayoutSettings

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 interface IWorkflowBpmnLayoutSettings

Returns:

The default text settings for end events in the BPMN diagram.

eventBasedGatewayColor

public int eventBasedGatewayColor()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default color for event based gateways, as a hex RGB value, e.g. 0xFF0000 for red.

Specified by:

eventBasedGatewayColor in interface IWorkflowBpmnLayoutSettings

Returns:

The default color for event based gateways.

eventBasedGatewayHeight

public double eventBasedGatewayHeight()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default height of event based gateways in the BPMN diagram. BPMN diagrams represent event based gateways as rhombi.

Specified by:

eventBasedGatewayHeight in interface IWorkflowBpmnLayoutSettings

Returns:

The default height of event based gateways in the BPMN diagram.

eventBasedGatewayTextAnnotationDistance

public double eventBasedGatewayTextAnnotationDistance()

Description copied from interface: IWorkflowBpmnLayoutSettings

The distance between a event based gateways and its text annotation.

Specified by:

eventBasedGatewayTextAnnotationDistance in interface IWorkflowBpmnLayoutSettings

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 interface IWorkflowBpmnLayoutSettings

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 of event based gateways in the BPMN diagram. BPMN diagrams represent event based gateways as rhombi.

Specified by:

eventBasedGatewayWidth in interface IWorkflowBpmnLayoutSettings

Returns:

The default width of event based gateways in the BPMN diagram.

exclusiveGatewayColor

public int exclusiveGatewayColor()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default color for exclusive gateways, as a hex RGB value, e.g. 0xFF0000 for red.

Specified by:

exclusiveGatewayColor in interface IWorkflowBpmnLayoutSettings

Returns:

The default color for exclusive gateways.

exclusiveGatewayHeight

public double exclusiveGatewayHeight()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default height of exclusive gateways in the BPMN diagram. BPMN diagrams represent exclusive gateways as rhombi.

Specified by:

exclusiveGatewayHeight in interface IWorkflowBpmnLayoutSettings

Returns:

The default height of exclusive gateways in the BPMN diagram.

exclusiveGatewayTextAnnotationDistance

public double exclusiveGatewayTextAnnotationDistance()

Description copied from interface: IWorkflowBpmnLayoutSettings

The distance between a exclusive gateways and its text annotation.

Specified by:

exclusiveGatewayTextAnnotationDistance in interface IWorkflowBpmnLayoutSettings

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 interface IWorkflowBpmnLayoutSettings

Returns:

The default text settings for exclusive gateways in the BPMN diagram.

exclusiveGatewayWidth

public double exclusiveGatewayWidth()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default width of exclusive gateways in the BPMN diagram. BPMN diagrams represent exclusive gateways as rhombi.

Specified by:

exclusiveGatewayWidth in interface IWorkflowBpmnLayoutSettings

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 to IWorkflowBpmnLayoutSettings.direction().

Specified by:

flowDirectionSpacing in interface IWorkflowBpmnLayoutSettings

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 interface IWorkflowBpmnLayoutSettings

Returns:

The unit for font sizes in the BPMN diagram.

inclusiveGatewayColor

public int inclusiveGatewayColor()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default color for inclusive gateways, as a hex RGB value, e.g. 0xFF0000 for red.

Specified by:

inclusiveGatewayColor in interface IWorkflowBpmnLayoutSettings

Returns:

The default color for inclusive gateways.

inclusiveGatewayHeight

public double inclusiveGatewayHeight()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default height of inclusive gateways in the BPMN diagram. BPMN diagrams represent inclusive gateways as rhombi.

Specified by:

inclusiveGatewayHeight in interface IWorkflowBpmnLayoutSettings

Returns:

The default height of inclusive gateways in the BPMN diagram.

inclusiveGatewayTextAnnotationDistance

public double inclusiveGatewayTextAnnotationDistance()

Description copied from interface: IWorkflowBpmnLayoutSettings

The distance between a inclusive gateways and its text annotation.

Specified by:

inclusiveGatewayTextAnnotationDistance in interface IWorkflowBpmnLayoutSettings

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 interface IWorkflowBpmnLayoutSettings

Returns:

The default text settings for inclusive gateways in the BPMN diagram.

inclusiveGatewayWidth

public double inclusiveGatewayWidth()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default width of inclusive gateways in the BPMN diagram. BPMN diagrams represent inclusive gateways as rhombi.

Specified by:

inclusiveGatewayWidth in interface IWorkflowBpmnLayoutSettings

Returns:

The default width of inclusive gateways in the BPMN diagram.

intermediateCatchEventColor

public int intermediateCatchEventColor()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default color for intermediate catch events, as a hex RGB value, e.g. 0xFF0000 for red.

Specified by:

intermediateCatchEventColor in interface IWorkflowBpmnLayoutSettings

Returns:

The default color for intermediate catch events.

intermediateCatchEventDiameter

public double intermediateCatchEventDiameter()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default diameter of intermediate catch events in the BPMN diagram. BPMN diagrams represent events as circles.

Specified by:

intermediateCatchEventDiameter in interface IWorkflowBpmnLayoutSettings

Returns:

The default diameter of events in the BPMN diagram.

intermediateCatchEventTextAnnotationDistance

public double intermediateCatchEventTextAnnotationDistance()

Description copied from interface: IWorkflowBpmnLayoutSettings

The distance between an intermediate catch event and its text annotation.

Specified by:

intermediateCatchEventTextAnnotationDistance in interface IWorkflowBpmnLayoutSettings

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 interface IWorkflowBpmnLayoutSettings

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 for intermediate throw events, as a hex RGB value, e.g. 0xFF0000 for red.

Specified by:

intermediateThrowEventColor in interface IWorkflowBpmnLayoutSettings

Returns:

The default color for intermediate throw events.

intermediateThrowEventDiameter

public double intermediateThrowEventDiameter()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default diameter of intermediate throw events in the BPMN diagram. BPMN diagrams represent events as circles.

Specified by:

intermediateThrowEventDiameter in interface IWorkflowBpmnLayoutSettings

Returns:

The default diameter of events in the BPMN diagram.

intermediateThrowEventTextAnnotationDistance

public double intermediateThrowEventTextAnnotationDistance()

Description copied from interface: IWorkflowBpmnLayoutSettings

The distance between an intermediate throw event and its text annotation.

Specified by:

intermediateThrowEventTextAnnotationDistance in interface IWorkflowBpmnLayoutSettings

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 interface IWorkflowBpmnLayoutSettings

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 interface IWorkflowBpmnLayoutSettings

Returns:

The default text settings for lanes in the BPMN diagram.

nameDistance

public double nameDistance()

Description copied from interface: IWorkflowBpmnLayoutSettings

The distance between a named element and its name.

Specified by:

nameDistance in interface IWorkflowBpmnLayoutSettings

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 to non-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 interface IWorkflowBpmnLayoutSettings

Returns:

The minimum padding for non-abstract tasks in the BPMN diagram.

otherTextAnnotationDistance

public double otherTextAnnotationDistance()

Description copied from interface: IWorkflowBpmnLayoutSettings

The distance between an element and its text annotation. This is used when none of the more specific distances are applicable, such as IWorkflowBpmnLayoutSettings.startEventTextAnnotationDistance().

Specified by:

otherTextAnnotationDistance in interface IWorkflowBpmnLayoutSettings

Returns:

The distance between an element and its text annotation.

parallelGatewayColor

public int parallelGatewayColor()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default color for parallel gateways, as a hex RGB value, e.g. 0xFF0000 for red.

Specified by:

parallelGatewayColor in interface IWorkflowBpmnLayoutSettings

Returns:

The default color for parallel gateways.

parallelGatewayHeight

public double parallelGatewayHeight()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default height of parallel gateways in the BPMN diagram. BPMN diagrams represent parallel gateways as rhombi.

Specified by:

parallelGatewayHeight in interface IWorkflowBpmnLayoutSettings

Returns:

The default height of parallel gateways in the BPMN diagram.

parallelGatewayTextAnnotationDistance

public double parallelGatewayTextAnnotationDistance()

Description copied from interface: IWorkflowBpmnLayoutSettings

The distance between a parallel gateways and its text annotation.

Specified by:

parallelGatewayTextAnnotationDistance in interface IWorkflowBpmnLayoutSettings

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 interface IWorkflowBpmnLayoutSettings

Returns:

The default text settings for parallel gateways in the BPMN diagram.

parallelGatewayWidth

public double parallelGatewayWidth()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default width of parallel gateways in the BPMN diagram. BPMN diagrams represent parallel gateways as rhombi.

Specified by:

parallelGatewayWidth in interface IWorkflowBpmnLayoutSettings

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 a participant (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 the flow 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 interface IWorkflowBpmnLayoutSettings

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 interface IWorkflowBpmnLayoutSettings

Returns:

The default text settings for participants in the BPMN diagram.

sequenceFlowColor

public int sequenceFlowColor()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default color for sequence flows, as a hex RGB value, e.g. 0xFF0000 for red.

Specified by:

sequenceFlowColor in interface IWorkflowBpmnLayoutSettings

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 interface IWorkflowBpmnLayoutSettings

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 interface IWorkflowBpmnLayoutSettings

Returns:

The default text settings for sequence flows in the BPMN diagram.

startEventColor

public int startEventColor()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default color for start events, as a hex RGB value, e.g. 0xFF0000 for red.

Specified by:

startEventColor in interface IWorkflowBpmnLayoutSettings

Returns:

The default color for start events.

startEventDiameter

public double startEventDiameter()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default diameter of start events in the BPMN diagram. BPMN diagrams represent events as circles.

Specified by:

startEventDiameter in interface IWorkflowBpmnLayoutSettings

Returns:

The default diameter of events in the BPMN diagram.

startEventTextAnnotationDistance

public double startEventTextAnnotationDistance()

Description copied from interface: IWorkflowBpmnLayoutSettings

The distance between a start event and its text annotation.

Specified by:

startEventTextAnnotationDistance in interface IWorkflowBpmnLayoutSettings

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 interface IWorkflowBpmnLayoutSettings

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 a sub 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 interface IWorkflowBpmnLayoutSettings

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 a sub process's name in the BPMN diagram in the horizontal direction, together with subProcessNameAlignmentRatio. 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 interface IWorkflowBpmnLayoutSettings

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 a sub process's name in the BPMN diagram in the horizontal direction, together with subProcessNameAlignmentOffset. 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 interface IWorkflowBpmnLayoutSettings

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 a sub process and its text annotation.

Specified by:

subProcessTextAnnotationDistance in interface IWorkflowBpmnLayoutSettings

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 interface IWorkflowBpmnLayoutSettings

Returns:

The default text settings for sub processes in the BPMN diagram.

taskColor

public int taskColor()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default color for tasks, as a hex RGB value, e.g. 0xFF0000 for red.

Specified by:

taskColor in interface IWorkflowBpmnLayoutSettings

Returns:

The default color for start events.

taskHeight

public double taskHeight()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default height of tasks in the BPMN diagram. BPMN diagrams represent tasks as rectangles.

Specified by:

taskHeight in interface IWorkflowBpmnLayoutSettings

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

The BpmnShape of the Task contains Bounds, these describe the size of the task box, including the padding. The BPMN shape also contains a BpmnLabel, which also contains nested Bounds, these describe the size of the label text inside the text box (without the padding).

Specified by:

taskPadding in interface IWorkflowBpmnLayoutSettings

Returns:

The padding to apply to tasks in the BPMN diagram.

taskTextAnnotationDistance

public double taskTextAnnotationDistance()

Description copied from interface: IWorkflowBpmnLayoutSettings

The distance between a task and its text annotation.

Specified by:

taskTextAnnotationDistance in interface IWorkflowBpmnLayoutSettings

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 interface IWorkflowBpmnLayoutSettings

Returns:

The default text settings for tasks in the BPMN diagram.

taskWidth

public double taskWidth()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default width of tasks in the BPMN diagram. BPMN diagrams represent tasks as rectangles.

Specified by:

taskWidth in interface IWorkflowBpmnLayoutSettings

Returns:

The default width of tasks in the BPMN diagram.

textAnnotationColor

public int textAnnotationColor()

Description copied from interface: IWorkflowBpmnLayoutSettings

The default color for text annotations, as a hex RGB value, e.g. 0xFF0000 for red.

Specified by:

textAnnotationColor in interface IWorkflowBpmnLayoutSettings

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

The BpmnShape of the TextAnnotation contains Bounds, which describe the size of the text annotation box, including the padding. The BPMN shape also contains a BpmnLabel, which also contains nested Bounds, which describe the size of the text inside the annotation box (without the padding).

Specified by:

textAnnotationPadding in interface IWorkflowBpmnLayoutSettings

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 interface IWorkflowBpmnLayoutSettings

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.