com.yworks.yfiles.layout.seriesparallel

Class DefaultPortAssignment

java.lang.Object

com.yworks.yfiles.layout.seriesparallel.DefaultPortAssignment

All Implemented Interfaces:

IPortAssignment

public class DefaultPortAssignment
extends Object
implements IPortAssignment

DefaultPortAssignment implements the default port assignment strategy.

Ports are either placed at the center or get distributed at the sides of the node.

If PortConstraints are specified, the strong PortConstraints are handled separately and keep their initial location relative to the node while weak PortConstraints just influence on which side of the node the port is placed.

If there are edge groups specified, the edges which belong to the same group get the same port locations.

See Also:

PortConstraint, PortConstraintKeys.SOURCE_GROUP_ID_DPKEY, PortConstraintKeys.TARGET_GROUP_ID_DPKEY

Constructor Summary

Constructors

Constructor and Description
DefaultPortAssignment() Creates a new DefaultPortAssignment with default settings.
DefaultPortAssignment(PortAssignmentMode mode) Creates a new DefaultPortAssignment instance using the given mode and a given value for the ratio of the gap between the border and the ports to the gap between the ports themselves.
DefaultPortAssignment(PortAssignmentMode mode, double ratio) Creates a new DefaultPortAssignment instance using the given mode and a given value for the ratio of the gap between the border and the ports to the gap between the ports themselves.

Method Summary

Modifier and Type	Method and Description
void	assignPorts(LayoutGraph graph, Node node) Places the ports of edges connecting to the given node according to the port assignment mode.
double	getBorderGapToPortGapRatio() Gets the ratio of the border gap (distance between the outer ports and the node border) to the port gap (distance between adjacent ports).
ForkStyle	getForkStyle() Gets the fork style which influences the port assignment.
PortAssignmentMode	getMode() Gets the mode that describes how ports are placed.
protected double	getPortBorderGap(double sideLength, int edgeCount) Determines the distance between the outer ports and the border of the node.
protected double	getPortDistanceDelta(double sideLength, int edgeCount, double portBorderGap) Determines the distance between two adjacent ports.
void	setBorderGapToPortGapRatio(double value) Sets the ratio of the border gap (distance between the outer ports and the node border) to the port gap (distance between adjacent ports).
void	setForkStyle(ForkStyle value) Sets the fork style which influences the port assignment.
void	setMode(PortAssignmentMode value) Sets the mode that describes how ports are placed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultPortAssignment

public DefaultPortAssignment()

Creates a new DefaultPortAssignment with default settings.

DefaultPortAssignment

public DefaultPortAssignment(PortAssignmentMode mode)

Creates a new DefaultPortAssignment instance using the given mode and a given value for the ratio of the gap between the border and the ports to the gap between the ports themselves.

Throws:

IllegalArgumentException - if the given mode is unknown or the given ratio is negative

Parameters:

mode - one of the predefined port assignment modes

DefaultPortAssignment

public DefaultPortAssignment(PortAssignmentMode mode,
                             double ratio)

Creates a new DefaultPortAssignment instance using the given mode and a given value for the ratio of the gap between the border and the ports to the gap between the ports themselves.

Throws:

IllegalArgumentException - if the given mode is unknown or the given ratio is negative

Parameters:

mode - one of the predefined port assignment modes

ratio - the ratio of the distance between outer ports and the border to the distance between any two ports

Method Detail

assignPorts

public void assignPorts(LayoutGraph graph,
                        Node node)

Places the ports of edges connecting to the given node according to the port assignment mode.

Specified by:

assignPorts in interface IPortAssignment

Parameters:

graph - the input graph

node - the node whose adjacent edges' ports should be placed

See Also:

getMode()

getBorderGapToPortGapRatio

public double getBorderGapToPortGapRatio()

Gets the ratio of the border gap (distance between the outer ports and the node border) to the port gap (distance between adjacent ports).

The ratio must have a positive value. If the ratio is 0, the ports will be distributed along the whole side of the node without a gap between the last port and the corner.

Throws:

IllegalArgumentException - if the specified ratio is negative

This setting only affects the distributed port assignment.

Default Value:

The default value is 0.5.

Returns:

the ratio of the border gap (gap between ports and border) to the port gap (gap between two ports)

See Also:

setBorderGapToPortGapRatio(double)

getForkStyle

public ForkStyle getForkStyle()

Gets the fork style which influences the port assignment.

If the fork style is set to ForkStyle.OUTSIDE_NODE, edges without port constraints will be assigned in flow direction.

If the fork style is set to ForkStyle.AT_NODE, the ports of edges in flow direction also get distributed to the sides unless they are without bends. Due to large minimum first/last segment lengths edges may overlap.

Throws:

IllegalArgumentException - if the specified fork style is unknown

Default Value:

The default value is ForkStyle.OUTSIDE_NODE

Returns:

one of the predefined fork styles

See Also:

setForkStyle(ForkStyle)

getMode

public PortAssignmentMode getMode()

Gets the mode that describes how ports are placed.

Throws:

IllegalArgumentException - if an unknown mode is specified

Default Value:

The default value is PortAssignmentMode.CENTER

Returns:

one of the predefined port assignment modes

See Also:

setMode(PortAssignmentMode)

getPortBorderGap

protected double getPortBorderGap(double sideLength,
                                  int edgeCount)

Determines the distance between the outer ports and the border of the node.

This implementation calculates the gap according to the number of edges at one side of the node. It also includes the ratio between border gap and port gap.

This method is called by assignPorts(LayoutGraph, Node) to calculate the location of the first port. It may be overridden to implement a different distribution of ports on the node's side.

Parameters:

sideLength - the width/height of the side

edgeCount - the number of edges that connect to this side

Returns:

the absolute gap to be used on both sides of the ports

See Also:

assignPorts(LayoutGraph, Node), getBorderGapToPortGapRatio()

getPortDistanceDelta

protected double getPortDistanceDelta(double sideLength,
                                      int edgeCount,
                                      double portBorderGap)

Determines the distance between two adjacent ports.

This implementation calculates the gap according to the number of edges at one side of the node. The edges are distributed keeping the given gap to the border of the node.

This method is called by assignPorts(LayoutGraph, Node) to calculate the distance between two ports. It may be overridden to implement a different distribution of ports on the node's side.

Parameters:

sideLength - the width/height of the side

edgeCount - the number of edges/ports that connect to this side

portBorderGap - the port border gap (i.e. calculated by getPortBorderGap(double, int))

Returns:

the absolute distance to be used between two adjacent ports

See Also:

assignPorts(LayoutGraph, Node), getPortBorderGap(double, int)

setBorderGapToPortGapRatio

public void setBorderGapToPortGapRatio(double value)

Sets the ratio of the border gap (distance between the outer ports and the node border) to the port gap (distance between adjacent ports).

The ratio must have a positive value. If the ratio is 0, the ports will be distributed along the whole side of the node without a gap between the last port and the corner.

Throws:

IllegalArgumentException - if the specified ratio is negative

This setting only affects the distributed port assignment.

Default Value:

The default value is 0.5.

Parameters:

value - the ratio of the border gap (gap between ports and border) to the port gap (gap between two ports)

See Also:

getBorderGapToPortGapRatio()

setForkStyle

public void setForkStyle(ForkStyle value)

Sets the fork style which influences the port assignment.

If the fork style is set to ForkStyle.OUTSIDE_NODE, edges without port constraints will be assigned in flow direction.

If the fork style is set to ForkStyle.AT_NODE, the ports of edges in flow direction also get distributed to the sides unless they are without bends. Due to large minimum first/last segment lengths edges may overlap.

Throws:

IllegalArgumentException - if the specified fork style is unknown

Default Value:

The default value is ForkStyle.OUTSIDE_NODE

Parameters:

value - one of the predefined fork styles

See Also:

getForkStyle()

setMode

public void setMode(PortAssignmentMode value)

Sets the mode that describes how ports are placed.

Throws:

IllegalArgumentException - if an unknown mode is specified

Default Value:

The default value is PortAssignmentMode.CENTER

Parameters:

value - one of the predefined port assignment modes

See Also:

getMode()