Packagecom.yworks.yfiles.layout.tree
Classpublic class GroupedNodePlacer
InheritanceGroupedNodePlacer Inheritance YObject Inheritance Object
Implements NodePlacer

A com.yworks.yfiles.layout.tree.NodePlacer that places the children of a local root in groups.

The placement of the groups is specified by a com.yworks.yfiles.layout.tree.NodePlacer which will consider grouped children as one child. The children within a group are placed by another NodePlacer.

The groups are determined by the grouping of the edges that connect the children to its root.

See also

com.yworks.yfiles.layout.PortConstraintKeys.SOURCE_GROUPID_KEY
com.yworks.yfiles.layout.PortConstraintKeys.TARGET_GROUPID_KEY
com.yworks.yfiles.layout.tree.NodePlacer


Public Methods
 MethodDefined By
  
GroupedNodePlacer(groupPlacer:NodePlacer, childPlacer:NodePlacer, init:Boolean = true)
Creates a new instance of GroupedNodePlacer that uses a groupPlacer to place the grouped nodes combined and a childPlacer to place the children within their group.
GroupedNodePlacer
  
GroupedNodePlacer
  
determineChildConnectors(localRoot:Node, connectorMap:DataMap):void
GroupedNodePlacer
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
GroupedNodePlacer
 Inherited
hashCode():int
YObject
  
[static] Creates a new instance of GroupedNodePlacer that uses a groupPlacer to place the grouped nodes combined and a childPlacer to place the children within their group.
GroupedNodePlacer
  
placeSubtree(nodeShapeProvider:DataProvider, subtreeShapeProvider:DataProvider, graph:LayoutGraph, localRoot:Node, parentConnectorDirection:int):GenericTreeLayouter_SubtreeShape
GroupedNodePlacer
Protected Methods
 MethodDefined By
  
initGroupedNodePlacer(groupPlacer:NodePlacer, childPlacer:NodePlacer):void
Initializes this object.
GroupedNodePlacer
Constructor Detail
GroupedNodePlacer()Constructor
public function GroupedNodePlacer(groupPlacer:NodePlacer, childPlacer:NodePlacer, init:Boolean = true)

Creates a new instance of GroupedNodePlacer that uses a groupPlacer to place the grouped nodes combined and a childPlacer to place the children within their group.

Parameters
groupPlacer:NodePlacer — the NodePlacer which places the child groups.
 
childPlacer:NodePlacer — the NodePlacer which places the children within their group.
 
init:Boolean (default = true) — An internally used switch to help handle proper instance initialization in inheritance chains where classes can have multiple constructor-like factory methods. This parameter can safely be ignored/omitted when calling the constructor.
Method Detail
createProcessor()method
public function createProcessor(layouter:GenericTreeLayouter, graph:LayoutGraph, currentRoot:Node):Processor

Parameters

layouter:GenericTreeLayouter
 
graph:LayoutGraph
 
currentRoot:Node

Returns
Processor
determineChildConnectors()method 
public function determineChildConnectors(localRoot:Node, connectorMap:DataMap):void

Parameters

localRoot:Node
 
connectorMap:DataMap

getClass()method 
override public function getClass():Class

Returns
Class
initGroupedNodePlacer()method 
protected final function initGroupedNodePlacer(groupPlacer:NodePlacer, childPlacer:NodePlacer):void

Initializes this object. See the documentation of the corresponding factory method newGroupedNodePlacer() for details.

Parameters

groupPlacer:NodePlacer
 
childPlacer:NodePlacer

See also

newGroupedNodePlacer()method 
public static function newGroupedNodePlacer(groupPlacer:NodePlacer, childPlacer:NodePlacer):GroupedNodePlacer

Creates a new instance of GroupedNodePlacer that uses a groupPlacer to place the grouped nodes combined and a childPlacer to place the children within their group.

Parameters

groupPlacer:NodePlacer — the NodePlacer which places the child groups.
 
childPlacer:NodePlacer — the NodePlacer which places the children within their group.

Returns
GroupedNodePlacer
placeSubtree()method 
public function placeSubtree(nodeShapeProvider:DataProvider, subtreeShapeProvider:DataProvider, graph:LayoutGraph, localRoot:Node, parentConnectorDirection:int):GenericTreeLayouter_SubtreeShape

Parameters

nodeShapeProvider:DataProvider
 
subtreeShapeProvider:DataProvider
 
graph:LayoutGraph
 
localRoot:Node
 
parentConnectorDirection:int

Returns
GenericTreeLayouter_SubtreeShape