com.yworks.yfiles.layout.hierarchic

Enum LayoutMode

java.lang.Object

java.lang.Enum<LayoutMode>

com.yworks.yfiles.layout.hierarchic.LayoutMode

All Implemented Interfaces:

Serializable, Comparable<LayoutMode>

public enum LayoutMode
extends Enum<LayoutMode>

See Also:

HierarchicLayout.getLayoutMode()

Enum Constant Summary

Enum Constants

Enum Constant and Description
FROM_SCRATCH A layout mode that will recompute the complete layout from scratch.
INCREMENTAL A layout mode that allows to keep some nodes fixed and insert the remaining nodes incrementally.

Method Summary

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

FROM_SCRATCH

public static final LayoutMode FROM_SCRATCH

A layout mode that will recompute the complete layout from scratch.

All elements will be handled by the same layerer and sequencer.

See Also:

HierarchicLayout.setLayoutMode(LayoutMode), HierarchicLayout.setFromScratchSequencer(com.yworks.yfiles.layout.hierarchic.ISequencer), HierarchicLayout.setFromScratchLayerer(com.yworks.yfiles.layout.hierarchic.ILayerer)

INCREMENTAL

public static final LayoutMode INCREMENTAL

A layout mode that allows to keep some nodes fixed and insert the remaining nodes incrementally.

Fixed elements will be handled by the fixed elements sequencer and fixed elements layerer. Incremental elements will be added during the layering or the sequencing phase. They are handled by from scratch layerer and fixed elements layerer respectively.

See Also:

IIncrementalHintsFactory.createLayerIncrementallyHint(java.lang.Object), HierarchicLayout.setLayoutMode(LayoutMode), HierarchicLayout.setFixedElementsSequencer(com.yworks.yfiles.layout.hierarchic.ISequencer), HierarchicLayout.setFixedElementsLayerer(com.yworks.yfiles.layout.hierarchic.ILayerer)

Method Detail

fromOrdinal

public static final LayoutMode fromOrdinal(int ordinal)

value

public int value()

valueOf

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

Returns:

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