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

Interface IWorkflowBpmnLayoutAnnotatedElementBuilder<Self extends IWorkflowBpmnLayoutAnnotatedElementBuilder<Self>>

    • Method Detail

      • annotation

        Self annotation​(String annotation)
        Sets the text for the annotation of the BPMN element. When not set, no text annotation will be created.
        Parameters:
        annotation - The annotation text to set.
        Returns:
        This builder for chaining method calls.

      • annotation

        Self annotation​(StyledBpmnLabel annotation)
        Sets the text for the annotation of the BPMN element. When not set, no text annotation will be created.
        Parameters:
        annotation - The annotation text to set.
        Returns:
        This builder for chaining method calls.

      • annotationDirection

        Self annotationDirection​(EPrimaryIntercardinalDirection2D direction)
        Sets the direction where the text annotation should be placed. For example, when set to NORTH_EAST, the text annotation will be placed diagonally above and to the right of the element it annotates. Defaults to a direction that is suitable for the current flow direction.
        Parameters:
        direction - The direction where the text annotation should be placed.
        Returns:
        This builder for chaining method calls.

      • annotationDirection

        Self annotationDirection​(ECardinalDirection2D direction)
        Sets the direction where the text annotation should be placed. For example, when set to NORTH, the text annotation will be placed above the element it annotates. Defaults to a direction that is suitable for the current flow direction.
        Parameters:
        direction - The direction where the text annotation should be placed.
        Returns:
        This builder for chaining method calls.

      • annotationDirection

        Self annotationDirection​(EBpmnTextAnnotationDirectionHint direction)
        Sets a hint for the direction where the text annotation should be placed. This hint is used in combination with the flow direction of the BPMN diagram to determine the default placement of the text annotation. For example, when set to STRAIGHT and the flow direction is EAST, the text annotation is placed above the element it annotates. When the direction hint is set to DIAGONAL, the text annotation is placed diagonally above and to the left of the element it annotates.
        Parameters:
        direction - The direction where the text annotation should be placed.
        Returns:
        This builder for chaining method calls.

      • annotationSpacing

        Self annotationSpacing​(double spacing)
        Sets the spacing between the text annotation and the element it annotates. Defaults to the default text annotation spacing for the given type of element, e.g. the start event text annotation distance.
        Parameters:
        spacing - The spacing to set, in pixels.
        Returns:
        This builder for chaining method calls.

      • annotationTextLayoutSettings

        Self annotationTextLayoutSettings​(WorkflowBpmnTextLayoutSettings textLayoutSettings)
        Sets the text layout settings for the annotation text. Defaults to the default text annotation text settings.
        Parameters:
        textLayoutSettings - The text layout settings to apply to the annotation text.
        Returns:
        This builder for chaining method calls.