Interface IBinarySelectionGatewayFlowLabelHelperBuilder

public interface IBinarySelectionGatewayFlowLabelHelperBuilder
A builder for a flow label helper for binary selection gateways, i.e. gateways with two branches, usually an if and an else branch. Helps to position the labels for the names of the two SequenceFlow that emerge from the gateway. See layouter.alignBinarySelectionGatewayFlowLabel for more details.
Since:
8.4.0

  • Method Details

    • alternateAfterPadding

      IBinarySelectionGatewayFlowLabelHelperBuilder alternateAfterPadding(double alternateAfterPadding)
      The padding after the alternate label, in the alternate direction. Defaults to a value based on the current flow direction.
      Parameters:
      alternateAfterPadding - The padding after the alternate label, in the alternate direction.
      Returns:
      This builder for chaining method calls.

    • alternateBetweenPadding

      IBinarySelectionGatewayFlowLabelHelperBuilder alternateBetweenPadding(double alternateBetweenPadding)
      The padding between the two labels, in the alternate direction. Defaults to a value based on the current flow direction.
      Parameters:
      alternateBetweenPadding - The padding between the two labels in the alternate direction.
      Returns:
      This builder for chaining method calls.

    • alternateDirection

      IBinarySelectionGatewayFlowLabelHelperBuilder alternateDirection(ECardinalDirection2D alternateDirection)
      The direction where the outgoing sequence flow that connects to the alternate branch leaves the diverging gateway. Note: Must be compatible with the alignment direction of the consequent with the alternate branch, and with the alignment direction of the gateway with the body. consequentSpacing and alternateSpacing will throw an IllegalStateException otherwise. Defaults to a values based on the current flow direction.
      Parameters:
      alternateDirection - The direction of the sequence flow that connects to the alternate branch.
      Returns:
      This builder for chaining method calls.

    • alternateHasDefaultMarker

      IBinarySelectionGatewayFlowLabelHelperBuilder alternateHasDefaultMarker(boolean alternateHasDefaultMarker)
      Whether the alternate branch has a default marker. Defaults to true.
      Parameters:
      alternateHasDefaultMarker - Whether the alternate branch has a default marker.
      Returns:
      This builder for chaining method calls.

    • alternateOffset

      IBinarySelectionGatewayFlowLabelHelperBuilder alternateOffset(double alternateOffset)
      The offset for the text on the sequence flow leading to the alternate branch of the diverging gateway. The label is placed at the beginning of the sequence flow line, and this offset can be used to move the label further down the flow line.
      Returns:
      This builder for chaining method calls.

    • alternateSpacing

      IBinarySelectionGatewayFlowLabelHelperBuilder alternateSpacing(double alternateSpacing)
      The spacing for the text on the sequence flow leading to the alternate branch of the diverging gateway. The spacing is the distance between the flow line and the start of the text.
      Parameters:
      alternateSpacing - The spacing for the text on the sequence flow leading to the alternate branch of the diverging gateway.
      Returns:
      This builder for chaining method calls.

    • alternateText

      IBinarySelectionGatewayFlowLabelHelperBuilder alternateText(String alternateText)
      The text to be displayed on the sequence flow leading to the alternate branch of the diverging gateway.
      Parameters:
      alternateText - The text to be displayed on the sequence flow leading to the alternate branch of the diverging gateway.
      Returns:
      This builder for chaining method calls.

    • alternateTextLayoutSettings

      IBinarySelectionGatewayFlowLabelHelperBuilder alternateTextLayoutSettings(WorkflowBpmnTextLayoutSettings alternateTextLayoutSettings)
      The text layout settings to be used for the text on the sequence flow leading to the alternate branch of the diverging gateway. Defaults to the default sequence flow text layout settings.
      Parameters:
      alternateTextLayoutSettings - The text layout settings to be used for the alternate text.
      Returns:
      This builder for chaining method calls.

    • build

      IBinarySelectionGatewayFlowLabelHelper build(IWorkflowBpmnAlignmentItem<? extends de.xima.bpmn_model.api.element.bpmn.gateways.Gateway<?>, ?> divergingGateway)
      Creates a new flow label helper for the given diverging gateway, with the current settings of this builder.
      Parameters:
      divergingGateway - The diverging gateway from which the consequent and alternate sequence flows emerge.
      Returns:
      A new flow label helper for the diverging gateway.

    • consequentAfterPadding

      IBinarySelectionGatewayFlowLabelHelperBuilder consequentAfterPadding(double consequentAfterPadding)
      The padding after the consequent label, in the consequent direction. Defaults to a value based on the current flow direction.
      Parameters:
      consequentAfterPadding - The padding after the consequent label, in the consequent direction.
      Returns:
      This builder for chaining method calls.

    • consequentDirection

      IBinarySelectionGatewayFlowLabelHelperBuilder consequentDirection(ECardinalDirection2D consequentDirection)
      The direction where the outgoing sequence flow that connects to the consequent branch leaves the diverging gateway. Note: Must be compatible with the alignment direction of the consequent with the alternate branch, and with the alignment direction of the gateway with the body. consequentSpacing and alternateSpacing will throw an IllegalStateException otherwise. Defaults to a value based on the current flow direction.
      Parameters:
      consequentDirection - The direction of the sequence flow that connects to the consequent branch.
      Returns:
      This builder for chaining method calls.

    • consequentHasDefaultMarker

      IBinarySelectionGatewayFlowLabelHelperBuilder consequentHasDefaultMarker(boolean consequentHasDefaultMarker)
      Whether the consequent branch has a default marker. Defaults to false.
      Parameters:
      consequentHasDefaultMarker - Whether the consequent branch has a default marker.
      Returns:
      This builder for chaining method calls.

    • consequentOffset

      IBinarySelectionGatewayFlowLabelHelperBuilder consequentOffset(double consequentOffset)
      The offset for the text on the sequence flow leading to the consequent branch of the diverging gateway. The label is placed at the beginning of the sequence flow line, and this offset can be used to move the label further down the flow line.
      Parameters:
      consequentOffset - The offset for the text on the sequence flow leading to the consequent branch of the diverging gateway.
      Returns:
      This builder for chaining method calls.

    • consequentSpacing

      IBinarySelectionGatewayFlowLabelHelperBuilder consequentSpacing(double consequentSpacing)
      The spacing for the text on the sequence flow leading to the consequent branch of the diverging gateway. The spacing is the distance between the flow line and the start of the text.
      Parameters:
      consequentSpacing - The spacing for the text on the sequence flow leading to the consequent branch of the diverging gateway.
      Returns:
      This builder for chaining method calls.

    • consequentText

      IBinarySelectionGatewayFlowLabelHelperBuilder consequentText(String consequentText)
      The text to be displayed on the sequence flow leading to the consequent branch of the diverging gateway.
      Parameters:
      consequentText - The text to be displayed on the sequence flow leading to the consequent branch of the diverging gateway.
      Returns:
      This builder for chaining method calls.

    • consequentTextLayoutSettings

      IBinarySelectionGatewayFlowLabelHelperBuilder consequentTextLayoutSettings(WorkflowBpmnTextLayoutSettings consequentTextLayoutSettings)
      The text layout settings to be used for the text on the sequence flow leading to the consequent branch of the diverging gateway. Defaults to the default sequence flow text layout settings.
      Parameters:
      consequentTextLayoutSettings - The text layout settings to be used for the consequent text.
      Returns:
      This builder for chaining method calls.

    • minBranchesSpacing

      IBinarySelectionGatewayFlowLabelHelperBuilder minBranchesSpacing(double minBranchesSpacing)
      The minimum spacing between the two branches of the diverging gateway. This is the distance between the consequent and alternate parts. The spacing may be increased when the labels are too big to fit otherwise.
      Parameters:
      minBranchesSpacing - The minimum spacing between the two branches of the diverging gateway.
      Returns:
      This builder for chaining method calls.

    • minGatewayBodySpacing

      IBinarySelectionGatewayFlowLabelHelperBuilder minGatewayBodySpacing(double minGatewayBodySpacing)
      The minimum spacing between the diverging gateway and the body. The body is the combination of the consequent and alternate branches of the diverging gateway. The spacing may be increased when the labels are too big to fit otherwise.
      Parameters:
      minGatewayBodySpacing - The minimum spacing between the diverging gateway and the body of the gateway.
      Returns:
      This builder for chaining method calls.

    • textLayoutSettings

      IBinarySelectionGatewayFlowLabelHelperBuilder textLayoutSettings(WorkflowBpmnTextLayoutSettings textLayoutSettings)
      Convenience method to set both the consequentTextLayoutSettings and the alternateTextLayoutSettings to the same value.
      Parameters:
      textLayoutSettings - The text layout settings to be used for both the consequent and alternate text.
      Returns:
      This builder for chaining method calls.