com.yworks.yfiles.layout

Class PortDirections

java.lang.Object

java.lang.Number

com.yworks.yfiles.utils.FlagsEnum<PortDirections>

com.yworks.yfiles.layout.PortDirections

All Implemented Interfaces:

Serializable

public final class PortDirections
extends FlagsEnum<PortDirections>

See Also:

PortCandidate.createCandidate(double, double, PortDirections, double), PortCandidate.createCandidate(PortDirections), PortCandidate.createCandidate(PortDirections, double), PortCandidate.getDirection(), PortCandidate.getDirectionForLayoutOrientation(LayoutOrientation), PortCandidate.isInDirection(PortDirections), PortCandidateSet.ICandidateMatcher.findMatchingCandidate(com.yworks.yfiles.algorithms.Edge, boolean, double, double, PortDirections), PortCandidateSet.ICandidateMatcher.findMatchingCandidate(com.yworks.yfiles.algorithms.Edge, boolean, PortDirections), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static PortDirections	AGAINST_THE_FLOW A port direction specifier indicating a port lying in the opposite direction of the main flow of the edge or of the overall layout.
static PortDirections	ANY A combination of all possible direction specifiers indicating that edges can connect to any side of a node.
static PortDirections	EAST A port direction specifier indicating a port on the east (i.e., right) side of a node.
static PortDirections	LEFT_IN_FLOW A port direction specifier indicating a port lying left of the direction of the main flow of the edge or of the overall layout.
static PortDirections	NORTH A port direction specifier indicating a port on the north (i.e., top) side of a node.
static PortDirections	RIGHT_IN_FLOW A port direction specifier indicating a port lying right of the direction of the main flow of the edge or of the overall layout.
static PortDirections	SOUTH A port direction specifier indicating a port on the south (i.e., bottom) side of a node.
static PortDirections	WEST A port direction specifier indicating a port on the west (i.e., left) side of a node.
static PortDirections	WITH_THE_FLOW A port direction specifier indicating a port lying in the direction of the main flow of the edge or of the overall layout.

Method Summary

Modifier and Type	Method and Description
static PortDirections	fromName(String name)
static PortDirections	fromOrdinal(int value)
protected PortDirections	fromOrdinalImpl(int ordinal)
protected PortDirections[]	getItems() Returns all items defined in this FlagsEnum.
int	value()

Methods inherited from class com.yworks.yfiles.utils.FlagsEnum

and, and, contains, containsAll, doubleValue, equals, equals, floatValue, hashCode, intValue, inverse, inverse, longValue, notContains, notEquals, or, or, ordinal, toString, xor, xor

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

AGAINST_THE_FLOW

public static final PortDirections AGAINST_THE_FLOW

A port direction specifier indicating a port lying in the opposite direction of the main flow of the edge or of the overall layout.

The exact direction is domain-specific.

ANY

public static final PortDirections ANY

A combination of all possible direction specifiers indicating that edges can connect to any side of a node.

EAST

public static final PortDirections EAST

A port direction specifier indicating a port on the east (i.e., right) side of a node.

LEFT_IN_FLOW

public static final PortDirections LEFT_IN_FLOW

A port direction specifier indicating a port lying left of the direction of the main flow of the edge or of the overall layout.

The exact direction is domain-specific.

NORTH

public static final PortDirections NORTH

A port direction specifier indicating a port on the north (i.e., top) side of a node.

RIGHT_IN_FLOW

public static final PortDirections RIGHT_IN_FLOW

A port direction specifier indicating a port lying right of the direction of the main flow of the edge or of the overall layout.

The exact direction is domain-specific.

SOUTH

public static final PortDirections SOUTH

A port direction specifier indicating a port on the south (i.e., bottom) side of a node.

WEST

public static final PortDirections WEST

A port direction specifier indicating a port on the west (i.e., left) side of a node.

WITH_THE_FLOW

public static final PortDirections WITH_THE_FLOW

A port direction specifier indicating a port lying in the direction of the main flow of the edge or of the overall layout.

The exact direction is domain-specific.

Method Detail

fromName

public static final PortDirections fromName(String name)

fromOrdinal

public static final PortDirections fromOrdinal(int value)

fromOrdinalImpl

protected final PortDirections fromOrdinalImpl(int ordinal)

Specified by:

fromOrdinalImpl in class FlagsEnum<PortDirections>

getItems

protected final PortDirections[] getItems()

Description copied from class: FlagsEnum

Returns all items defined in this FlagsEnum.

Specified by:

getItems in class FlagsEnum<PortDirections>

value

public int value()