com.yworks.yfiles.layout.partial

Enum LayoutOrientation

java.lang.Object

java.lang.Enum<LayoutOrientation>

com.yworks.yfiles.layout.partial.LayoutOrientation

All Implemented Interfaces:

Serializable, Comparable<LayoutOrientation>

public enum LayoutOrientation
extends Enum<LayoutOrientation>

See Also:

PartialLayout.getLayoutOrientation()

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO_DETECT Layout orientation specifier where the algorithm automatically detects the layout orientation.
BOTTOM_TO_TOP Layout orientation specifier where the algorithm tries to place partial nodes (subgraph components) such that each predecessor of a node v is placed below v and each successor above v.
LEFT_TO_RIGHT Layout orientation specifier where the algorithm tries to place partial nodes (subgraph components) such that each predecessor of a node v is placed to the left of v and each successor to the right of v.
NONE Layout orientation specifier where the layout orientation is completely ignored.
RIGHT_TO_LEFT Layout orientation specifier where the algorithm tries to place partial nodes (subgraph components) such that each predecessor of a node v is placed to the right of v and each successor to the left of v.
TOP_TO_BOTTOM Layout orientation specifier where the algorithm tries to place partial nodes (subgraph components) such that each predecessor of a node v is placed above v and each successor below v.

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

AUTO_DETECT

public static final LayoutOrientation AUTO_DETECT

Layout orientation specifier where the algorithm automatically detects the layout orientation.

The algorithm analyzes the flow direction of fixed edges in the current drawing. If there is no common flow direction, the results are the same as for NONE. Otherwise, the layout orientation is either TOP_TO_BOTTOM, BOTTOM_TO_TOP, LEFT_TO_RIGHT or RIGHT_TO_LEFT.

This specifier only affects the placement of nodes of different subgraph components that are connected by directed edges. For nodes of the same subgraph component the layout orientation depends on the chosen core layout algorithm.

See Also:

PartialLayout.setLayoutOrientation(LayoutOrientation)

BOTTOM_TO_TOP

public static final LayoutOrientation BOTTOM_TO_TOP

Layout orientation specifier where the algorithm tries to place partial nodes (subgraph components) such that each predecessor of a node v is placed below v and each successor above v.

This specifier only affects the placement of nodes of different subgraph components that are connected by directed edges. For nodes of the same subgraph component the layout orientation depends on the selected core layout algorithm.

See Also:

PartialLayout.setLayoutOrientation(LayoutOrientation)

LEFT_TO_RIGHT

public static final LayoutOrientation LEFT_TO_RIGHT

Layout orientation specifier where the algorithm tries to place partial nodes (subgraph components) such that each predecessor of a node v is placed to the left of v and each successor to the right of v.

This specifier only affects the placement of nodes of different subgraph components that are connected by directed edges. For nodes of the same subgraph component the layout orientation depends on the chosen core layout algorithm.

See Also:

PartialLayout.setLayoutOrientation(LayoutOrientation)

NONE

public static final LayoutOrientation NONE

Layout orientation specifier where the layout orientation is completely ignored.

This specifier only affects the placement of nodes of different subgraph components that are connected by directed edges. For nodes of the same subgraph component the layout orientation depends on the chosen core layout algorithm.

See Also:

PartialLayout.setLayoutOrientation(LayoutOrientation)

RIGHT_TO_LEFT

public static final LayoutOrientation RIGHT_TO_LEFT

Layout orientation specifier where the algorithm tries to place partial nodes (subgraph components) such that each predecessor of a node v is placed to the right of v and each successor to the left of v.

This specifier only affects the placement of nodes of different subgraph components that are connected by directed edges. For nodes of the same subgraph component the layout orientation depends on the chosen core layout algorithm.

See Also:

PartialLayout.setLayoutOrientation(LayoutOrientation)

TOP_TO_BOTTOM

public static final LayoutOrientation TOP_TO_BOTTOM

Layout orientation specifier where the algorithm tries to place partial nodes (subgraph components) such that each predecessor of a node v is placed above v and each successor below v.

This specifier only affects the placement of nodes of different subgraph components that are connected by directed edges. For nodes of the same subgraph component the layout orientation depends on the selected core layout algorithm.

See Also:

PartialLayout.setLayoutOrientation(LayoutOrientation)

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