com.yworks.yfiles.layout.tree

Enum PortAssignmentMode

java.lang.Object

java.lang.Enum<PortAssignmentMode>

com.yworks.yfiles.layout.tree.PortAssignmentMode

All Implemented Interfaces:

Serializable, Comparable<PortAssignmentMode>

public enum PortAssignmentMode
extends Enum<PortAssignmentMode>

See Also:

DefaultPortAssignment.DefaultPortAssignment(PortAssignmentMode, double), DefaultPortAssignment.getMode()

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISTRIBUTED_EAST A port assignment specifier which defines that edges are distributed evenly at the eastern side of their nodes.
DISTRIBUTED_NORTH A port assignment specifier which defines that edges are distributed evenly at the northern side of their nodes.
DISTRIBUTED_SOUTH A port assignment specifier which defines that edges are distributed evenly at the southern side of their nodes.
DISTRIBUTED_WEST A port assignment specifier which defines that edges are distributed evenly at the western side of their nodes.
NONE A port assignment specifier which defines that all ports are reset to the center of their nodes.
PORT_CONSTRAINT A port assignment specifier that defines that PortConstraints are considered.

Method Summary

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

DISTRIBUTED_EAST

public static final PortAssignmentMode DISTRIBUTED_EAST

A port assignment specifier which defines that edges are distributed evenly at the eastern side of their nodes.

Grouped edges will use the same port coordinate and will be considered as a single edge when calculating the distribution.

See Also:

PortConstraintKeys.SOURCE_GROUP_ID_DPKEY, PortConstraintKeys.TARGET_GROUP_ID_DPKEY

DISTRIBUTED_NORTH

public static final PortAssignmentMode DISTRIBUTED_NORTH

A port assignment specifier which defines that edges are distributed evenly at the northern side of their nodes.

Grouped edges will use the same port coordinate and will be considered as a single edge when calculating the distribution.

See Also:

PortConstraintKeys.SOURCE_GROUP_ID_DPKEY, PortConstraintKeys.TARGET_GROUP_ID_DPKEY

DISTRIBUTED_SOUTH

public static final PortAssignmentMode DISTRIBUTED_SOUTH

A port assignment specifier which defines that edges are distributed evenly at the southern side of their nodes.

Grouped edges will use the same port coordinate and will be considered as a single edge when calculating the distribution.

See Also:

PortConstraintKeys.SOURCE_GROUP_ID_DPKEY, PortConstraintKeys.TARGET_GROUP_ID_DPKEY

DISTRIBUTED_WEST

public static final PortAssignmentMode DISTRIBUTED_WEST

A port assignment specifier which defines that edges are distributed evenly at the western side of their nodes.

Grouped edges will use the same port coordinate and will be considered as a single edge when calculating the distribution.

See Also:

PortConstraintKeys.SOURCE_GROUP_ID_DPKEY, PortConstraintKeys.TARGET_GROUP_ID_DPKEY

NONE

public static final PortAssignmentMode NONE

A port assignment specifier which defines that all ports are reset to the center of their nodes.

PORT_CONSTRAINT

public static final PortAssignmentMode PORT_CONSTRAINT

A port assignment specifier that defines that PortConstraints are considered. Ports are placed using the following rules:

• edges without a PortConstraint are anchored at the center of the node
• edges with a weak PortConstraint are anchored at the center of their specified side
• edges with a strong PortConstraint are anchored at their initial coordinates

If edges with PortConstraints are grouped, all edges in the same group will use the port coordinates of the first edge in the group.

See Also:

PortConstraintKeys.SOURCE_PORT_CONSTRAINT_DPKEY, PortConstraintKeys.TARGET_PORT_CONSTRAINT_DPKEY, PortConstraintKeys.SOURCE_GROUP_ID_DPKEY, PortConstraintKeys.TARGET_GROUP_ID_DPKEY

Method Detail

fromOrdinal

public static final PortAssignmentMode fromOrdinal(int ordinal)

value

public int value()

valueOf

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

Returns:

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