com.yworks.yfiles.layout.router

Enum Scope

java.lang.Object

java.lang.Enum<Scope>

com.yworks.yfiles.layout.router.Scope

All Implemented Interfaces:

Serializable, Comparable<Scope>

public enum Scope
extends Enum<Scope>

See Also:

BusRouter.getScope(), EdgeRouter.getScope(), PolylineLayoutStage.getScope(), StraightLineEdgeRouter.getScope()

Enum Constant Summary

Enum Constants

Enum Constant and Description
ROUTE_AFFECTED_EDGES A scope specifier which defines that only the selected edges of the input graph will be routed.
ROUTE_ALL_EDGES A scope specifier which defines that all edges of the input graph will be routed.
ROUTE_EDGES_AT_AFFECTED_NODES A scope specifier which defines that only edges incident to selected nodes will be routed.

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

ROUTE_AFFECTED_EDGES

public static final Scope ROUTE_AFFECTED_EDGES

A scope specifier which defines that only the selected edges of the input graph will be routed.

The selection state of an edge is determined by a boolean value returned by a IDataProvider registered with key AffectedEdgesDpKey.

All other non-selected edges will be considered to have fixed routes.

See Also:

BusRouter.setScope(Scope), BusRouter.setAffectedEdgesDpKey(java.lang.Object), BusRouter.DEFAULT_AFFECTED_EDGES_DPKEY

ROUTE_ALL_EDGES

public static final Scope ROUTE_ALL_EDGES

A scope specifier which defines that all edges of the input graph will be routed.

See Also:

BusRouter.setScope(Scope)

ROUTE_EDGES_AT_AFFECTED_NODES

public static final Scope ROUTE_EDGES_AT_AFFECTED_NODES

A scope specifier which defines that only edges incident to selected nodes will be routed.

The selection state of a node is determined by a boolean value returned by a IDataProvider registered with key AffectedNodesDpKey.

All other edges that are incident to non-selected nodes will be considered to have fixed routes.

See Also:

EdgeRouter.setScope(Scope), EdgeRouter.setAffectedNodesDpKey(java.lang.Object)

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