com.yworks.yfiles.layout.circular

Enum LayoutStyle

java.lang.Object

java.lang.Enum<LayoutStyle>

com.yworks.yfiles.layout.circular.LayoutStyle

All Implemented Interfaces:

Serializable, Comparable<LayoutStyle>

public enum LayoutStyle
extends Enum<LayoutStyle>

See Also:

CircularLayout.getLayoutStyle()

Enum Constant Summary

Enum Constants

Enum Constant and Description
BCC_COMPACT The specifier for a layout style where the nodes within a biconnected component of the input graph are treated as separate partitions.
BCC_ISOLATED The specifier for a layout style where the nodes within a biconnected component of the input graph are treated as separate partitions.
CUSTOM_GROUPS The specifier for a layout style where the user can specify groups that will form separate partitions.
SINGLE_CYCLE The specifier for a layout style where all nodes of the input graph will be placed on or in the interior of a single cycle.

Method Summary

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

BCC_COMPACT

public static final LayoutStyle BCC_COMPACT

The specifier for a layout style where the nodes within a biconnected component of the input graph are treated as separate partitions.

If a node belongs to more than one biconnected component, it will be assigned to the one that seems to be more suitable.

See Also:

CircularLayout.setLayoutStyle(LayoutStyle)

BCC_ISOLATED

public static final LayoutStyle BCC_ISOLATED

The specifier for a layout style where the nodes within a biconnected component of the input graph are treated as separate partitions.

If a node belongs to more than one biconnected component, it will form an isolated partition and will be laid out in between of all its biconnected component cycles.

See Also:

CircularLayout.setLayoutStyle(LayoutStyle)

CUSTOM_GROUPS

public static final LayoutStyle CUSTOM_GROUPS

The specifier for a layout style where the user can specify groups that will form separate partitions. To define the groups, a IDataProvider with key CircularLayout.CUSTOM_GROUPS_DPKEY must be registered.

See Also:

CircularLayout.setLayoutStyle(LayoutStyle)

SINGLE_CYCLE

public static final LayoutStyle SINGLE_CYCLE

The specifier for a layout style where all nodes of the input graph will be placed on or in the interior of a single cycle.

See Also:

CircularLayout.setLayoutStyle(LayoutStyle)

Method Detail

fromOrdinal

public static final LayoutStyle fromOrdinal(int ordinal)

value

public int value()

valueOf

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

Returns:

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