com.yworks.yfiles.layout.tree

Enum RootPlacement

java.lang.Object

java.lang.Enum<RootPlacement>

com.yworks.yfiles.layout.tree.RootPlacement

All Implemented Interfaces:

Serializable, Comparable<RootPlacement>

public enum RootPlacement
extends Enum<RootPlacement>

See Also:

AspectRatioTreeLayout.createBends(com.yworks.yfiles.layout.IEdgeLayout, com.yworks.yfiles.algorithms.Node, com.yworks.yfiles.algorithms.Node, RootPlacement, SubtreeArrangement), AspectRatioTreeLayout.getRootPlacement(java.lang.Object), AspectRatioTreeLayout.getRootPlacement()

Enum Constant Summary

Enum Constants

Enum Constant and Description
CORNER A root placement specifier for placing the root in the upper left corner of the subtree bounds with respect to the actual layout orientation.
CORNER_SIDE A root placement specifier for placing the root in the upper left corner of the subtree bounds with respect to the actual layout orientation.
CORNER_TOP A root placement specifier for placing the root of a subtree in the upper left corner of the subtree bounds with respect to the actual layout orientation.
TOP A root placement specifier for placing the root centered above its subtree, depending on the actual layout orientation.

Method Summary

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

CORNER

public static final RootPlacement CORNER

A root placement specifier for placing the root in the upper left corner of the subtree bounds with respect to the actual layout orientation.

Whether the root is placed entirely beside the subtree with no horizontal overlaps or entirely above the subtree without vertical overlaps will be determined by the layout of the subtree. The layout algorithm tries to minimize the bounds of the subtree.

See Also:

AspectRatioTreeLayout.ROOT_PLACEMENT_DPKEY, CORNER_TOP, CORNER_SIDE

CORNER_SIDE

public static final RootPlacement CORNER_SIDE

A root placement specifier for placing the root in the upper left corner of the subtree bounds with respect to the actual layout orientation.

The root is placed entirely beside the subtree with no horizontal overlaps. This might by important if the root's height is very large while its width is small.

See Also:

AspectRatioTreeLayout.ROOT_PLACEMENT_DPKEY

CORNER_TOP

public static final RootPlacement CORNER_TOP

A root placement specifier for placing the root of a subtree in the upper left corner of the subtree bounds with respect to the actual layout orientation.

The root is placed entirely above the subtree with no vertical overlaps. This might by important if the root's width is very large while its height is small.

See Also:

AspectRatioTreeLayout.ROOT_PLACEMENT_DPKEY

TOP

public static final RootPlacement TOP

A root placement specifier for placing the root centered above its subtree, depending on the actual layout orientation.

See Also:

AspectRatioTreeLayout.ROOT_PLACEMENT_DPKEY

Method Detail

fromOrdinal

public static final RootPlacement fromOrdinal(int ordinal)

value

public int value()

valueOf

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

Returns:

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