com.yworks.yfiles.layout.tree

Class MultiParentDescriptor

java.lang.Object

com.yworks.yfiles.layout.tree.MultiParentDescriptor

public class MultiParentDescriptor
extends Object

The MultiParentDescriptor provides style information for multi-parent structures.

This class is used by TreeLayout to determine the desired layout of nodes that constitute a multi-parent structure. All nodes of such a structure are placed side by side and the incident edges are routed over common points for incoming edges and for outgoing edges.

A tree graph containing multi-parent structures

See Also:

TreeLayout.MULTI_PARENT_DESCRIPTOR_DPKEY

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
MultiParentRoutingStyle	getEdgeStyle() Gets the routing style for edges that connect to nodes which constitute a multi-parent structure.
double	getMinimumBusDistance() Gets the minimum distance between the nodes of a multi-parent structure and the bus connecting these nodes.
double	getMinimumNodeDistance() Gets the minimum distance between two nodes belonging to the same multi-parent structure.
double	getVerticalAlignment() Gets the relative vertical alignment of nodes belonging to the same multi-parent structure.
void	setEdgeStyle(MultiParentRoutingStyle value) Sets the routing style for edges that connect to nodes which constitute a multi-parent structure.
void	setMinimumBusDistance(double value) Sets the minimum distance between the nodes of a multi-parent structure and the bus connecting these nodes.
void	setMinimumNodeDistance(double value) Sets the minimum distance between two nodes belonging to the same multi-parent structure.
void	setVerticalAlignment(double value) Sets the relative vertical alignment of nodes belonging to the same multi-parent structure.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiParentDescriptor

public MultiParentDescriptor()

Creates a new MultiParentDescriptor instance with default settings.

Method Detail

getEdgeStyle

public MultiParentRoutingStyle getEdgeStyle()

Gets the routing style for edges that connect to nodes which constitute a multi-parent structure.

Throws:

IllegalArgumentException - if the given routing style is unknown

The routing style is applied only to the part of the edge route that is not shared by multiple edges.

Default Value:

The default value is MultiParentRoutingStyle.ORTHOGONAL

Returns:

one of the predefined routing styles

See Also:

setEdgeStyle(MultiParentRoutingStyle)

getMinimumBusDistance

public double getMinimumBusDistance()

Gets the minimum distance between the nodes of a multi-parent structure and the bus connecting these nodes.

In case the edge style is not orthogonal, the bus only consists of a common point.

The minimum distance needs to be non-negative.

Throws:

IllegalArgumentException - if the given bus distance is negative

Default Value:

The default value is 10.

Returns:

the minimum bus distance

See Also:

setMinimumBusDistance(double)

getMinimumNodeDistance

public double getMinimumNodeDistance()

Gets the minimum distance between two nodes belonging to the same multi-parent structure.

The distance needs to be non-negative.

Throws:

IllegalArgumentException - if the given node distance is negative

Default Value:

The default value is 15d.

Returns:

the minimum distance between nodes

See Also:

setMinimumNodeDistance(double)

getVerticalAlignment

public double getVerticalAlignment()

Gets the relative vertical alignment of nodes belonging to the same multi-parent structure.

A value of 0 means that nodes are top-aligned; a value of 1 means that nodes are bottom-aligned; a value of 0.5 means that nodes are center-aligned.

Values outside the interval [0,1] will result in a compact node placement with unaligned nodes, especially when labels are considered.

Default Value:

The default value is 0.5.

Returns:

the relative vertical alignment of multi-parent nodes

See Also:

setVerticalAlignment(double)

setEdgeStyle

public void setEdgeStyle(MultiParentRoutingStyle value)

Sets the routing style for edges that connect to nodes which constitute a multi-parent structure.

Throws:

IllegalArgumentException - if the given routing style is unknown

The routing style is applied only to the part of the edge route that is not shared by multiple edges.

Default Value:

The default value is MultiParentRoutingStyle.ORTHOGONAL

Parameters:

value - one of the predefined routing styles

See Also:

getEdgeStyle()

setMinimumBusDistance

public void setMinimumBusDistance(double value)

Sets the minimum distance between the nodes of a multi-parent structure and the bus connecting these nodes.

In case the edge style is not orthogonal, the bus only consists of a common point.

The minimum distance needs to be non-negative.

Throws:

IllegalArgumentException - if the given bus distance is negative

Default Value:

The default value is 10.

Parameters:

value - the minimum bus distance

See Also:

getMinimumBusDistance()

setMinimumNodeDistance

public void setMinimumNodeDistance(double value)

Sets the minimum distance between two nodes belonging to the same multi-parent structure.

The distance needs to be non-negative.

Throws:

IllegalArgumentException - if the given node distance is negative

Default Value:

The default value is 15d.

Parameters:

value - the minimum distance between nodes

See Also:

getMinimumNodeDistance()

setVerticalAlignment

public void setVerticalAlignment(double value)

Sets the relative vertical alignment of nodes belonging to the same multi-parent structure.

A value of 0 means that nodes are top-aligned; a value of 1 means that nodes are bottom-aligned; a value of 0.5 means that nodes are center-aligned.

Values outside the interval [0,1] will result in a compact node placement with unaligned nodes, especially when labels are considered.

Default Value:

The default value is 0.5.

Parameters:

value - the relative vertical alignment of multi-parent nodes

See Also:

getVerticalAlignment()