com.yworks.yfiles.layout.tree

Enum ChildAlignmentPolicy

java.lang.Object

java.lang.Enum<ChildAlignmentPolicy>

com.yworks.yfiles.layout.tree.ChildAlignmentPolicy

All Implemented Interfaces:

Serializable, Comparable<ChildAlignmentPolicy>

public enum ChildAlignmentPolicy
extends Enum<ChildAlignmentPolicy>

See Also:

BalloonLayout.getChildAlignmentPolicy()

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPACT Alignment policy for aligning child nodes such that the distances to their parent are kept short and drawings can potentially become more compact.
PLAIN Alignment policy to align child nodes rooted at the same parent such that the border of their convex hull has the same distance to the parent node's center.
SAME_CENTER Alignment policy to align child nodes rooted at the same parent such that each child has the same center-to-center distance to the parent node.
SMART Alignment policy to align child nodes rooted at the same parent using a mixture of the other policies and aiming to achieve symmetry and compactness at the same time.

Method Summary

Modifier and Type	Method and Description
static ChildAlignmentPolicy	fromOrdinal(int ordinal)
int	value()
static ChildAlignmentPolicy	valueOf(String name) Returns the enum constant of this type with the specified name.
static ChildAlignmentPolicy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

COMPACT

public static final ChildAlignmentPolicy COMPACT

Alignment policy for aligning child nodes such that the distances to their parent are kept short and drawings can potentially become more compact.

This policy realizes the exact same child alignment as PLAIN if there are no edge labels associated with edges going to child nodes or if integrated edge labeling is disabled.

If edge labels need to be considered, edge labels will be added to the convex hull of the child node to which the edge connects. This means that child nodes connected with a labeled edge will be aligned at the border where the edge label begins. In consequence, edge labels will be aligned with neighboring edge labels as well as neighboring child nodes if a child node has no edge label at its incoming edge.

This alignment strategy is especially effective if large edge labels need to be considered while drawings should still be compact and distances from parent to child nodes short.

Since compactness is prioritized in conjunction with large edge labels, drawings may lack symmetry regarding node distances.

See Also:

BalloonLayout.setChildAlignmentPolicy(ChildAlignmentPolicy)

PLAIN

public static final ChildAlignmentPolicy PLAIN

Alignment policy to align child nodes rooted at the same parent such that the border of their convex hull has the same distance to the parent node's center.

Convex hulls of nodes are always defined as circles.

See Also:

BalloonLayout.setChildAlignmentPolicy(ChildAlignmentPolicy)

SAME_CENTER

public static final ChildAlignmentPolicy SAME_CENTER

Alignment policy to align child nodes rooted at the same parent such that each child has the same center-to-center distance to the parent node.

All nodes will be placed on a common radius around their parent, respective to their center coordinates.

Two different radii will be realized, if the interleaved mode is active.

See Also:

BalloonLayout.setChildAlignmentPolicy(ChildAlignmentPolicy)

SMART

public static final ChildAlignmentPolicy SMART

Alignment policy to align child nodes rooted at the same parent using a mixture of the other policies and aiming to achieve symmetry and compactness at the same time.

Similar to SAME_CENTER, this policy aims to achieve alignments featuring equal distances between parent and child node centers. However, a much larger distance for all child nodes caused by single large subtrees is avoided by this policy. In such cases, the smaller subtrees may be placed on a common radius and the large subtrees are placed with different distances.

Has no effect if the interleaved mode is active InterleavedMode. In that case, a plain child alignment will be applied instead.

See Also:

BalloonLayout.setChildAlignmentPolicy(ChildAlignmentPolicy)

Method Detail

fromOrdinal

public static final ChildAlignmentPolicy fromOrdinal(int ordinal)

value

public int value()

valueOf

public static ChildAlignmentPolicy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

values

public static ChildAlignmentPolicy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ChildAlignmentPolicy c : ChildAlignmentPolicy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared