Package de.xima.fc.interfaces.workflow.bpmn

Interface IWorkflowBpmnLayoutSettings

  • All Superinterfaces:
    Serializable
    All Known Implementing Classes:
    WorkflowBpmnLayoutSettings
    public interface IWorkflowBpmnLayoutSettings
extends Serializable
    Layout settings that affect how the BPMN diagram for the workflow is created.
    Since:
    8.4.0

    • Method Detail

      • associationColor

        int associationColor()
        The default color for associations, as a hex RGB value, e.g. 0xFF0000 for red.
        Returns:
        The default color for associations.

      • boundaryEventColor

        int boundaryEventColor()
        The default color for boundary events, as a hex RGB value, e.g. 0xFF0000 for red.
        Returns:
        The default color for boundary events.

      • boundaryEventDiameter

        double boundaryEventDiameter()
        The default diameter of boundary events in the BPMN diagram. BPMN diagrams represent events as circles.
        Returns:
        The default diameter of events in the BPMN diagram.

      • boundaryEventTextAnnotationDistance

        double boundaryEventTextAnnotationDistance()
        The distance between a boundary event and its text annotation.
        Returns:
        The distance between a boundary event and its text annotation.

      • boundaryEventTextSettings

        WorkflowBpmnTextLayoutSettings boundaryEventTextSettings()
        The default text settings for (the label of) boundary events in the BPMN diagram.
        Returns:
        The default text settings for boundary events in the BPMN diagram.

      • collapseSubProcesses

        boolean collapseSubProcesses()
        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.
        Returns:
        Whether to collapse mark subprocesses.

      • colorize

        boolean colorize()
        When true, adds colors to the BPMN diagram, as specified by the BPMN in Color Specification. When false, do not add colors.
        Returns:
        True if the BPMN diagram should be colorized, false otherwise.

      • complexGatewayColor

        int complexGatewayColor()
        The default color for complex gateways, as a hex RGB value, e.g. 0xFF0000 for red.
        Returns:
        The default color for event based gateways.

      • complexGatewayHeight

        double complexGatewayHeight()
        The default height of complex gateways in the BPMN diagram. BPMN diagrams represent complex gateways as rhombi.
        Returns:
        The default height of complex gateways in the BPMN diagram.

      • complexGatewayTextAnnotationDistance

        double complexGatewayTextAnnotationDistance()
        The distance between a complex gateways and its text annotation.
        Returns:
        The distance between a complex gateway and its text annotation.

      • complexGatewayTextSettings

        WorkflowBpmnTextLayoutSettings complexGatewayTextSettings()
        The default text settings for (the label of) complex gateways in the BPMN diagram.
        Returns:
        The default text settings for complex gateways in the BPMN diagram.

      • complexGatewayWidth

        double complexGatewayWidth()
        The default width of complex gateways in the BPMN diagram. BPMN diagrams represent complex gateways as rhombi.
        Returns:
        The default width of complex gateways in the BPMN diagram.

      • crossFlowDirectionSpacing

        double crossFlowDirectionSpacing()
        Spacing in the direction orthogonal to the flow. Flow direction here refers to direction().
        Returns:
        The spacing in the direction of the flow.

      • dataObjectColor

        int dataObjectColor()
        The default color for data objects, as a hex RGB value, e.g. 0xFF0000 for red.
        Returns:
        The default color for data objects.

      • dataObjectHeight

        double dataObjectHeight()
        The default height of data objects in the BPMN diagram. BPMN diagrams represent data objects as rectangles.
        Returns:
        The default height of data objects in the BPMN diagram.

      • dataObjectTextAnnotationDistance

        double dataObjectTextAnnotationDistance()
        The distance between a data object and its text annotation.
        Returns:
        The distance between a data object and its text annotation.

      • dataObjectTextSettings

        WorkflowBpmnTextLayoutSettings dataObjectTextSettings()
        The default text settings for (the label of) data objects in the BPMN diagram.
        Returns:
        The default text settings for data objects in the BPMN diagram.

      • dataObjectWidth

        double dataObjectWidth()
        The default width of data objects in the BPMN diagram. BPMN diagrams represent data objects as rectangles.
        Returns:
        The default width of data objects in the BPMN diagram.

      • dataStoreColor

        int dataStoreColor()
        The default color for data stores, as a hex RGB value, e.g. 0xFF0000 for red.
        Returns:
        The default color for data stores.

      • dataStoreHeight

        double dataStoreHeight()
        The default height of data stores in the BPMN diagram. BPMN diagrams represent data stores as rectangular shapes.
        Returns:
        The default height of data stores in the BPMN diagram.

      • dataStoreTextAnnotationDistance

        double dataStoreTextAnnotationDistance()
        The distance between a data store and its text annotation.
        Returns:
        The distance between a data store and its text annotation.

      • dataStoreTextSettings

        WorkflowBpmnTextLayoutSettings dataStoreTextSettings()
        The default text settings for (the label of) data stores in the BPMN diagram.
        Returns:
        The default text settings for data stores in the BPMN diagram.

      • dataStoreWidth

        double dataStoreWidth()
        The default width of data stores in the BPMN diagram. BPMN diagrams represent data stores as rectangular shapes.
        Returns:
        The default width of data stores in the BPMN diagram.

      • defaultFlowMarkerLength

        double defaultFlowMarkerLength()
        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.
        Returns:
        The default length from the start of a flow to the end of the default flow marker.

      • direction

        ECardinalDirection2D direction()
        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
   |
   |
   |
        Returns:
        The direction in which the model should be laid out, never null.

      • endEventColor

        int endEventColor()
        The default color for end events, as a hex RGB value, e.g. 0xFF0000 for red.
        Returns:
        The default color for end events.

      • endEventDiameter

        double endEventDiameter()
        The default diameter of end events in the BPMN diagram. BPMN diagrams represent events as circles.
        Returns:
        The default diameter of events in the BPMN diagram.

      • endEventTextAnnotationDistance

        double endEventTextAnnotationDistance()
        The distance between an end event and its text annotation.
        Returns:
        The distance between an end event and its text annotation.

      • endEventTextSettings

        WorkflowBpmnTextLayoutSettings endEventTextSettings()
        The default text settings for (the label of) start events in the BPMN diagram.
        Returns:
        The default text settings for end events in the BPMN diagram.

      • eventBasedGatewayColor

        int eventBasedGatewayColor()
        The default color for event based gateways, as a hex RGB value, e.g. 0xFF0000 for red.
        Returns:
        The default color for event based gateways.

      • eventBasedGatewayHeight

        double eventBasedGatewayHeight()
        The default height of event based gateways in the BPMN diagram. BPMN diagrams represent event based gateways as rhombi.
        Returns:
        The default height of event based gateways in the BPMN diagram.

      • eventBasedGatewayTextAnnotationDistance

        double eventBasedGatewayTextAnnotationDistance()
        The distance between a event based gateways and its text annotation.
        Returns:
        The distance between an event based gateway and its text annotation.

      • eventBasedGatewayTextSettings

        WorkflowBpmnTextLayoutSettings eventBasedGatewayTextSettings()
        The default text settings for (the label of) event based gateways in the BPMN diagram.
        Returns:
        The default text settings for event based gateways in the BPMN diagram.

      • eventBasedGatewayWidth

        double eventBasedGatewayWidth()
        The default width of event based gateways in the BPMN diagram. BPMN diagrams represent event based gateways as rhombi.
        Returns:
        The default width of event based gateways in the BPMN diagram.

      • exclusiveGatewayColor

        int exclusiveGatewayColor()
        The default color for exclusive gateways, as a hex RGB value, e.g. 0xFF0000 for red.
        Returns:
        The default color for exclusive gateways.

      • exclusiveGatewayHeight

        double exclusiveGatewayHeight()
        The default height of exclusive gateways in the BPMN diagram. BPMN diagrams represent exclusive gateways as rhombi.
        Returns:
        The default height of exclusive gateways in the BPMN diagram.

      • exclusiveGatewayTextAnnotationDistance

        double exclusiveGatewayTextAnnotationDistance()
        The distance between a exclusive gateways and its text annotation.
        Returns:
        The distance between an exclusive gateway and its text annotation.

      • exclusiveGatewayTextSettings

        WorkflowBpmnTextLayoutSettings exclusiveGatewayTextSettings()
        The default text settings for (the label of) exclusive gateways in the BPMN diagram.
        Returns:
        The default text settings for exclusive gateways in the BPMN diagram.

      • exclusiveGatewayWidth

        double exclusiveGatewayWidth()
        The default width of exclusive gateways in the BPMN diagram. BPMN diagrams represent exclusive gateways as rhombi.
        Returns:
        The default width of exclusive gateways in the BPMN diagram.

      • flowDirectionSpacing

        double flowDirectionSpacing()
        Spacing in the direction of the flow. Flow direction here refers to direction().
        Returns:
        The spacing in the direction of the flow.

      • fontSizeUnit

        Length fontSizeUnit()
        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.
        Returns:
        The unit for font sizes in the BPMN diagram.

      • inclusiveGatewayColor

        int inclusiveGatewayColor()
        The default color for inclusive gateways, as a hex RGB value, e.g. 0xFF0000 for red.
        Returns:
        The default color for inclusive gateways.

      • inclusiveGatewayHeight

        double inclusiveGatewayHeight()
        The default height of inclusive gateways in the BPMN diagram. BPMN diagrams represent inclusive gateways as rhombi.
        Returns:
        The default height of inclusive gateways in the BPMN diagram.

      • inclusiveGatewayTextAnnotationDistance

        double inclusiveGatewayTextAnnotationDistance()
        The distance between a inclusive gateways and its text annotation.
        Returns:
        The distance between an inclusive gateway and its text annotation.

      • inclusiveGatewayTextSettings

        WorkflowBpmnTextLayoutSettings inclusiveGatewayTextSettings()
        The default text settings for (the label of) inclusive gateways in the BPMN diagram.
        Returns:
        The default text settings for inclusive gateways in the BPMN diagram.

      • inclusiveGatewayWidth

        double inclusiveGatewayWidth()
        The default width of inclusive gateways in the BPMN diagram. BPMN diagrams represent inclusive gateways as rhombi.
        Returns:
        The default width of inclusive gateways in the BPMN diagram.

      • intermediateCatchEventColor

        int intermediateCatchEventColor()
        The default color for intermediate catch events, as a hex RGB value, e.g. 0xFF0000 for red.
        Returns:
        The default color for intermediate catch events.

      • intermediateCatchEventDiameter

        double intermediateCatchEventDiameter()
        The default diameter of intermediate catch events in the BPMN diagram. BPMN diagrams represent events as circles.
        Returns:
        The default diameter of events in the BPMN diagram.

      • intermediateCatchEventTextAnnotationDistance

        double intermediateCatchEventTextAnnotationDistance()
        The distance between an intermediate catch event and its text annotation.
        Returns:
        The distance between an intermediate catch event and its text annotation.

      • intermediateCatchEventTextSettings

        WorkflowBpmnTextLayoutSettings intermediateCatchEventTextSettings()
        The default text settings for (the label of) intermediate catch events in the BPMN diagram.
        Returns:
        The default text settings for intermediate catch events in the BPMN diagram.

      • intermediateThrowEventColor

        int intermediateThrowEventColor()
        The default color for intermediate throw events, as a hex RGB value, e.g. 0xFF0000 for red.
        Returns:
        The default color for intermediate throw events.

      • intermediateThrowEventDiameter

        double intermediateThrowEventDiameter()
        The default diameter of intermediate throw events in the BPMN diagram. BPMN diagrams represent events as circles.
        Returns:
        The default diameter of events in the BPMN diagram.

      • intermediateThrowEventTextAnnotationDistance

        double intermediateThrowEventTextAnnotationDistance()
        The distance between an intermediate throw event and its text annotation.
        Returns:
        The distance between an intermediate throw event and its text annotation.

      • intermediateThrowEventTextSettings

        WorkflowBpmnTextLayoutSettings intermediateThrowEventTextSettings()
        The default text settings for (the label of) intermediate throw events in the BPMN diagram.
        Returns:
        The default text settings for intermediate throw events in the BPMN diagram.

      • laneTextSettings

        WorkflowBpmnTextLayoutSettings laneTextSettings()
        The default text settings for (the label of) lanes in the BPMN diagram.
        Returns:
        The default text settings for lanes in the BPMN diagram.

      • nameDistance

        double nameDistance()
        The distance between a named element and its name.
        Returns:
        The distance between a named element and its name.

      • nonAbstractTaskMinPadding

        ICardinalDirection2DMapDouble nonAbstractTaskMinPadding()
        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.
        Returns:
        The minimum padding for non-abstract tasks in the BPMN diagram.

      • otherTextAnnotationDistance

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

      • parallelGatewayColor

        int parallelGatewayColor()
        The default color for parallel gateways, as a hex RGB value, e.g. 0xFF0000 for red.
        Returns:
        The default color for parallel gateways.

      • parallelGatewayHeight

        double parallelGatewayHeight()
        The default height of parallel gateways in the BPMN diagram. BPMN diagrams represent parallel gateways as rhombi.
        Returns:
        The default height of parallel gateways in the BPMN diagram.

      • parallelGatewayTextAnnotationDistance

        double parallelGatewayTextAnnotationDistance()
        The distance between a parallel gateways and its text annotation.
        Returns:
        The distance between a parallel gateway and its text annotation.

      • parallelGatewayTextSettings

        WorkflowBpmnTextLayoutSettings parallelGatewayTextSettings()
        The default text settings for (the label of) parallel gateways in the BPMN diagram.
        Returns:
        The default text settings for parallel gateways in the BPMN diagram.

      • parallelGatewayWidth

        double parallelGatewayWidth()
        The default width of parallel gateways in the BPMN diagram. BPMN diagrams represent parallel gateways as rhombi.
        Returns:
        The default width of parallel gateways in the BPMN diagram.

      • participantHeaderPadding

        double participantHeaderPadding()
        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.
        Returns:
        The padding for the header of a participant in the BPMN diagram.

      • participantTextSettings

        WorkflowBpmnTextLayoutSettings participantTextSettings()
        The default text settings for (the label of) participants in the BPMN diagram.
        Returns:
        The default text settings for participants in the BPMN diagram.

      • sequenceFlowColor

        int sequenceFlowColor()
        The default color for sequence flows, as a hex RGB value, e.g. 0xFF0000 for red.
        Returns:
        The default color for sequence flows.

      • sequenceFlowLabelSpacing

        double sequenceFlowLabelSpacing()
        When placing a label next to a sequence flow, the spacing between the sequence flow line and the label text.
        Returns:
        The spacing between the sequence flow line and the label text.

      • sequenceFlowTextSettings

        WorkflowBpmnTextLayoutSettings sequenceFlowTextSettings()
        The default text settings for (the label of) sequence flows in the BPMN diagram.
        Returns:
        The default text settings for sequence flows in the BPMN diagram.

      • startEventColor

        int startEventColor()
        The default color for start events, as a hex RGB value, e.g. 0xFF0000 for red.
        Returns:
        The default color for start events.

      • startEventDiameter

        double startEventDiameter()
        The default diameter of start events in the BPMN diagram. BPMN diagrams represent events as circles.
        Returns:
        The default diameter of events in the BPMN diagram.

      • startEventTextAnnotationDistance

        double startEventTextAnnotationDistance()
        The distance between a start event and its text annotation.
        Returns:
        The distance between a start event and its text annotation.

      • startEventTextSettings

        WorkflowBpmnTextLayoutSettings startEventTextSettings()
        The default text settings for (the label of) start events in the BPMN diagram.
        Returns:
        The default text settings for start events in the BPMN diagram.

      • subProcessHeaderPadding

        double subProcessHeaderPadding()
        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.
        Returns:
        The padding for the header of a sub process in the BPMN diagram.

      • subProcessNameAlignmentOffset

        double subProcessNameAlignmentOffset()
        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.
        Returns:
        The alignment offset of the sub process name in the BPMN diagram.

      • subProcessNameAlignmentRatio

        double subProcessNameAlignmentRatio()
        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.
        Returns:
        The alignment ratio of the sub process name in the BPMN diagram.

      • subProcessTextAnnotationDistance

        double subProcessTextAnnotationDistance()
        The distance between a sub process and its text annotation.
        Returns:
        The distance between a sub process and its text annotation.

      • subProcessTextSettings

        WorkflowBpmnTextLayoutSettings subProcessTextSettings()
        The default text settings for (the label of) sub processes in the BPMN diagram.
        Returns:
        The default text settings for sub processes in the BPMN diagram.

      • taskColor

        int taskColor()
        The default color for tasks, as a hex RGB value, e.g. 0xFF0000 for red.
        Returns:
        The default color for start events.

      • taskHeight

        double taskHeight()
        The default height of tasks in the BPMN diagram. BPMN diagrams represent tasks as rectangles.
        Returns:
        The default height of tasks in the BPMN diagram.

      • taskPadding

        ICardinalDirection2DMapDouble taskPadding()
        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).
        Returns:
        The padding to apply to tasks in the BPMN diagram.

      • taskTextAnnotationDistance

        double taskTextAnnotationDistance()
        The distance between a task and its text annotation.
        Returns:
        The distance between a task and its text annotation.

      • taskTextSettings

        WorkflowBpmnTextLayoutSettings taskTextSettings()
        The default text settings for (the label of) tasks in the BPMN diagram.
        Returns:
        The default text settings for tasks in the BPMN diagram.

      • taskWidth

        double taskWidth()
        The default width of tasks in the BPMN diagram. BPMN diagrams represent tasks as rectangles.
        Returns:
        The default width of tasks in the BPMN diagram.

      • textAnnotationColor

        int textAnnotationColor()
        The default color for text annotations, as a hex RGB value, e.g. 0xFF0000 for red.
        Returns:
        The default color for text annotations.

      • textAnnotationPadding

        ICardinalDirection2DMapDouble textAnnotationPadding()
        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).
        Returns:
        The padding to apply to text annotations in the BPMN diagram.

      • textAnnotationTextSettings

        WorkflowBpmnTextLayoutSettings textAnnotationTextSettings()
        The default text settings for (the text of) text annotations in the BPMN diagram.
        Returns:
        The default text settings for text annotations in the BPMN diagram.