org.modelio.api.modelio.diagram

Interface ILinkRouteBuilder.BendPoints

Enclosing interface:

ILinkRouteBuilder

public static interface ILinkRouteBuilder.BendPoints

ILinkRouteBuilder at bend points state.

User may add bend points or fixed bend points using the helper methods.

Finish and apply the route with apply().

Since:

5.1.0

Method Summary

Modifier and Type	Method and Description
ILinkRouteBuilder.BendPoints	addBendPoint(Point loc) Create a new bend point.
default ILinkRouteBuilder.BendPoints	addBendPoints(java.util.Collection<Point> points) Add many bend points at once.
ILinkRouteBuilder.BendPoints	addFixedPoint(Point loc) Create a new fixed bend point.
default ILinkRouteBuilder.BendPoints	addFixedPoints(java.util.Collection<Point> points) Add many fixed bend points at once.
ILinkRouteBuilder.BendPoints	addHorizontalSegment(int nextBendPointX, boolean fixed) Add one horizontal segment with y aligned with previous point.
ILinkRouteBuilder.BendPoints	addVerticalSegment(int nextBendPointY, boolean fixed) Add one vertical segment with x aligned with previous point.
void	apply() Build the route and apply it to the connection it was created from.
ILinkRouteBuilder.BendPoints	finishHorizontalThenVertical(boolean fixed) Add 2 segment : one horizontal with y aligned with previous point, one vertical with x aligned with target anchor.
ILinkRouteBuilder.BendPoints	finishVerticalThenHorizontal(boolean fixed) Add 2 segment : one vertical with x aligned with previous point, one horizontal with y aligned with target anchor.
java.util.List<ILinkPoint>	getAllPoints() Get a direct access to all points of the connection.

Method Detail

getAllPoints

java.util.List<ILinkPoint> getAllPoints()

Get a direct access to all points of the connection.

The returned list is a direct reference, modifying it modifies the ILinkRoute. It does not modify the connection from which this path was built. The path must be applied to the IDiagramLink.setRoute(ILinkRoute).

Returns:

the points in coordinates relative to the diagram.

addBendPoint

ILinkRouteBuilder.BendPoints addBendPoint(Point loc)

Create a new bend point.

Parameters:

loc - the point location

Returns:

the route builder to use for next steps.

addFixedPoint

ILinkRouteBuilder.BendPoints addFixedPoint(Point loc)

Create a new fixed bend point.

Parameters:

loc - the point location

Returns:

the route builder to use for next steps.

addHorizontalSegment

ILinkRouteBuilder.BendPoints addHorizontalSegment(int nextBendPointX,
                                                  boolean fixed)

Add one horizontal segment with y aligned with previous point.

Parameters:

nextBendPointX - the bend point X position.

fixed - true to make the bend point is fixed.

Returns:

this route instance

addVerticalSegment

ILinkRouteBuilder.BendPoints addVerticalSegment(int nextBendPointY,
                                                boolean fixed)

Add one vertical segment with x aligned with previous point.

Parameters:

nextBendPointY - the bend point Y position.

fixed - true to make the bend point is fixed.

Returns:

this route instance

finishHorizontalThenVertical

ILinkRouteBuilder.BendPoints finishHorizontalThenVertical(boolean fixed)

Add 2 segment : one horizontal with y aligned with previous point, one vertical with x aligned with target anchor.

You should call apply() after this method.

Parameters:

fixed - true to make the bend point is fixed.

Returns:

this route instance

finishVerticalThenHorizontal

ILinkRouteBuilder.BendPoints finishVerticalThenHorizontal(boolean fixed)

Add 2 segment : one vertical with x aligned with previous point, one horizontal with y aligned with target anchor.

You should call apply() after this method.

Parameters:

fixed - true to make the bend point is fixed.

Returns:

this route instance

apply

void apply()

Build the route and apply it to the connection it was created from.

addBendPoints

default ILinkRouteBuilder.BendPoints addBendPoints(java.util.Collection<Point> points)

Add many bend points at once.

Parameters:

points - the bend points locations.

Returns:

this route instance

addFixedPoints

default ILinkRouteBuilder.BendPoints addFixedPoints(java.util.Collection<Point> points)

Add many fixed bend points at once.

Parameters:

points - the bend points locations.

Returns:

this route instance