com.yworks.yfiles.layout.hierarchic

Enum ComponentArrangementPolicy

java.lang.Object

java.lang.Enum<ComponentArrangementPolicy>

com.yworks.yfiles.layout.hierarchic.ComponentArrangementPolicy

All Implemented Interfaces:

Serializable, Comparable<ComponentArrangementPolicy>

public enum ComponentArrangementPolicy
extends Enum<ComponentArrangementPolicy>

See Also:

HierarchicLayout.getComponentArrangementPolicy()

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPACT A component arrangement policy that achieves a 1:1 aspect ratio for the graph.
TOPMOST A component arrangement policy that aligns the components with their topmost layer.

Method Summary

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

COMPACT

public static final ComponentArrangementPolicy COMPACT

A component arrangement policy that achieves a 1:1 aspect ratio for the graph.

After layering the single components with the core layerer, the components will be merged such that an 1:1 aspect ratio is fulfilled best.

See Also:

HierarchicLayout.setComponentArrangementPolicy(ComponentArrangementPolicy)

TOPMOST

public static final ComponentArrangementPolicy TOPMOST

A component arrangement policy that aligns the components with their topmost layer.

After layering the single components with the core layerer, the components are aligned with their topmost layer.

See Also:

HierarchicLayout.setComponentArrangementPolicy(ComponentArrangementPolicy)

Method Detail

fromOrdinal

public static final ComponentArrangementPolicy fromOrdinal(int ordinal)

value

public int value()

valueOf

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

Returns:

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