Interface IWorkflowBpmnLayoutAlignmentOptionsBuilder<Self extends IWorkflowBpmnLayoutAlignmentOptionsBuilder<Self>>
-
- Type Parameters:
Self
- The type of the builder itself.
- All Known Subinterfaces:
IWorkflowBpmnLayoutAlignAtAxisBuilder
public interface IWorkflowBpmnLayoutAlignmentOptionsBuilder<Self extends IWorkflowBpmnLayoutAlignmentOptionsBuilder<Self>>
Builder for layouts that allow setting the alignment in the cross-axis when computing the layout.- Since:
- 8.4.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Self
alignAtPorts()
Aligns the items on their in and out ports, if they have any.Self
alignCenter()
Centers the items relative to the container.Self
alignCenter(Object... values)
Centers the items relative to the container.Self
alignEnd()
Aligns the items at the end of the container.Self
alignEnd(Object... values)
Aligns the items at the end of the container.Self
alignment(double... alignments)
Shortcut for setting thealignment
to anIWorkflowBpmnAlignmentSelector
that uses the given fixed positions.Self
alignment(IWorkflowBpmnAlignmentSelector alignment)
Sets the alignment to apply to the items.Self
alignStart()
Aligns the items at the start of the container.Self
alignStart(Object... values)
Aligns the items at the start of the container.
-
-
-
Method Detail
-
alignAtPorts
@CanIgnoreReturnValue Self alignAtPorts()
Aligns the items on their in and out ports, if they have any. If no port exists, uses the center of the bounding box's edge.- Returns:
- This builder for chaining method calls.
-
alignCenter
@CanIgnoreReturnValue Self alignCenter()
Centers the items relative to the container.- Returns:
- This builder for chaining method calls.
-
alignCenter
@CanIgnoreReturnValue Self alignCenter(Object... values)
Centers the items relative to the container. Similar toalignCenter()
, but for eachitem
to align, uses thebounding box
of thechild
with the givenvalue
instead.The number of values SHOULD equal the number of items to align (usually passed to the builder method). If more values are given, the additional values are ignored. If fewer values are given, uses the bounding box of the alignment item instead. If a value is null or no child with that value is found, also uses the bounding box of alignment item instead.
- Parameters:
values
- For each item to align, thevalue
of the child alignment item whose bounding box should be used for the alignment.- Returns:
- This builder for chaining method calls.
-
alignEnd
@CanIgnoreReturnValue Self alignEnd()
Aligns the items at the end of the container.- Returns:
- This builder for chaining method calls.
-
alignEnd
@CanIgnoreReturnValue Self alignEnd(Object... values)
Aligns the items at the end of the container. Similar toalignEnd()
, but for eachitem
to align, uses thebounding box
of thechild
with the givenvalue
instead.The number of values SHOULD equal the number of items to align (usually passed to the builder method). If more values are given, the additional values are ignored. If fewer values are given, uses the bounding box of the alignment item instead. If a value is null or no child with that value is found, also uses the bounding box of alignment item instead.
- Parameters:
values
- For each item to align, thevalue
of the child alignment item whose bounding box should be used for the alignment.- Returns:
- This builder for chaining method calls.
-
alignStart
@CanIgnoreReturnValue Self alignStart()
Aligns the items at the start of the container.- Returns:
- This builder for chaining method calls.
-
alignStart
@CanIgnoreReturnValue Self alignStart(Object... values)
Aligns the items at the start of the container. Similar toalignStart()
, but for eachitem
to align, uses thebounding box
of thechild
with the givenvalue
instead.The number of values SHOULD equal the number of items to align (usually passed to the builder method). If more values are given, the additional values are ignored. If fewer values are given, uses the bounding box of the alignment item instead. If a value is null or no child with that value is found, also uses the bounding box of alignment item instead.
- Parameters:
values
- For each item to align, thevalue
of the child alignment item whose bounding box should be used for the alignment.- Returns:
- This builder for chaining method calls.
-
alignment
@CanIgnoreReturnValue Self alignment(IWorkflowBpmnAlignmentSelector alignment)
Sets the alignment to apply to the items. The function is given the size of the item in the flow direction and must return a value in the interval [0, size]. For example, when the function returns size / 2, the items are centered.- Parameters:
alignment
- The alignment to apply to the items.- Returns:
- This builder for chaining method calls.
-
alignment
@CanIgnoreReturnValue Self alignment(double... alignments)
Shortcut for setting thealignment
to anIWorkflowBpmnAlignmentSelector
that uses the given fixed positions.- Parameters:
alignments
- A list of fixed positions to use for the alignment. Must contain an even number of elements. Each pair of elements is interpreted as anin
andout
port position for the alignment. You must omit the in port of the first item and the out port of the last item (as these are not used for the layout calculation).- Returns:
- This builder for chaining method calls.
-
-