com.yworks.yfiles.layout.organic

Enum Scope

java.lang.Object

java.lang.Enum<Scope>

com.yworks.yfiles.layout.organic.Scope

All Implemented Interfaces:

Serializable, Comparable<Scope>

public enum Scope
extends Enum<Scope>

Enum constants that specify the scope for the OrganicLayout and ClassicOrganicLayout.

See Also:

ClassicOrganicLayout.getScope(), OrganicLayout.getScope()

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL Scope mode indicating that the algorithm should place all nodes of the graph.
MAINLY_SUBSET Scope mode indicating that the algorithm should mainly place a subset of nodes.
SUBSET Scope mode indicating that the algorithm should only place a subset of nodes.

Method Summary

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

public static final Scope ALL

Scope mode indicating that the algorithm should place all nodes of the graph.

See Also:

ClassicOrganicLayout.setScope(Scope)

MAINLY_SUBSET

public static final Scope MAINLY_SUBSET

Scope mode indicating that the algorithm should mainly place a subset of nodes.

The subset is determined by a boolean value returned by a IDataProvider registered with key ClassicOrganicLayout.AFFECTED_NODES_DPKEY. Nodes that don't belong to the subset may be moved to a certain degree but will keep their relative positions to the other nodes outside the subset.

See Also:

ClassicOrganicLayout.setScope(Scope), ClassicOrganicLayout.AFFECTED_NODES_DPKEY

SUBSET

public static final Scope SUBSET

Scope mode indicating that the algorithm should only place a subset of nodes.

The subset is determined by a boolean value returned by a IDataProvider registered with key ClassicOrganicLayout.AFFECTED_NODES_DPKEY. Nodes not being part of the subset will remain at their location.

See Also:

ClassicOrganicLayout.setScope(Scope), ClassicOrganicLayout.AFFECTED_NODES_DPKEY

Method Detail

fromOrdinal

public static final Scope fromOrdinal(int ordinal)

value

public int value()

valueOf

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

Returns:

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