com.yworks.yfiles.layout.orthogonal

Class EdgeLayoutDescriptor

java.lang.Object

com.yworks.yfiles.layout.orthogonal.EdgeLayoutDescriptor

public class EdgeLayoutDescriptor
extends Object

This class provides layout information for the edges of the graph.

EdgeLayoutDescriptor is used by OrthogonalLayout to determine the routing details for the edges (e.g. the segment length).

An EdgeLayoutDescriptor can be specified individually for each edge by using a IDataProvider which maps from an Edge to an EdgeLayoutDescriptor instance. The IDataProvider is registered with the graph with key OrthogonalLayout.EDGE_LAYOUT_DESCRIPTOR_DPKEY.

See Also:

OrthogonalLayout.EDGE_LAYOUT_DESCRIPTOR_DPKEY

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
EdgeLayoutDescriptor	createCopy() Creates a copy of this EdgeLayoutDescriptor instance.
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	getMinimumSegmentLength() Gets the minimum segment length of an edge.
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	setMinimumSegmentLength(double value) Sets the minimum segment length of an edge.

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

Method Detail

createCopy

public EdgeLayoutDescriptor createCopy()

Creates a copy of this EdgeLayoutDescriptor instance.

Returns:

a copy of this EdgeLayoutDescriptor instance

getMinimumFirstSegmentLength

public double getMinimumFirstSegmentLength()

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

The minimum length must be greater than or equal to 0.

Throws:

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

The final segment length also depends on the used grid size (see GridSpacing). If the grid is larger than the specified minimum length, then the grid size defines the actual minimum.

Default Value:

The default value is 15.0.

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 must be greater than or equal to 0.

Throws:

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

The final segment length also depends on the used grid size (see GridSpacing). If the grid is larger than the specified minimum length, then the grid size defines the actual minimum.

Default Value:

The default value is 15.0.

Returns:

the minimum length of the last segment

See Also:

setMinimumLastSegmentLength(double)

getMinimumSegmentLength

public double getMinimumSegmentLength()

Gets the minimum segment length of an edge.

The minimum length must be greater than or equal to 0.

Throws:

IllegalArgumentException - if the minimum length is negative

The final segment length also depends on the used grid size (see GridSpacing). If the grid is larger than the specified minimum length, then the grid size defines the actual minimum.

Default Value:

The default value is 15.0.

Returns:

the minimum segment length

See Also:

setMinimumSegmentLength(double)

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 must be greater than or equal to 0.

Throws:

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

The final segment length also depends on the used grid size (see GridSpacing). If the grid is larger than the specified minimum length, then the grid size defines the actual minimum.

Default Value:

The default value is 15.0.

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 must be greater than or equal to 0.

Throws:

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

The final segment length also depends on the used grid size (see GridSpacing). If the grid is larger than the specified minimum length, then the grid size defines the actual minimum.

Default Value:

The default value is 15.0.

Parameters:

value - the minimum length of the last segment

See Also:

getMinimumLastSegmentLength()

setMinimumSegmentLength

public void setMinimumSegmentLength(double value)

Sets the minimum segment length of an edge.

The minimum length must be greater than or equal to 0.

Throws:

IllegalArgumentException - if the minimum length is negative

The final segment length also depends on the used grid size (see GridSpacing). If the grid is larger than the specified minimum length, then the grid size defines the actual minimum.

Default Value:

The default value is 15.0.

Parameters:

value - the minimum segment length

See Also:

getMinimumSegmentLength()