com.yworks.yfiles.layout.hierarchic

Class DefaultPortAllocator

java.lang.Object

com.yworks.yfiles.layout.hierarchic.DefaultPortAllocator

All Implemented Interfaces:

IPortAllocator

public class DefaultPortAllocator
extends Object
implements IPortAllocator

This class is a default IPortAllocator implementation.

It is used by HierarchicLayoutCore after the sequencing phase.

Constructor Summary

Constructors

Constructor and Description
DefaultPortAllocator() Creates a new instance of DefaultPortAllocator with default settings.

Method Summary

Modifier and Type	Method and Description
void	assignPorts(LayoutGraph graph, ILayers layers, ILayoutDataProvider ldp, IItemFactory itemFactory) Assigns source and target port coordinates to each edge of the graph.
double	getDefaultPortBorderGapRatio() Gets the border gap ratio for the default port.
protected double	getPortBorderGap(LayoutGraph graph, ILayoutDataProvider ldp, Node node, int sideIndex, double sideLength, int edgeCount) Callback method used for determining the port border gap for each node and side.
protected double	getPortBorderGapRatio(LayoutGraph graph, ILayoutDataProvider ldp, Node node, int sideIndex, double sideLength, int edgeCount) Callback method used for determining the port border gap ratio.
protected double	getPortDistanceDelta(LayoutGraph graph, ILayoutDataProvider ldp, Node node, int sideIndex, double sideLength, int edgeCount, double portBorderGap) Callback method used for determining the distance between two adjacent ports.
void	setDefaultPortBorderGapRatio(double value) Sets the border gap ratio for the default port.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPortAllocator

public DefaultPortAllocator()

Creates a new instance of DefaultPortAllocator with default settings.

See Also:

setDefaultPortBorderGapRatio(double)

Method Detail

assignPorts

public void assignPorts(LayoutGraph graph,
                        ILayers layers,
                        ILayoutDataProvider ldp,
                        IItemFactory itemFactory)

Assigns source and target port coordinates to each edge of the graph.

This method assigns:

• PortSide.ANY ports to appropriate sides.
• Weak ports to appropriate positions between strong ones.

This method is called by HierarchicLayoutCore after the sequencing phase.

Specified by:

assignPorts in interface IPortAllocator

Parameters:

graph - the input graph

layers - the given ILayers instance containing the layering structure

ldp - the ILayoutDataProvider containing information about the nodes and edges of the graph

itemFactory - the IItemFactory used for creating and destroying helper structures

getDefaultPortBorderGapRatio

public double getDefaultPortBorderGapRatio()

Gets the border gap ratio for the default port.

This ratio determines the gap between a corner of the node and the first assigned port.

The ratio should be greater than 0.

A value of 0.0d results in ports being placed directly on the corner of the node (if there is more than one port).

A value of 0.5d results in ports being distributed along the side of the node so that the distance between the corner of the node and the first port is half as wide as the distance between two adjacent ports.

A value of Double.POSITIVE_INFINITY results in all ports being centered at the side in one point.

Throws:

IllegalArgumentException - if the given ratio is negative

Default Value:

The default value is 0.5d. Ports are distributed along the side of the node.

Returns:

the border gap ratio

See Also:

setDefaultPortBorderGapRatio(double)

getPortBorderGap

protected double getPortBorderGap(LayoutGraph graph,
                                  ILayoutDataProvider ldp,
                                  Node node,
                                  int sideIndex,
                                  double sideLength,
                                  int edgeCount)

Callback method used for determining the port border gap for each node and side.

It may be overridden for a custom calculation of port border gap on a given node.

Parameters:

graph - the input graph

ldp - the ILayoutDataProvider containing information about the nodes and edges of the graph

node - the given node

sideIndex - the zero-based (top is 0) clock-wise index of the side of the node (for top-to-bottom layouts)

sideLength - the width/height of the side

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

Returns:

the absolute gap on both sides of the ports

See Also:

getPortDistanceDelta(LayoutGraph, ILayoutDataProvider, Node, int, double, int, double)

getPortBorderGapRatio

protected double getPortBorderGapRatio(LayoutGraph graph,
                                       ILayoutDataProvider ldp,
                                       Node node,
                                       int sideIndex,
                                       double sideLength,
                                       int edgeCount)

Callback method used for determining the port border gap ratio.

See DefaultPortBorderGapRatio for an explanation.

It may be overridden for a custom calculation of port border gap ratio on a given node.

If there exists a NodeLayoutDescriptor instance registered for the given node, this implementation returns the same value as NodeLayoutDescriptor.getPortBorderGapRatio(int). Else, returns the same value as DefaultPortBorderGapRatio.

Parameters:

graph - the input graph

ldp - the ILayoutDataProvider containing information about the nodes and edges of the graph

node - the given node

sideIndex - the zero-based (top is 0) clock-wise index of the side of the node (for top-to-bottom layouts)

sideLength - the width/height of the side

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

Returns:

the border gap ratio

getPortDistanceDelta

protected double getPortDistanceDelta(LayoutGraph graph,
                                      ILayoutDataProvider ldp,
                                      Node node,
                                      int sideIndex,
                                      double sideLength,
                                      int edgeCount,
                                      double portBorderGap)

Callback method used for determining the distance between two adjacent ports.

It may be overridden for a custom calculation of the distance between two adjacent ports..

Parameters:

graph - the input graph

ldp - the ILayoutDataProvider containing information about the nodes and edges of the graph

node - the given node

sideIndex - the zero-based (top is 0) clock-wise index of the side of the node (for top-to-bottom layouts)

sideLength - the width/height of the side

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

portBorderGap - the previously calculated port border gap

Returns:

the absolute distance between two adjacent ports

setDefaultPortBorderGapRatio

public void setDefaultPortBorderGapRatio(double value)

Sets the border gap ratio for the default port.

This ratio determines the gap between a corner of the node and the first assigned port.

The ratio should be greater than 0.

A value of 0.0d results in ports being placed directly on the corner of the node (if there is more than one port).

A value of 0.5d results in ports being distributed along the side of the node so that the distance between the corner of the node and the first port is half as wide as the distance between two adjacent ports.

A value of Double.POSITIVE_INFINITY results in all ports being centered at the side in one point.

Throws:

IllegalArgumentException - if the given ratio is negative

Default Value:

The default value is 0.5d. Ports are distributed along the side of the node.

Parameters:

value - the border gap ratio

See Also:

getDefaultPortBorderGapRatio()