y.layout.hierarchic.incremental
Interface IncrementalHintsFactory

public interface IncrementalHintsFactory

Factory interface for IncrementalHierarchicLayouter. Use this factory to obtain hints that will be interpreted by the layouter if they are bound to a DataProvider instance that is registered with the LayoutGraph using the IncrementalHierarchicLayouter.INCREMENTAL_HINTS_DPKEY key.
An instance of a class implementing this interface can be obtained through IncrementalHierarchicLayouter.createIncrementalHintsFactory().

Method Summary

Object	createLayerIncrementallyHint(Node forNode) Creates a hint object for a node that should be inserted incrementally after the layering phase.
Object	createSequenceIncrementallyHint(Edge forEdge) Creates a hint object for an edge that should be routed incrementally after the sequencing phase.
Object	createSequenceIncrementallyHint(Node forNode) Creates a hint object for a node that should be inserted incrementally after the sequencing phase.
Object	createUseExactCoordinatesHint(Node forNode) Creates a hint object for a node that should be inserted incrementally into the graph at its exact current position.
Object	createUseExactLayerCoordinatesHint(Node forNode) Creates a hint object for a node that should be inserted incrementally into the graph at its exact current layer position.
Object	createUseExactSequenceCoordinatesHint(Node forNode) Creates a hint object for a node that should be inserted incrementally into the graph at its exact current sequence position.

Method Detail

createLayerIncrementallyHint

Object createLayerIncrementallyHint(Node forNode)

Creates a hint object for a node that should be inserted incrementally after the layering phase. This will place the node in a suitable layer, thus possibly creating new layers. Neighbors of this node may be marked as to be laid out incrementally, too. This makes it possible to incrementally add whole subgraphs to the current layout.

Parameters:

forNode - the node to be layered and sequenced incrementally together with its adjacent edges and possibly marked neighboring nodes.

Returns:

an Object that can be interpreted by HierarchicLayouter

createSequenceIncrementallyHint

Object createSequenceIncrementallyHint(Node forNode)

Creates a hint object for a node that should be inserted incrementally after the sequencing phase. This will prevent the layering from being changed. The node will be placed into an already existing layer that is determined by the HierarchicLayouter.getLayerer() implementation, i.e. "from sketch". Adjacent edges will automatically be be rerouted optimally.

Parameters:

forNode - the node to be sequenced/inserted incrementally

Returns:

an Object that can be interpreted by HierarchicLayouter

createUseExactCoordinatesHint

Object createUseExactCoordinatesHint(Node forNode)

Creates a hint object for a node that should be inserted incrementally into the graph at its exact current position. The node will be placed into an already existing layer that is determined by the layerer implementation. The position within its layer will be determined by its current position.

Parameters:

forNode - the node to be placed at its exact current position

Returns:

an Object that can be interpreted by HierarchicLayouter

See Also:

createUseExactSequenceCoordinatesHint(y.base.Node), createUseExactLayerCoordinatesHint(y.base.Node), SimplexNodePlacer.setExactPlacementEnforced(boolean)

createUseExactLayerCoordinatesHint

Object createUseExactLayerCoordinatesHint(Node forNode)

Creates a hint object for a node that should be inserted incrementally into the graph at its exact current layer position. The node will be placed into an already existing layer that is determined by the layerer at the position that it occupies initially. The position within its layer will be determined by the NodePlacer.

Parameters:

forNode - the node to be placed at its exact current layer position

Returns:

an Object that can be interpreted by HierarchicLayouter

See Also:

createUseExactCoordinatesHint(y.base.Node), createUseExactSequenceCoordinatesHint(y.base.Node), SimplexNodePlacer.setExactPlacementEnforced(boolean)

createUseExactSequenceCoordinatesHint

Object createUseExactSequenceCoordinatesHint(Node forNode)

Creates a hint object for a node that should be inserted incrementally into the graph at its exact current sequence position. The node will be placed into an already existing layer that is determined by the layerer at the position that is deemed best for its layer. The position within the sequence of its layer will be determined by its current coordinates.

Parameters:

forNode - the node to be placed at its exact current sequence position

Returns:

an Object that can be interpreted by HierarchicLayouter

See Also:

createUseExactCoordinatesHint(y.base.Node), createUseExactLayerCoordinatesHint(y.base.Node), SimplexNodePlacer.setExactPlacementEnforced(boolean)

createSequenceIncrementallyHint

Object createSequenceIncrementallyHint(Edge forEdge)

Creates a hint object for an edge that should be routed incrementally after the sequencing phase. This will prevent the layering from being changed. The edge will be rerouted in a locally optimal fashion.

Parameters:

forEdge - the edge to be rerouted/inserted incrementally

Returns:

an Object that can be interpreted by HierarchicLayouter