Packagecom.yworks.yfiles.layout.grouping
Classpublic class ParentEdgeAugmentationStage
InheritanceParentEdgeAugmentationStage Inheritance AbstractLayoutStage Inheritance YObject Inheritance Object

This class can be used as a decorating stage for layout algorithms that cannot handle node groups. Before calling the core layout algorithms, this class will augment the graph structure. For each node that belongs to a group, a so-called "parent-edge" will be temporarily inserted into the graph.



Public Properties
 PropertyDefined By
 InheritedcoreLayouter : Layouter
Specifies the core layouter.
AbstractLayoutStage
Public Methods
 MethodDefined By
  
ParentEdgeAugmentationStage(init:Boolean = true)
Creates a new instance of ParentEdgeAugmentationStage
ParentEdgeAugmentationStage
  
canLayout(graph:LayoutGraph):Boolean
[override] Returns true if the core layouter can layout the augmented graph.
ParentEdgeAugmentationStage
  
doLayout(graph:LayoutGraph):void
[override]
ParentEdgeAugmentationStage
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
ParentEdgeAugmentationStage
 Inherited
hashCode():int
YObject
  
[static] Creates a new instance of ParentEdgeAugmentationStage
ParentEdgeAugmentationStage
Protected Methods
 MethodDefined By
 Inherited
canLayoutCore(graph:LayoutGraph):Boolean
Queries the core layouter whether or not the given graph can be laid out.
AbstractLayoutStage
 Inherited
Invokes the layout routine of the core layouter.
AbstractLayoutStage
 Inherited
AbstractLayoutStage
 Inherited
AbstractLayoutStage
  
Initializes this object.
ParentEdgeAugmentationStage
Constructor Detail
ParentEdgeAugmentationStage()Constructor
public function ParentEdgeAugmentationStage(init:Boolean = true)

Creates a new instance of ParentEdgeAugmentationStage

Parameters
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
canLayout()method
override public function canLayout(graph:LayoutGraph):Boolean

Returns true if the core layouter can layout the augmented graph.

Parameters

graph:LayoutGraph

Returns
Boolean
doLayout()method 
override public function doLayout(graph:LayoutGraph):void

Parameters

graph:LayoutGraph

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

Returns
Class
initParentEdgeAugmentationStage()method 
protected final function initParentEdgeAugmentationStage():void

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

See also

newParentEdgeAugmentationStage()method 
public static function newParentEdgeAugmentationStage():ParentEdgeAugmentationStage

Creates a new instance of ParentEdgeAugmentationStage

Returns
ParentEdgeAugmentationStage