com.yworks.yfiles.layout.seriesparallel

Class EdgeLayoutDescriptor

java.lang.Object

com.yworks.yfiles.layout.seriesparallel.EdgeLayoutDescriptor

public class EdgeLayoutDescriptor
extends Object

An EdgeLayoutDescriptor provides routing details for an edge that are considered by SeriesParallelLayout.

Such an EdgeLayoutDescriptor can either be specified for a single edge or shared by several edges. It is assigned by registering a IDataProvider with key SeriesParallelLayout.EDGE_LAYOUT_DESCRIPTOR_DPKEY. If no IDataProvider is registered with this key, a default descriptor is used.

See Also:

SeriesParallelLayout.EDGE_LAYOUT_DESCRIPTOR_DPKEY, SeriesParallelLayout.getDefaultEdgeLayoutDescriptor()

Constructor Summary

Constructors

Constructor and Description
EdgeLayoutDescriptor() Creates a new instance of EdgeLayoutDescriptor with 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 for the first segment of the associated edge.
double	getMinimumLastSegmentLength() Gets the minimum length for the last segment of the associated edge.
double	getMinimumLength() Gets the minimum length for the associated edge.
void	setMinimumFirstSegmentLength(double value) Sets the minimum length for the first segment of the associated edge.
void	setMinimumLastSegmentLength(double value) Sets the minimum length for the last segment of the associated edge.
void	setMinimumLength(double value) Sets the minimum length for the associated 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 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 for the first segment of the associated edge.

The minimum first segment length needs to be non-negative.

Throws:

IllegalArgumentException - for negative minimum segment lengths

Default Value:

The default value is 15.

Returns:

the minimum first segment length

See Also:

setMinimumFirstSegmentLength(double)

getMinimumLastSegmentLength

public double getMinimumLastSegmentLength()

Gets the minimum length for the last segment of the associated edge.

The minimum last segment length needs to be non-negative.

Throws:

IllegalArgumentException - for negative minimum segment lengths

Default Value:

The default value is 15.

Returns:

the minimum last segment length

See Also:

setMinimumLastSegmentLength(double)

getMinimumLength

public double getMinimumLength()

Gets the minimum length for the associated edge.

The minimum length needs to be non-negative.

Throws:

IllegalArgumentException - for negative edge lengths

Default Value:

The default value is 0.

Returns:

the minimum edge length

See Also:

setMinimumLength(double)

setMinimumFirstSegmentLength

public void setMinimumFirstSegmentLength(double value)

Sets the minimum length for the first segment of the associated edge.

The minimum first segment length needs to be non-negative.

Throws:

IllegalArgumentException - for negative minimum segment lengths

Default Value:

The default value is 15.

Parameters:

value - the minimum first segment length

See Also:

getMinimumFirstSegmentLength()

setMinimumLastSegmentLength

public void setMinimumLastSegmentLength(double value)

Sets the minimum length for the last segment of the associated edge.

The minimum last segment length needs to be non-negative.

Throws:

IllegalArgumentException - for negative minimum segment lengths

Default Value:

The default value is 15.

Parameters:

value - the minimum last segment length

See Also:

getMinimumLastSegmentLength()

setMinimumLength

public void setMinimumLength(double value)

Sets the minimum length for the associated edge.

The minimum length needs to be non-negative.

Throws:

IllegalArgumentException - for negative edge lengths

Default Value:

The default value is 0.

Parameters:

value - the minimum edge length

See Also:

getMinimumLength()