Interface IWorkflowBpmnLayoutAlignAroundBuilder

All Superinterfaces:

IWorkflowBpmnLayoutCardinalDirectionOptionsBuilder<IWorkflowBpmnLayoutAlignAroundBuilder>, IWorkflowBpmnLayoutPortSelectionOptionsBuilder<IWorkflowBpmnLayoutAlignAroundBuilder, IWorkflowBpmnAlignAroundPortSelector>, IWorkflowBpmnLayoutPrimaryIntercardinalDirectionOptionsBuilder<IWorkflowBpmnLayoutAlignAroundBuilder>, IWorkflowBpmnLayoutSpacingOptionsBuilder<IWorkflowBpmnLayoutAlignAroundBuilder>

public interface IWorkflowBpmnLayoutAlignAroundBuilder
extends IWorkflowBpmnLayoutCardinalDirectionOptionsBuilder<IWorkflowBpmnLayoutAlignAroundBuilder>, IWorkflowBpmnLayoutPrimaryIntercardinalDirectionOptionsBuilder<IWorkflowBpmnLayoutAlignAroundBuilder>, IWorkflowBpmnLayoutPortSelectionOptionsBuilder<IWorkflowBpmnLayoutAlignAroundBuilder, IWorkflowBpmnAlignAroundPortSelector>, IWorkflowBpmnLayoutSpacingOptionsBuilder<IWorkflowBpmnLayoutAlignAroundBuilder>

A builder for aligning two items, with the second item positioned relative to the first item.

Since:

8.4.0

Method Summary

Modifier and Type	Method	Description
IWorkflowBpmnAlignmentItem<?,?>	build(IWorkflowBpmnAlignmentItem<?,?> firstItem, IWorkflowBpmnAlignmentItem<?,?> secondItem)	Builds the alignment item for the second item aligned around the first item.
IWorkflowBpmnLayoutAlignAroundBuilder	direction(OneOfN.Either<ECardinalDirection2D, EPrimaryIntercardinalDirection2D> direction)	Sets a hint for the direction where the second item should be placed.
IWorkflowBpmnLayoutAlignAroundBuilder	firstItemBoundingBoxOf(Object value)	By default, the position and size of the given first alignment item is used when the alignment item is built.
IWorkflowBpmnLayoutAlignAroundBuilder	secondItemBoundingBoxOf(Object value)	By default, the position and size of the given second alignment item is used when the alignment item is built.

Methods inherited from interface IWorkflowBpmnLayoutCardinalDirectionOptionsBuilder

crossFlowDirection, direction, directionRelativeToFlow, flowDirection, reverseCrossFlowDirection, reverseFlowDirection

Methods inherited from interface IWorkflowBpmnLayoutPortSelectionOptionsBuilder

inPortOfItemAt, outPortOfItemAt, ports, portsOfFirstAndLastItem, portsOfFirstAndLastItemDefaultToOppositePort, portsOfItemAt, portsOfItemAtDefaultToOppositePort

Methods inherited from interface IWorkflowBpmnLayoutPrimaryIntercardinalDirectionOptionsBuilder

direction

Methods inherited from interface IWorkflowBpmnLayoutSpacingOptionsBuilder

crossFlowDirectionSpacing, crossFlowDirectionSpacing, flowDirectionSpacing, flowDirectionSpacing, spacing

Method Details

build

IWorkflowBpmnAlignmentItem<?,?> build(IWorkflowBpmnAlignmentItem<?,?> firstItem,
 IWorkflowBpmnAlignmentItem<?,?> secondItem)

Builds the alignment item for the second item aligned around the first item.

Parameters:

firstItem - The first item to align.

secondItem - The second item to align relative to the first item.

Returns:

An alignment item representing the laid out second item around the first item.

direction

@CanIgnoreReturnValue
IWorkflowBpmnLayoutAlignAroundBuilder direction(OneOfN.Either<ECardinalDirection2D, EPrimaryIntercardinalDirection2D> direction)

Sets a hint for the direction where the second item should be placed. This is a convenience method, see IWorkflowBpmnLayoutCardinalDirectionOptionsBuilder.direction(ECardinalDirection2D) and IWorkflowBpmnLayoutPrimaryIntercardinalDirectionOptionsBuilder.direction(EPrimaryIntercardinalDirection2D) for more details.

Parameters:

direction - The direction where to put the second item relative to the first item.

Returns:

This builder for chaining method calls.

firstItemBoundingBoxOf

@CanIgnoreReturnValue
IWorkflowBpmnLayoutAlignAroundBuilder firstItemBoundingBoxOf(Object value)

By default, the position and size of the given first alignment item is used when the alignment item is built. This method lets you use a child of the first alignment item as the bounding box. This can be useful for dense layouts, e.g. when you want to align item A above item X and item B below X. You first align A above X to create AX, then align B below AX and use X's bounding box instead of AX's bounding box.

Parameters:

value - The value of the alignment item whose bounding box should be used for the item. This is the IWorkflowBpmnAlignmentItem.value() of the target alignment item.

Returns:

This builder for chaining method calls.

secondItemBoundingBoxOf

@CanIgnoreReturnValue
IWorkflowBpmnLayoutAlignAroundBuilder secondItemBoundingBoxOf(Object value)

By default, the position and size of the given second alignment item is used when the alignment item is built. This method lets you use a child of the second alignment item as the bounding box. This can be useful for dense layouts, e.g. when you want to align item A above item X and item B below X. You first align A above X to create AX, then align B below AX and use X's bounding box instead of AX's bounding box.

Parameters:

value - The value of the alignment item whose bounding box should be used for the second item. This is the IWorkflowBpmnAlignmentItem.value() of the target alignment item.

Returns:

This builder for chaining method calls.