com.yworks.yfiles.layout

Enum PortSide

java.lang.Object

java.lang.Enum<PortSide>

com.yworks.yfiles.layout.PortSide

All Implemented Interfaces:

Serializable, Comparable<PortSide>

public enum PortSide
extends Enum<PortSide>

See Also:

PortConstraint.create(PortSide, boolean), PortConstraint.getSide()

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY A weak constraint indicating that edges can connect to any side of a node.
EAST A weak constraint indicating that edges can connect to the east side (i.e. right side) of a node.
NORTH A weak constraint indicating that edges can connect to the north side (i.e. top side) of a node.
SOUTH A weak constraint indicating that edges can connect to the south side (i.e. bottom side) of a node.
WEST A weak constraint indicating that edges can connect to the west side (i.e. left side) of a node.

Method Summary

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

ANY

public static final PortSide ANY

A weak constraint indicating that edges can connect to any side of a node.

See Also:

PortConstraint.create(PortSide, boolean)

EAST

public static final PortSide EAST

A weak constraint indicating that edges can connect to the east side (i.e. right side) of a node.

See Also:

PortConstraint.create(PortSide, boolean)

NORTH

public static final PortSide NORTH

A weak constraint indicating that edges can connect to the north side (i.e. top side) of a node.

See Also:

PortConstraint.create(PortSide, boolean)

SOUTH

public static final PortSide SOUTH

A weak constraint indicating that edges can connect to the south side (i.e. bottom side) of a node.

See Also:

PortConstraint.create(PortSide, boolean)

WEST

public static final PortSide WEST

A weak constraint indicating that edges can connect to the west side (i.e. left side) of a node.

See Also:

PortConstraint.create(PortSide, boolean)

Method Detail

fromOrdinal

public static final PortSide fromOrdinal(int ordinal)

value

public int value()

valueOf

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

Returns:

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