com.yworks.yfiles.layout.tree

Class DefaultPortAssignment

java.lang.Object

com.yworks.yfiles.layout.tree.DefaultPortAssignment

All Implemented Interfaces:

IPortAssignment

public class DefaultPortAssignment
extends Object
implements IPortAssignment

The DefaultPortAssignment provides some simple port assignment styles.

Ports are either centered on the node, distributed at one side of the node or placed considering PortConstraints.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	assignChildEdgeSourcePort(LayoutGraph graph, Node node, Edge edge, int index) Assigns relative coordinates to the source port of the outgoing edge to a child of the given node.
protected void	assignParentEdgeTargetPort(LayoutGraph graph, Node node, Edge edge) Assigns relative coordinates to the target port of the incoming edge from the parent of the given node.
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 to the node border) to the port gap (distance between adjacent ports).
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.
protected PortConstraint	getSourcePortConstraint(LayoutGraph graph, Edge edge, int index) Retrieves the source PortConstraint for the given edge.
protected PortConstraint	getTargetPortConstraint(LayoutGraph graph, Edge edge) Retrieves the target PortConstraint for the given edge.
boolean	isReversedPortOrderEnabled() Gets whether or not the port assignment should reverse the order of the ports.
void	setBorderGapToPortGapRatio(double value) Sets the ratio of the border gap (distance between the outer ports to the node border) to the port gap (distance between adjacent ports).
void	setMode(PortAssignmentMode value) Sets the mode that describes how ports are placed.
void	setReversedPortOrderEnabled(boolean value) Sets whether or not the port assignment should reverse the order of the ports.

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 instance with default settings.

DefaultPortAssignment

public DefaultPortAssignment(PortAssignmentMode mode)

Creates a new DefaultPortAssignment instance using the given port assignment mode and ratio between the border and the ports and the gap between the ports themselves.

Throws:

IllegalArgumentException - if an unknown mode is specified or if the specified ratio is negative

Parameters:

mode - one of the predefined port assignment specifiers

DefaultPortAssignment

public DefaultPortAssignment(PortAssignmentMode mode,
                             double ratio)

Creates a new DefaultPortAssignment instance using the given port assignment mode and ratio between the border and the ports and the gap between the ports themselves.

Throws:

IllegalArgumentException - if an unknown mode is specified or if the specified ratio is negative

Parameters:

mode - one of the predefined port assignment specifiers

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

Method Detail

assignChildEdgeSourcePort

protected void assignChildEdgeSourcePort(LayoutGraph graph,
                                         Node node,
                                         Edge edge,
                                         int index)

Assigns relative coordinates to the source port of the outgoing edge to a child of the given node.

This method is called by assignPorts(LayoutGraph, Node) for each outgoing edge of the given node. It may be overridden to assign a custom location to the source port of outgoing edges.

This implementation considers PortConstraints despite the port assignment mode.

Parameters:

graph - the input graph

node - the node

edge - the edge to the child node

index - the zero-based index of the child edge

See Also:

IEdgeLayout.setSourcePoint(YPoint)

assignParentEdgeTargetPort

protected void assignParentEdgeTargetPort(LayoutGraph graph,
                                          Node node,
                                          Edge edge)

Assigns relative coordinates to the target port of the incoming edge from the parent of the given node.

This method is called by assignPorts(LayoutGraph, Node) if the given node has a parent node. It may be overridden to assign a custom location to the target port of the incoming edge.

This implementation considers PortConstraints despite the port assignment mode.

Parameters:

graph - the input graph

node - the node

edge - the edge from the parent node

See Also:

IEdgeLayout.setTargetPoint(YPoint)

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 to the node border) to the port gap (distance between adjacent ports).

The ratio must have a positive value. When 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 distributed port assignments (e.g. PortAssignmentMode.DISTRIBUTED_NORTH).

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)

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.NONE

Returns:

one of the predefined port assignment specifiers

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 assignChildEdgeSourcePort(LayoutGraph, Node, Edge, int) 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:

assignChildEdgeSourcePort(LayoutGraph, Node, Edge, int), 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 assignChildEdgeSourcePort(LayoutGraph, Node, Edge, int) 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:

assignChildEdgeSourcePort(LayoutGraph, Node, Edge, int), getPortBorderGap(double, int)

getSourcePortConstraint

protected PortConstraint getSourcePortConstraint(LayoutGraph graph,
                                                 Edge edge,
                                                 int index)

Retrieves the source PortConstraint for the given edge.

This implementation accesses the IDataProvider registered with PortConstraintKeys.SOURCE_PORT_CONSTRAINT_DPKEY.

This method is called by assignChildEdgeSourcePort(LayoutGraph, Node, Edge, int) in PortAssignmentMode.PORT_CONSTRAINT.

Parameters:

graph - the input graph

edge - the edge

index - the index of the child that is the target of the given edge

Returns:

the source PortConstraint or null if no source PortConstraint is specified

See Also:

PortConstraint, PortConstraintKeys.SOURCE_PORT_CONSTRAINT_DPKEY, assignChildEdgeSourcePort(LayoutGraph, Node, Edge, int)

getTargetPortConstraint

protected PortConstraint getTargetPortConstraint(LayoutGraph graph,
                                                 Edge edge)

Retrieves the target PortConstraint for the given edge.

This implementation accesses the IDataProvider registered with PortConstraintKeys.SOURCE_PORT_CONSTRAINT_DPKEY.

This method is called by assignParentEdgeTargetPort(LayoutGraph, Node, Edge) in PortAssignmentMode.PORT_CONSTRAINT.

Parameters:

graph - the input graph

edge - the edge

Returns:

the target PortConstraint or null if no target PortConstraint is specified

See Also:

PortConstraint, PortConstraintKeys.TARGET_PORT_CONSTRAINT_DPKEY, assignParentEdgeTargetPort(LayoutGraph, Node, Edge)

isReversedPortOrderEnabled

public boolean isReversedPortOrderEnabled()

Gets whether or not the port assignment should reverse the order of the ports.

The normal order is from left to right and from top to bottom. It will be reversed if this option is enabled.

This setting only affects distributed port assignment (e.g. PortAssignmentMode.DISTRIBUTED_NORTH).

Default Value:

The default value is false. The normal order is used for the ports.

Returns:

true if the order of the ports are reversed, false otherwise

See Also:

setReversedPortOrderEnabled(boolean)

setBorderGapToPortGapRatio

public void setBorderGapToPortGapRatio(double value)

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

The ratio must have a positive value. When 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 distributed port assignments (e.g. PortAssignmentMode.DISTRIBUTED_NORTH).

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()

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.NONE

Parameters:

value - one of the predefined port assignment specifiers

See Also:

getMode()

setReversedPortOrderEnabled

public void setReversedPortOrderEnabled(boolean value)

Sets whether or not the port assignment should reverse the order of the ports.

The normal order is from left to right and from top to bottom. It will be reversed if this option is enabled.

This setting only affects distributed port assignment (e.g. PortAssignmentMode.DISTRIBUTED_NORTH).

Default Value:

The default value is false. The normal order is used for the ports.

Parameters:

value - true if the order of the ports are reversed, false otherwise

See Also:

isReversedPortOrderEnabled()