Packagecom.yworks.yfiles.layout.hierarchic.incremental
Interfacepublic interface IncrementalHintsFactory

Factory interface for com.yworks.yfiles.layout.hierarchic.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 com.yworks.yfiles.layout.hierarchic.IncrementalHierarchicLayouter.INCREMENTAL_HINTS_DPKEY key. An instance of a class implementing this interface can be obtained through com.yworks.yfiles.layout.hierarchic.IncrementalHierarchicLayouter.createIncrementalHintsFactory().

See also

com.yworks.yfiles.layout.hierarchic.IncrementalHierarchicLayouter
com.yworks.yfiles.layout.hierarchic.IncrementalHierarchicLayouter.INCREMENTAL_HINTS_DPKEY
com.yworks.yfiles.layout.hierarchic.IncrementalHierarchicLayouter.createIncrementalHintsFactory()


Public Methods
 MethodDefined By
  
createIncrementalGroupHint(forItemId:Object):Object
Creates a hint object for a group node that should be inserted incrementally.
IncrementalHintsFactory
  
createLayerIncrementallyHint(forNodeId:Object):Object
Creates a hint object for a node that should be inserted incrementally during the layering phase.
IncrementalHintsFactory
  
createSequenceIncrementallyHint(forItemId:Object):Object
Creates a hint object for a node or edge that should be inserted incrementally during the sequencing phase.
IncrementalHintsFactory
  
createUseExactCoordinatesHint(forNodeId:Object):Object
Creates a hint object for a node that should be inserted incrementally into the graph at its exact current position.
IncrementalHintsFactory
  
createUseExactLayerCoordinatesHint(forNodeId:Object):Object
Creates a hint object for a node that should be inserted incrementally into the graph at its exact current layer position.
IncrementalHintsFactory
  
createUseExactSequenceCoordinatesHint(forNodeId:Object):Object
Creates a hint object for a node that should be inserted incrementally into the graph at its exact current sequence position.
IncrementalHintsFactory
Method Detail
createIncrementalGroupHint()method
public function createIncrementalGroupHint(forItemId:Object):Object

Creates a hint object for a group node that should be inserted incrementally. The group will be placed on a suitable position. The descendants of the group may be associated with hints created by method createLayerIncrementallyHint(), createSequenceIncrementallyHint() or this method (if the descendant is an inner group). All hints of the group's descendants are interpreted relative to the group node. Descendants without hints keep their relative ordering within the group node (but not with elements outside the group). The position of groups without incremental hint depends on the position of their descendants (i.e., the group is not interpreted as fixed - it is simply ignored).

Note: Descendants of incremental groups must not be associated with exact coordinate hints (see method createUseExactCoordinatesHint(), createUseExactSequenceCoordinatesHint() and createUseExactLayerCoordinatesHint()).

Parameters

forItemId:Object — the group node.

Returns
Object — an Object that can be interpreted by com.yworks.yfiles.layout.hierarchic.incremental.HierarchicLayouterImpl

See also

createLayerIncrementallyHint()method 
public function createLayerIncrementallyHint(forNodeId:Object):Object

Creates a hint object for a node that should be inserted incrementally during 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

forNodeId:Object — the node to be layered and sequenced incrementally together with its adjacent edges and possibly marked neighboring nodes.

Returns
Object — an Object that can be interpreted by com.yworks.yfiles.layout.hierarchic.incremental.HierarchicLayouterImpl

See also

createSequenceIncrementallyHint()method 
public function createSequenceIncrementallyHint(forItemId:Object):Object

Creates a hint object for a node or edge that should be inserted incrementally during 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 com.yworks.yfiles.layout.hierarchic.incremental.HierarchicLayouterImpl.layerer implementation, i.e. "from sketch". Adjacent edges will automatically be rerouted optimally.

Parameters

forItemId:Object — the node or edge to be sequenced/inserted incrementally.

Returns
Object — an Object that can be interpreted by com.yworks.yfiles.layout.hierarchic.incremental.HierarchicLayouterImpl

See also

createUseExactCoordinatesHint()method 
public function createUseExactCoordinatesHint(forNodeId:Object):Object

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 (com.yworks.yfiles.layout.hierarchic.incremental.HierarchicLayouterImpl.layerer) implementation. The position within its layer will be determined by its current position.

Parameters

forNodeId:Object — the node to be placed at its exact current position.

Returns
Object — an Object that can be interpreted by com.yworks.yfiles.layout.hierarchic.incremental.HierarchicLayouterImpl

See also

createUseExactLayerCoordinatesHint()method 
public function createUseExactLayerCoordinatesHint(forNodeId:Object):Object

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 (com.yworks.yfiles.layout.hierarchic.incremental.HierarchicLayouterImpl.layerer) at the position that it occupies initially. The position within its layer will be determined by the com.yworks.yfiles.layout.hierarchic.incremental.NodePlacer.

Parameters

forNodeId:Object — the node to be placed at its exact current layer position.

Returns
Object — an Object that can be interpreted by com.yworks.yfiles.layout.hierarchic.incremental.HierarchicLayouterImpl

See also

createUseExactSequenceCoordinatesHint()method 
public function createUseExactSequenceCoordinatesHint(forNodeId:Object):Object

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 (com.yworks.yfiles.layout.hierarchic.incremental.HierarchicLayouterImpl.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

forNodeId:Object — the node to be placed at its exact current sequence position.

Returns
Object — an Object that can be interpreted by com.yworks.yfiles.layout.hierarchic.incremental.HierarchicLayouterImpl

See also