com.yworks.yfiles.layout.hierarchic

Class EdgeLayoutDescriptor

java.lang.Object

com.yworks.yfiles.layout.hierarchic.EdgeLayoutDescriptor

public class EdgeLayoutDescriptor
extends Object

This class is used by HierarchicLayoutCore during the various phases to provide routing details for the edges of the graph.

An EdgeLayoutDescriptor instance can be specified individually for single edges using a IDataProvider that returns an EdgeLayoutDescriptor instance for each edge of the graph, or null if no EdgeLayoutDescriptor is bound to an edge. The IDataProvider is registered with the graph using key HierarchicLayoutCore.EDGE_LAYOUT_DESCRIPTOR_DPKEY.

This class is designed as a class to allow future additions of new getter methods.

Not all of these values will be considered for all kinds of edges and algorithm settings.

See Also:

HierarchicLayoutCore.EDGE_LAYOUT_DESCRIPTOR_DPKEY, NodeLayoutDescriptor

Constructor Summary

Constructors

Constructor and Description
EdgeLayoutDescriptor() Creates a new instance of an EdgeLayoutDescriptor with the default values.

Method Summary

Modifier and Type	Method and Description
EdgeLayoutDescriptor	createCopy() Creates a copy of this EdgeLayoutDescriptor instance.
double	getMinimumDistance() Gets the preferred minimum distance to obstacles.
double	getMinimumFirstSegmentLength() Gets the minimum length of the first segment of the edge path (at the source node).
double	getMinimumLastSegmentLength() Gets the minimum length of the last segment of the edge path (at the target node).
double	getMinimumLength() Gets the minimum length of an edge.
double	getMinimumOctilinearSegmentLength() Gets the minimum length of octilinear segments for this edge.
double	getMinimumSlope() Gets the minimum slope that the mid segments of this edge should have, if the edge is routed polyline in vertical layouts.
RecursiveEdgeStyle	getRecursiveEdgeStyle() Gets how edges in grouped graphs are routed between the content of different groups.
RoutingStyle	getRoutingStyle() Gets the routing style for this edge.
boolean	isDirectGroupContentEdgeRoutingEnabled() Gets whether or not this edge is routed directly to a group node's border if it connects the group node with one of its descendants.
boolean	isSourcePortOptimization() Gets whether or not source port optimization is enabled.
boolean	isTargetPortOptimization() Gets whether or not target port optimization is enabled.
void	setDirectGroupContentEdgeRoutingEnabled(boolean value) Sets whether or not this edge is routed directly to a group node's border if it connects the group node with one of its descendants.
void	setMinimumDistance(double value) Sets the preferred minimum distance to obstacles.
void	setMinimumFirstSegmentLength(double value) Sets the minimum length of the first segment of the edge path (at the source node).
void	setMinimumLastSegmentLength(double value) Sets the minimum length of the last segment of the edge path (at the target node).
void	setMinimumLength(double value) Sets the minimum length of an edge.
void	setMinimumOctilinearSegmentLength(double value) Sets the minimum length of octilinear segments for this edge.
void	setMinimumSlope(double value) Sets the minimum slope that the mid segments of this edge should have, if the edge is routed polyline in vertical layouts.
void	setRecursiveEdgeStyle(RecursiveEdgeStyle value) Sets how edges in grouped graphs are routed between the content of different groups.
void	setRoutingStyle(RoutingStyle value) Sets the routing style for this edge.
void	setSourcePortOptimization(boolean value) Sets whether or not source port optimization is enabled.
void	setTargetPortOptimization(boolean value) Sets whether or not target port optimization is enabled.

Methods inherited from class java.lang.Object

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

Constructor Detail

EdgeLayoutDescriptor

public EdgeLayoutDescriptor()

Creates a new instance of an EdgeLayoutDescriptor with the default values.

Method Detail

createCopy

public EdgeLayoutDescriptor createCopy()

Creates a copy of this EdgeLayoutDescriptor instance.

Returns:

a copy of this EdgeLayoutDescriptor instance

getMinimumDistance

public double getMinimumDistance()

Gets the preferred minimum distance to obstacles.

The minimum distance should be greater than 0.

Throws:

IllegalArgumentException - if the minimum length is negative

Default Value:

The default value is 10.0d.

Returns:

the minimum distance to obstacles

See Also:

setMinimumDistance(double)

getMinimumFirstSegmentLength

public double getMinimumFirstSegmentLength()

Gets the minimum length of the first segment of the edge path (at the source node).

The minimum length should be greater than 0.

If the value is 0.0d the first segment does not need to be orthogonal.

Throws:

IllegalArgumentException - if the minimum length of the first segment is negative

Default Value:

The default value is 10.0d.

Returns:

the minimum length of the first segment

See Also:

setMinimumFirstSegmentLength(double)

getMinimumLastSegmentLength

public double getMinimumLastSegmentLength()

Gets the minimum length of the last segment of the edge path (at the target node).

The minimum length should be greater than 0.

If the value is 0.0d the last segment does not need to be orthogonal.

Throws:

IllegalArgumentException - if the minimum length of the last segment is negative

Default Value:

The default value is 15.0d.

Returns:

the minimum length of the last segment

See Also:

setMinimumLastSegmentLength(double)

getMinimumLength

public double getMinimumLength()

Gets the minimum length of an edge.

If this is used for polyline routing, it describes the minimum vertical length of the mid segment. If it is used for orthogonal routing, it describes the minimum length of the whole edge.

The minimum length should be greater than 0.

Throws:

IllegalArgumentException - if the minimum length is negative

Default Value:

The default value is 20.0d.

Returns:

the minimum segment length.

See Also:

setMinimumLength(double)

getMinimumOctilinearSegmentLength

public double getMinimumOctilinearSegmentLength()

Gets the minimum length of octilinear segments for this edge.

Throws:

IllegalArgumentException - if the minimum length of the first segment is negative

The layout algorithm cannot always maintain the specified minimum length.

This option has an effect only if the routing style is octilinear.

Default Value:

The default value is 20.0d.

Returns:

the minimum length of octilinear segment

See Also:

setRoutingStyle(RoutingStyle), setMinimumOctilinearSegmentLength(double)

getMinimumSlope

public double getMinimumSlope()

Gets the minimum slope that the mid segments of this edge should have, if the edge is routed polyline in vertical layouts.

The minimum slope should be greater than 0.

Throws:

IllegalArgumentException - if the given minimum slope is negative

Default Value:

The default value is 0.3d.

Returns:

the minimum slope of the mid segments

See Also:

setMinimumSlope(double)

getRecursiveEdgeStyle

public RecursiveEdgeStyle getRecursiveEdgeStyle()

Gets how edges in grouped graphs are routed between the content of different groups.

Throws:

IllegalArgumentException - if an unknown style is specified

If also direct routing between groups and their content is enabled, such an edge may not be strictly recursive anymore. Edges may leave/enter group nodes left or right.

Edge grouping is not supported for the recursive styles RecursiveEdgeStyle.DIRECTED and RecursiveEdgeStyle.UNDIRECTED. Any edge grouping information will be ignored, including automatic groupings.

Default Value:

The default value is RecursiveEdgeStyle.OFF. Edges are not routed recursively.

Returns:

one of the predefined recursive routing styles

See Also:

setRecursiveEdgeStyle(RecursiveEdgeStyle)

getRoutingStyle

public RoutingStyle getRoutingStyle()

Gets the routing style for this edge.

Returns:

a RoutingStyle instance

See Also:

RoutingStyle, setRoutingStyle(RoutingStyle)

isDirectGroupContentEdgeRoutingEnabled

public boolean isDirectGroupContentEdgeRoutingEnabled()

Gets whether or not this edge is routed directly to a group node's border if it connects the group node with one of its descendants.

When enabled, the edge will connect to the inner side of the group node's border instead of leaving the group node and connect from outside.

Edges that are completely overlapped by their source or target may require special attention during visualization. They can disappear when edges are clipped at their source and target.

This only applies to edges that connect to a group node from inside this group node.

Default Value:

The default value is false.

Returns:

true if the edge is routed directly, false otherwise

See Also:

setDirectGroupContentEdgeRoutingEnabled(boolean)

isSourcePortOptimization

public boolean isSourcePortOptimization()

Gets whether or not source port optimization is enabled.

This means that the algorithm should try to find a better source port constraint if the current constraint is null or PortSide.ANY.

Default Value:

The default value is false. Ports being placed at the side of the node which lies closest to the target of the edge in terms of layering.

Returns:

true if source port optimization is enabled, false otherwise

See Also:

setSourcePortOptimization(boolean)

isTargetPortOptimization

public boolean isTargetPortOptimization()

Gets whether or not target port optimization is enabled.

This means that the algorithm should try to find a better target port constraint if the current constraint is null or PortSide.ANY.

Default Value:

The default value is false. Ports being placed at the side of the node which lies closest to the source of the edge in terms of layering.

Returns:

true if target port optimization should be enabled, false otherwise

See Also:

setTargetPortOptimization(boolean)

setDirectGroupContentEdgeRoutingEnabled

public void setDirectGroupContentEdgeRoutingEnabled(boolean value)

Sets whether or not this edge is routed directly to a group node's border if it connects the group node with one of its descendants.

When enabled, the edge will connect to the inner side of the group node's border instead of leaving the group node and connect from outside.

Edges that are completely overlapped by their source or target may require special attention during visualization. They can disappear when edges are clipped at their source and target.

This only applies to edges that connect to a group node from inside this group node.

Default Value:

The default value is false.

Parameters:

value - true if the edge is routed directly, false otherwise

See Also:

isDirectGroupContentEdgeRoutingEnabled()

setMinimumDistance

public void setMinimumDistance(double value)

Sets the preferred minimum distance to obstacles.

The minimum distance should be greater than 0.

Throws:

IllegalArgumentException - if the minimum length is negative

Default Value:

The default value is 10.0d.

Parameters:

value - the minimum distance to obstacles

See Also:

getMinimumDistance()

setMinimumFirstSegmentLength

public void setMinimumFirstSegmentLength(double value)

Sets the minimum length of the first segment of the edge path (at the source node).

The minimum length should be greater than 0.

If the value is 0.0d the first segment does not need to be orthogonal.

Throws:

IllegalArgumentException - if the minimum length of the first segment is negative

Default Value:

The default value is 10.0d.

Parameters:

value - the minimum length of the first segment

See Also:

getMinimumFirstSegmentLength()

setMinimumLastSegmentLength

public void setMinimumLastSegmentLength(double value)

Sets the minimum length of the last segment of the edge path (at the target node).

The minimum length should be greater than 0.

If the value is 0.0d the last segment does not need to be orthogonal.

Throws:

IllegalArgumentException - if the minimum length of the last segment is negative

Default Value:

The default value is 15.0d.

Parameters:

value - the minimum length of the last segment

See Also:

getMinimumLastSegmentLength()

setMinimumLength

public void setMinimumLength(double value)

Sets the minimum length of an edge.

If this is used for polyline routing, it describes the minimum vertical length of the mid segment. If it is used for orthogonal routing, it describes the minimum length of the whole edge.

The minimum length should be greater than 0.

Throws:

IllegalArgumentException - if the minimum length is negative

Default Value:

The default value is 20.0d.

Parameters:

value - the minimum segment length.

See Also:

getMinimumLength()

setMinimumOctilinearSegmentLength

public void setMinimumOctilinearSegmentLength(double value)

Sets the minimum length of octilinear segments for this edge.

Throws:

IllegalArgumentException - if the minimum length of the first segment is negative

The layout algorithm cannot always maintain the specified minimum length.

This option has an effect only if the routing style is octilinear.

Default Value:

The default value is 20.0d.

Parameters:

value - the minimum length of octilinear segment

See Also:

setRoutingStyle(RoutingStyle), getMinimumOctilinearSegmentLength()

setMinimumSlope

public void setMinimumSlope(double value)

Sets the minimum slope that the mid segments of this edge should have, if the edge is routed polyline in vertical layouts.

The minimum slope should be greater than 0.

Throws:

IllegalArgumentException - if the given minimum slope is negative

Default Value:

The default value is 0.3d.

Parameters:

value - the minimum slope of the mid segments

See Also:

getMinimumSlope()

setRecursiveEdgeStyle

public void setRecursiveEdgeStyle(RecursiveEdgeStyle value)

Sets how edges in grouped graphs are routed between the content of different groups.

Throws:

IllegalArgumentException - if an unknown style is specified

If also direct routing between groups and their content is enabled, such an edge may not be strictly recursive anymore. Edges may leave/enter group nodes left or right.

Edge grouping is not supported for the recursive styles RecursiveEdgeStyle.DIRECTED and RecursiveEdgeStyle.UNDIRECTED. Any edge grouping information will be ignored, including automatic groupings.

Default Value:

The default value is RecursiveEdgeStyle.OFF. Edges are not routed recursively.

Parameters:

value - one of the predefined recursive routing styles

See Also:

getRecursiveEdgeStyle()

setRoutingStyle

public void setRoutingStyle(RoutingStyle value)

Sets the routing style for this edge.

Parameters:

value - a RoutingStyle instance

See Also:

RoutingStyle, getRoutingStyle()

setSourcePortOptimization

public void setSourcePortOptimization(boolean value)

Sets whether or not source port optimization is enabled.

This means that the algorithm should try to find a better source port constraint if the current constraint is null or PortSide.ANY.

Default Value:

The default value is false. Ports being placed at the side of the node which lies closest to the target of the edge in terms of layering.

Parameters:

value - true if source port optimization is enabled, false otherwise

See Also:

isSourcePortOptimization()

setTargetPortOptimization

public void setTargetPortOptimization(boolean value)

Sets whether or not target port optimization is enabled.

This means that the algorithm should try to find a better target port constraint if the current constraint is null or PortSide.ANY.

Default Value:

The default value is false. Ports being placed at the side of the node which lies closest to the source of the edge in terms of layering.

Parameters:

value - true if target port optimization should be enabled, false otherwise

See Also:

isTargetPortOptimization()