com.yworks.yfiles.layout

Enum LayoutOrientation

java.lang.Object

java.lang.Enum<LayoutOrientation>

com.yworks.yfiles.layout.LayoutOrientation

All Implemented Interfaces:

Serializable, Comparable<LayoutOrientation>

public enum LayoutOrientation
extends Enum<LayoutOrientation>

Orientation specifier which defines that the main layout orientation is from top to bottom.

See Also:

EdgeLabelOrientationSupport.getOrientedDirection(Direction, LayoutOrientation, MirrorModes), EdgeLabelOrientationSupport.isOrientationMirrored(LayoutOrientation, MirrorModes), AbstractPortConstraintOptimizer.getLayoutOrientation(), MultiStageLayout.getLayoutOrientation(), OrientationLayout.OrientationLayout(LayoutOrientation), OrientationLayout.isOrientationMirrored(LayoutOrientation), OrientationLayout.getOrientation(), PortCandidate.getDirectionForLayoutOrientation(LayoutOrientation), PortCandidate.getXOffsetForLayoutOrientation(LayoutOrientation), PortCandidate.getXOffsetForLayoutOrientation(LayoutOrientation, MirrorModes), PortCandidate.getYOffsetForLayoutOrientation(LayoutOrientation), PortCandidate.getYOffsetForLayoutOrientation(LayoutOrientation, MirrorModes), PortCandidate.toPortConstraintForLayoutOrientation(LayoutOrientation)

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTTOM_TO_TOP Orientation specifier which defines that the main layout orientation is from bottom to top.
LEFT_TO_RIGHT Orientation specifier which defines that the main layout orientation is from left to right.
RIGHT_TO_LEFT Orientation specifier which defines that the main layout orientation is from right to left.
TOP_TO_BOTTOM Orientation specifier which defines that the main layout orientation is from top to bottom.

Method Summary

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

BOTTOM_TO_TOP

public static final LayoutOrientation BOTTOM_TO_TOP

Orientation specifier which defines that the main layout orientation is from bottom to top. The layout will be flipped along the x-axis.

LEFT_TO_RIGHT

public static final LayoutOrientation LEFT_TO_RIGHT

Orientation specifier which defines that the main layout orientation is from left to right. The layout will be rotated by 90 degrees counterclockwise.

RIGHT_TO_LEFT

public static final LayoutOrientation RIGHT_TO_LEFT

Orientation specifier which defines that the main layout orientation is from right to left. The layout will be rotated by 90 degrees clockwise.

TOP_TO_BOTTOM

public static final LayoutOrientation TOP_TO_BOTTOM

Orientation specifier which defines that the main layout orientation is from top to bottom. This is the default for all layout algorithms.

Method Detail

fromOrdinal

public static final LayoutOrientation fromOrdinal(int ordinal)

value

public int value()

valueOf

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

Returns:

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