com.yworks.yfiles.layout.hierarchic

Enum PortAssignmentMode

java.lang.Object

java.lang.Enum<PortAssignmentMode>

com.yworks.yfiles.layout.hierarchic.PortAssignmentMode

All Implemented Interfaces:

Serializable, Comparable<PortAssignmentMode>

public enum PortAssignmentMode
extends Enum<PortAssignmentMode>

See Also:

NodeLayoutDescriptor.getPortAssignment()

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT A port assignment strategy that distributes ports evenly along the border of the node.
ON_GRID A port assignment strategy that places all edges on grid lines.
ON_SUBGRID A port assignment strategy that places all edges on grid lines or sub-grid lines.

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

DEFAULT

public static final PortAssignmentMode DEFAULT

A port assignment strategy that distributes ports evenly along the border of the node.

This is the default port assignment strategy of HierarchicLayout.

See Also:

NodeLayoutDescriptor.setPortAssignment(PortAssignmentMode)

ON_GRID

public static final PortAssignmentMode ON_GRID

A port assignment strategy that places all edges on grid lines.

If there are not enough grid lines for each port, ports may overlap. In case there is no grid line available at the side of a node, the ports are placed centered at that side.

This port assignment can only be used if the grid spacing is greater than 0.

See Also:

NodeLayoutDescriptor.setPortAssignment(PortAssignmentMode)

ON_SUBGRID

public static final PortAssignmentMode ON_SUBGRID

A port assignment strategy that places all edges on grid lines or sub-grid lines.

If there are not enough grid lines for each port, the grid gets subdivided with sub-grid lines until each edge has space for its port.

This port assignment can only be used if the grid spacing is greater than 0.

See Also:

NodeLayoutDescriptor.setPortAssignment(PortAssignmentMode)

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