Search this API

y.layout.hierarchic.incremental
Class HierarchicLayouter.IncrementalHint

java.lang.Object
  extended by y.layout.hierarchic.incremental.HierarchicLayouter.IncrementalHint
Enclosing class:
HierarchicLayouter

public static final class HierarchicLayouter.IncrementalHint
extends java.lang.Object

This class describes hint objects used internally by HierarchicLayouter.

See Also:
IncrementalHintsFactory, NodeData.getIncrementalHint()
 

Field Summary
static HierarchicLayouter.IncrementalHint NONE
          Convenience singleton instance of type TYPE_NONE.
static byte TYPE_INCREMENTAL_GROUP_HINT
          Type specifier that is used for groups that shall be inserted into the drawing incrementally during the layering phase.
static byte TYPE_LAYER_INCREMENTALLY_HINT
          Type specifier used for nodes that shall be inserted into the drawing incrementally during the layering phase.
static byte TYPE_NONE
          Type specifier used as dummy.
static byte TYPE_PLACE_USING_EXACT_COORDINATES
          Type specifier used for nodes that shall be placed into the drawing from sketch using the exact current coordinates for both the position within the layer and the position in the sequence.
static byte TYPE_PLACE_USING_EXACT_LAYER_COORDINATE
          Type specifier used for nodes that shall be placed into the drawing from sketch using the exact current coordinates for the position within the layer.
static byte TYPE_PLACE_USING_EXACT_SEQUENCE_COORDINATE
          Type specifier used for nodes that shall be placed into the drawing from sketch using the exact current coordinates for the position within the sequence in the layer.
static byte TYPE_SEQUENCE_INCREMENTALLY_HINT
          Type specifier that is used for nodes and edges that shall be inserted into the drawing incrementally during the sequencing phase.
 
Method Summary
 byte getType()
          Returns the type constant for this hint.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TYPE_NONE

public static final byte TYPE_NONE
Type specifier used as dummy.

This means the corresponding element should not be treated as an incrementally added element by the layout algorithm.

See Also:
Constant Field Values

TYPE_LAYER_INCREMENTALLY_HINT

public static final byte TYPE_LAYER_INCREMENTALLY_HINT
Type specifier used for nodes that shall be inserted into the drawing incrementally during the layering phase.

See Also:
IncrementalHintsFactory.createLayerIncrementallyHint(Object), Constant Field Values

TYPE_SEQUENCE_INCREMENTALLY_HINT

public static final byte TYPE_SEQUENCE_INCREMENTALLY_HINT
Type specifier that is used for nodes and edges that shall be inserted into the drawing incrementally during the sequencing phase.

See Also:
IncrementalHintsFactory.createSequenceIncrementallyHint(Object), Constant Field Values

TYPE_INCREMENTAL_GROUP_HINT

public static final byte TYPE_INCREMENTAL_GROUP_HINT
Type specifier that is used for groups that shall be inserted into the drawing incrementally during the layering phase.

See Also:
Constant Field Values

TYPE_PLACE_USING_EXACT_COORDINATES

public static final byte TYPE_PLACE_USING_EXACT_COORDINATES
Type specifier used for nodes that shall be placed into the drawing from sketch using the exact current coordinates for both the position within the layer and the position in the sequence.

See Also:
IncrementalHintsFactory.createUseExactCoordinatesHint(Object), TYPE_PLACE_USING_EXACT_LAYER_COORDINATE, TYPE_PLACE_USING_EXACT_SEQUENCE_COORDINATE, Constant Field Values

TYPE_PLACE_USING_EXACT_SEQUENCE_COORDINATE

public static final byte TYPE_PLACE_USING_EXACT_SEQUENCE_COORDINATE
Type specifier used for nodes that shall be placed into the drawing from sketch using the exact current coordinates for the position within the sequence in the layer.

See Also:
IncrementalHintsFactory.createUseExactSequenceCoordinatesHint(Object), Constant Field Values

TYPE_PLACE_USING_EXACT_LAYER_COORDINATE

public static final byte TYPE_PLACE_USING_EXACT_LAYER_COORDINATE
Type specifier used for nodes that shall be placed into the drawing from sketch using the exact current coordinates for the position within the layer.

See Also:
IncrementalHintsFactory.createUseExactLayerCoordinatesHint(Object), Constant Field Values

NONE

public static final HierarchicLayouter.IncrementalHint NONE
Convenience singleton instance of type TYPE_NONE.

Method Detail

getType

public byte getType()
Returns the type constant for this hint.

Returns:
one of the predefined type constants

© Copyright 2000-2021,
yWorks GmbH.
All rights reserved.