com.yworks.yfiles.layout.multipage

Enum GroupingMode

java.lang.Object

java.lang.Enum<GroupingMode>

com.yworks.yfiles.layout.multipage.GroupingMode

All Implemented Interfaces:

Serializable, Comparable<GroupingMode>

public enum GroupingMode
extends Enum<GroupingMode>

See Also:

MultiPageLayout.getGroupingMode()

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL_NODES Node grouping specifier used when special nodes like, e.g., connector and proxy nodes (see NodeType.CONNECTOR and NodeType.PROXY) should be assigned to group nodes, too.
IGNORE Node grouping specifier used when group nodes should be ignored.
ORIGINAL_NODES_ONLY Node grouping specifier used when only original nodes should be assigned to group nodes.

Method Summary

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

public static final GroupingMode ALL_NODES

Node grouping specifier used when special nodes like, e.g., connector and proxy nodes (see NodeType.CONNECTOR and NodeType.PROXY) should be assigned to group nodes, too.

A group node may be fragmented, i.e., its content may be placed on different pages.

See Also:

MultiPageLayout.setGroupingMode(GroupingMode)

IGNORE

public static final GroupingMode IGNORE

Node grouping specifier used when group nodes should be ignored.

See Also:

MultiPageLayout.setGroupingMode(GroupingMode)

ORIGINAL_NODES_ONLY

public static final GroupingMode ORIGINAL_NODES_ONLY

Node grouping specifier used when only original nodes should be assigned to group nodes. Hence, connector and proxy nodes (see NodeType.CONNECTOR and NodeType.PROXY) are never assigned to group nodes even though the associated node lies within a group.

A group node may be fragmented, i.e., its content may be placed on different pages.

See Also:

MultiPageLayout.setGroupingMode(GroupingMode)

Method Detail

fromOrdinal

public static final GroupingMode fromOrdinal(int ordinal)

value

public int value()

valueOf

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

Returns:

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