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

Interface IWorkflowBpmnLayoutNamedOutsideBuilder<Self extends IWorkflowBpmnLayoutNamedOutsideBuilder<Self>>

Type Parameters:

Self - The type of the builder itself, for fluent API chaining.

All Superinterfaces:

IWorkflowBpmnLayoutNamedBuilder<Self>

All Known Subinterfaces:

IWorkflowBpmnLayoutDataObjectBuilder, IWorkflowBpmnLayoutDataStoreBuilder, IWorkflowBpmnLayoutEventBuilder, IWorkflowBpmnLayoutGatewayBuilder

public interface IWorkflowBpmnLayoutNamedOutsideBuilder<Self extends IWorkflowBpmnLayoutNamedOutsideBuilder<Self>>
extends IWorkflowBpmnLayoutNamedBuilder<Self>

Interface for layout builders of BPMN elements that can have an external name that gets placed outside the element, such as Event or Gateway.

Since:

8.4.0

Method Summary

Modifier and Type	Method	Description
Self	nameDirection(ECardinalDirection2D direction)	Sets the direction where the text annotation should be placed.
Self	nameDirection(EPrimaryIntercardinalDirection2D direction)	Sets the direction where the name should be placed.
Self	nameDirection(EBpmnNameDirectionHint direction)	Sets a hint for the direction where the name should be placed.
Self	nameSpacing(double spacing)	Sets the spacing between the name and the BPMN element.

Methods inherited from interface de.xima.fc.interfaces.workflow.bpmn.IWorkflowBpmnLayoutNamedBuilder

name, name, nameTextLayoutSettings

Method Detail

nameDirection

Self nameDirection(EPrimaryIntercardinalDirection2D direction)

Sets the direction where the name 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.

nameDirection

Self nameDirection(ECardinalDirection2D direction)

Sets the direction where the text annotation should be placed. For example, when set to NORTH, the name 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.

nameDirection

Self nameDirection(EBpmnNameDirectionHint direction)

Sets a hint for the direction where the name should be placed. This hint is used in combination with the flow direction of the BPMN diagram to determine the default placement of the name. For example, when set to FLOW_START and the flow direction is SOUTH, the name is placed above the element. When the direction hint is set to WITHIN_FLOW, the name is placed to the left of the element. When set to FLOW_END, the name gets placed below the element it annotates.

Parameters:

direction - The direction where the text annotation should be placed.

Returns:

This builder for chaining method calls.

nameSpacing

Self nameSpacing(double spacing)

Sets the spacing between the name and the BPMN element. Defaults to the default name spacing for that element.

Parameters:

spacing - The new spacing between the element and the name.

Returns:

This builder for chaining method calls.