com.yworks.yfiles.layout.tree

Enum RootNodePolicy

java.lang.Object

java.lang.Enum<RootNodePolicy>

com.yworks.yfiles.layout.tree.RootNodePolicy

All Implemented Interfaces:

Serializable, Comparable<RootNodePolicy>

public enum RootNodePolicy
extends Enum<RootNodePolicy>

See Also:

BalloonLayout.getRootNodePolicy()

Enum Constant Summary

Enum Constants

Enum Constant and Description
CENTER_ROOT Root node policy for choosing the center node as root node of the tree.
DIRECTED_ROOT Root node policy for choosing a node with indegree 0 as root node of the tree.
SELECTED_ROOT Root node policy for choosing a custom node as the root node of the tree.
WEIGHTED_CENTER_ROOT Root node policy for choosing a weighted center node as root node of the tree.

Method Summary

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

CENTER_ROOT

public static final RootNodePolicy CENTER_ROOT

Root node policy for choosing the center node as root node of the tree.

A center node induces a minimum depth tree when being used as the root of that tree.

See Also:

BalloonLayout.setRootNodePolicy(RootNodePolicy), Trees.getCenterRoot(com.yworks.yfiles.algorithms.Graph)

DIRECTED_ROOT

public static final RootNodePolicy DIRECTED_ROOT

Root node policy for choosing a node with indegree 0 as root node of the tree.

The selection of the root node will happen according to Trees.getRoot(com.yworks.yfiles.algorithms.Graph).

See Also:

BalloonLayout.setRootNodePolicy(RootNodePolicy), Trees.getRoot(com.yworks.yfiles.algorithms.Graph)

SELECTED_ROOT

public static final RootNodePolicy SELECTED_ROOT

Root node policy for choosing a custom node as the root node of the tree.

The root node is specified using a IDataProvider registered with the graph with key BalloonLayout.SELECTED_ROOT_DPKEY.

See Also:

BalloonLayout.setRootNodePolicy(RootNodePolicy)

WEIGHTED_CENTER_ROOT

public static final RootNodePolicy WEIGHTED_CENTER_ROOT

Root node policy for choosing a weighted center node as root node of the tree.

A weighted center node is a node which is part of the greatest number of all undirected paths in a graph.

See Also:

BalloonLayout.setRootNodePolicy(RootNodePolicy)

Method Detail

fromOrdinal

public static final RootNodePolicy fromOrdinal(int ordinal)

value

public int value()

valueOf

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

Returns:

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