com.yworks.yfiles.layout.tree

Enum LeafPlacement

java.lang.Object

java.lang.Enum<LeafPlacement>

com.yworks.yfiles.layout.tree.LeafPlacement

All Implemented Interfaces:

Serializable, Comparable<LeafPlacement>

public enum LeafPlacement
extends Enum<LeafPlacement>

See Also:

ClassicTreeLayout.getLeafPlacement()

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL_LEAVES_ON_SAME_LAYER A policy for placing the leaf nodes in a Dendrogram-like fashion.
LEAVES_STACKED A policy for placing the leaf nodes in a stack-like fashion with balanced stack heights.
LEAVES_STACKED_LEFT A policy for placing the leaf nodes in a stack-like fashion using a single stack left.
LEAVES_STACKED_LEFT_AND_RIGHT A policy for placing the leaf nodes in a stack-like fashion using two stacks.
LEAVES_STACKED_RIGHT A policy for placing the leaf nodes in a stack-like fashion using a single stack right.
SIBLINGS_ON_SAME_LAYER A policy for placing the leaf nodes with the same parent in the same layer.

Method Summary

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

ALL_LEAVES_ON_SAME_LAYER

public static final LeafPlacement ALL_LEAVES_ON_SAME_LAYER

A policy for placing the leaf nodes in a Dendrogram-like fashion.

According to this policy, all leaf nodes are placed in one layer (i.e. all leaves are placed on one horizontal line in a top-to-bottom or in a bottom-to-top layout).

See Also:

ClassicTreeLayout.getLeafPlacement(), ClassicTreeLayout.setLeafPlacement(LeafPlacement)

LEAVES_STACKED

public static final LeafPlacement LEAVES_STACKED

A policy for placing the leaf nodes in a stack-like fashion with balanced stack heights.

In this context, a stack-like fashion means that leaf nodes that connect to the same parent node are placed one upon the other, resulting in horizontally compact layouts.

This policy tries to balance stack heights, i.e., for each subtree that consists only of leaf nodes, LEAVES_STACKED_RIGHT or LEAVES_STACKED_LEFT_AND_RIGHT will be used depending on the number of leaves in the subtree.

This policy has an effect only on subtrees where all children are leaf nodes.

See Also:

ClassicTreeLayout.setLeafPlacement(LeafPlacement), ClassicTreeLayout.getLeafPlacement()

LEAVES_STACKED_LEFT

public static final LeafPlacement LEAVES_STACKED_LEFT

A policy for placing the leaf nodes in a stack-like fashion using a single stack left.

In this context, a stack-like fashion means that leaf nodes that connect to the same root node are placed one upon the other, resulting in horizontally compact layouts.

This policy uses a single stack that lies to the left relative to the center of the parent node.

This policy has an effect only on subtrees where all children are leaf nodes.

See Also:

ClassicTreeLayout.getLeafPlacement(), ClassicTreeLayout.setLeafPlacement(LeafPlacement)

LEAVES_STACKED_LEFT_AND_RIGHT

public static final LeafPlacement LEAVES_STACKED_LEFT_AND_RIGHT

A policy for placing the leaf nodes in a stack-like fashion using two stacks.

In this context, a stack-like fashion means that leaf nodes that connect to the same root node are placed one upon the other, resulting in horizontally compact layouts.

This policy distributes leaf nodes among two stacks, one to the left and one to the right relative to the center of the parent node.

This policy has an effect only on subtrees where all children are leaf nodes.

See Also:

ClassicTreeLayout.getLeafPlacement(), ClassicTreeLayout.setLeafPlacement(LeafPlacement)

LEAVES_STACKED_RIGHT

public static final LeafPlacement LEAVES_STACKED_RIGHT

A policy for placing the leaf nodes in a stack-like fashion using a single stack right.

In this context, a stack-like fashion means that leaf nodes that connect to the same root node are placed one upon the other, resulting in horizontally compact layouts.

This policy uses a single stack that lies to the right relative to the center of the parent node.

This policy has an effect only on subtrees where all children are leaf nodes.

See Also:

ClassicTreeLayout.getLeafPlacement(), ClassicTreeLayout.setLeafPlacement(LeafPlacement)

SIBLINGS_ON_SAME_LAYER

public static final LeafPlacement SIBLINGS_ON_SAME_LAYER

A policy for placing the leaf nodes with the same parent in the same layer.

For example, siblings are being placed on a horizontal line in a top-to-bottom or in a bottom-to-top layout.

This policy produces vertically compact layouts.

See Also:

ClassicTreeLayout.getLeafPlacement(), ClassicTreeLayout.setLeafPlacement(LeafPlacement)

Method Detail

fromOrdinal

public static final LeafPlacement fromOrdinal(int ordinal)

value

public int value()

valueOf

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

Returns:

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