com.yworks.yfiles.layout.tree

Enum ChildOrderingPolicy

java.lang.Object

java.lang.Enum<ChildOrderingPolicy>

com.yworks.yfiles.layout.tree.ChildOrderingPolicy

All Implemented Interfaces:

Serializable, Comparable<ChildOrderingPolicy>

public enum ChildOrderingPolicy
extends Enum<ChildOrderingPolicy>

See Also:

BalloonLayout.getChildOrderingPolicy()

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPACT Child ordering policy which orders child nodes depending on their subtree size such that large subtrees are placed next to small ones in order to save space.
SYMMETRIC Child ordering policy which sorts the child nodes according to their wedge angles.

Method Summary

Modifier and Type	Method and Description
static ChildOrderingPolicy	fromOrdinal(int ordinal)
int	value()
static ChildOrderingPolicy	valueOf(String name) Returns the enum constant of this type with the specified name.
static ChildOrderingPolicy[]	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 ChildOrderingPolicy COMPACT

Child ordering policy which orders child nodes depending on their subtree size such that large subtrees are placed next to small ones in order to save space.

The actual area of a subtree is used as the subtree size. The smallest subtree is placed next to the largest subtree, followed by the second smallest subtree and so on. This way, drawings can become more compact, because the adjacent placement of large subtrees is avoided (which would require edges to become longer for subtrees to fit next to each other).

See Also:

BalloonLayout.setChildOrderingPolicy(ChildOrderingPolicy)

SYMMETRIC

public static final ChildOrderingPolicy SYMMETRIC

Child ordering policy which sorts the child nodes according to their wedge angles.

The node with the greatest angle gets median position in the sorting order. The smaller the wedges, the farther away a node will be placed from the median position. Using this policy, the produced results are often more symmetric.

See Also:

BalloonLayout.setChildOrderingPolicy(ChildOrderingPolicy)

Method Detail

fromOrdinal

public static final ChildOrderingPolicy fromOrdinal(int ordinal)

value

public int value()

valueOf

public static ChildOrderingPolicy 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 ChildOrderingPolicy[] 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 (ChildOrderingPolicy c : ChildOrderingPolicy.values())
    System.out.println(c);

Returns:

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