com.yworks.yfiles.layout.hierarchic

Enum NodeLabelMode

java.lang.Object

java.lang.Enum<NodeLabelMode>

com.yworks.yfiles.layout.hierarchic.NodeLabelMode

All Implemented Interfaces:

Serializable, Comparable<NodeLabelMode>

public enum NodeLabelMode
extends Enum<NodeLabelMode>

See Also:

NodeLayoutDescriptor.getNodeLabelMode()

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONSIDER_FOR_DRAWING A constant that makes the algorithm consider node labels for node placement and routing, but not for self-loops.
CONSIDER_FOR_ROUTING A constant that makes the algorithm consider node labels during routing only.
CONSIDER_FOR_SELF_LOOPS A constant that makes the algorithm consider node labels for self-loops, node placement and routing.
NEVER A constant that prevents node labels from being considered during the layout.

Method Summary

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

CONSIDER_FOR_DRAWING

public static final NodeLabelMode CONSIDER_FOR_DRAWING

A constant that makes the algorithm consider node labels for node placement and routing, but not for self-loops.

It is used by NodeLabelMode and NodeLabelMode.

See Also:

NodeLayoutDescriptor.setNodeLabelMode(NodeLabelMode)

CONSIDER_FOR_ROUTING

public static final NodeLabelMode CONSIDER_FOR_ROUTING

A constant that makes the algorithm consider node labels during routing only.

It is used by NodeLabelMode and NodeLabelMode.

See Also:

NodeLayoutDescriptor.setNodeLabelMode(NodeLabelMode)

CONSIDER_FOR_SELF_LOOPS

public static final NodeLabelMode CONSIDER_FOR_SELF_LOOPS

A constant that makes the algorithm consider node labels for self-loops, node placement and routing.

It is used by NodeLabelMode and NodeLabelMode.

See Also:

NodeLayoutDescriptor.setNodeLabelMode(NodeLabelMode)

NEVER

public static final NodeLabelMode NEVER

A constant that prevents node labels from being considered during the layout.

It is used by NodeLabelMode and NodeLabelMode.

See Also:

NodeLayoutDescriptor.setNodeLabelMode(NodeLabelMode)

Method Detail

fromOrdinal

public static final NodeLabelMode fromOrdinal(int ordinal)

value

public int value()

valueOf

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

Returns:

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