com.yworks.yfiles.layout.organic

Enum GroupsPolicy

java.lang.Object

java.lang.Enum<GroupsPolicy>

com.yworks.yfiles.layout.organic.GroupsPolicy

All Implemented Interfaces:

Serializable, Comparable<GroupsPolicy>

public enum GroupsPolicy
extends Enum<GroupsPolicy>

Enum constants that specify how groups are handled by the OrganicLayout.

See Also:

ClassicOrganicLayout.getGroupNodePolicy()

Enum Constant Summary

Enum Constants

Enum Constant and Description
FIXED Group handling policy for keeping the relative positions of nodes that belong to the same group fixed.
IGNORE Group handling policy for completely ignoring group nodes during the layout process.
LAYOUT Group handling policy for considering and arranging the nodes contained in a group such that their togetherness is highlighted.

Method Summary

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

FIXED

public static final GroupsPolicy FIXED

Group handling policy for keeping the relative positions of nodes that belong to the same group fixed.

The fixed groups will be taken into account when placing the other nodes of the graph.

By registering a IDataProvider with key ClassicOrganicLayout.FIXED_GROUP_NODES_DPKEY, the individual group nodes can be marked as fixed or not fixed. If there is no data provider registered with the mentioned key, then all group nodes of the graph will be treated as fixed.

See Also:

ClassicOrganicLayout.setGroupNodePolicy(GroupsPolicy)

IGNORE

public static final GroupsPolicy IGNORE

Group handling policy for completely ignoring group nodes during the layout process.

See Also:

ClassicOrganicLayout.setGroupNodePolicy(GroupsPolicy)

LAYOUT

public static final GroupsPolicy LAYOUT

Group handling policy for considering and arranging the nodes contained in a group such that their togetherness is highlighted.

Groups whose content should not be arranged but kept fixed can be marked by registering a IDataProvider with key ClassicOrganicLayout.FIXED_GROUP_NODES_DPKEY.

See Also:

ClassicOrganicLayout.setGroupNodePolicy(GroupsPolicy)

Method Detail

fromOrdinal

public static final GroupsPolicy fromOrdinal(int ordinal)

value

public int value()

valueOf

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

Returns:

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