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 TypeMethodDescriptionnameDirection(ECardinalDirection2D direction) Sets the direction where the text annotation should be placed.nameDirection(EPrimaryIntercardinalDirection2D direction) Sets the direction where the name should be placed.nameDirection(EBpmnNameDirectionHint direction) Sets a hint for the direction where the name should be placed.nameSpacing(double spacing) Sets the spacing between the name and the BPMN element.Methods inherited from interface IWorkflowBpmnLayoutNamedBuilder
name, name, nameTextLayoutSettings
-
Method Details
-
nameDirection
Sets the direction where the name should be placed. For example, when set toNORTH_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
Sets the direction where the text annotation should be placed. For example, when set toNORTH, 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
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 toFLOW_STARTand the flow direction isSOUTH, the name is placed above the element. When the direction hint is set toWITHIN_FLOW, the name is placed to the left of the element. When set toFLOW_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
Sets the spacing between the name and the BPMN element. Defaults to thedefault name spacing for that element.- Parameters:
spacing- The new spacing between the element and the name.- Returns:
- This builder for chaining method calls.
-