Packagecom.yworks.yfiles.layout.router
Classpublic class GroupNodeRouterStage
InheritanceGroupNodeRouterStage Inheritance AbstractLayoutStage Inheritance YObject Inheritance Object

Layout stage for com.yworks.yfiles.layout.router.OrthogonalEdgeRouter that should be applied when routing edges in hierarchically grouped graphs. com.yworks.yfiles.layout.router.OrthogonalEdgeRouter itself is not well suited to route edges that connect to grouped nodes, since it considers all nodes (also group nodes!) as obstacles that should be avoided when determining the route of an edge.

See also

com.yworks.yfiles.layout.router.OrthogonalEdgeRouter


Public Properties
 PropertyDefined By
 InheritedcoreLayouter : Layouter
Specifies the core layouter.
AbstractLayoutStage
Public Methods
 MethodDefined By
  
GroupNodeRouterStage(init:Boolean = true)
Creates a new instance of this class.
GroupNodeRouterStage
  
canLayout(graph:LayoutGraph):Boolean
[override]
GroupNodeRouterStage
  
doLayout(graph:LayoutGraph):void
[override] Main layout routine.
GroupNodeRouterStage
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
GroupNodeRouterStage
 Inherited
hashCode():int
YObject
  
[static] Creates a new instance of this class.
GroupNodeRouterStage
  
[static] Creates a new instance of this class.
GroupNodeRouterStage
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.
GroupNodeRouterStage
  
Initializes this object.
GroupNodeRouterStage
Constructor Detail
GroupNodeRouterStage()Constructor
public function GroupNodeRouterStage(init:Boolean = true)

Creates a new instance of this class.

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

Parameters

graph:LayoutGraph

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

Main layout routine.

Precondition the coreLayouter must contain an instance of com.yworks.yfiles.layout.router.OrthogonalEdgeRouter in its layout pipeline.

Parameters

graph:LayoutGraph

See also

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

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

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

See also

initGroupNodeRouterStage2()method 
protected final function initGroupNodeRouterStage2(coreLayouter:Layouter):void

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

Parameters

coreLayouter:Layouter

See also

newGroupNodeRouterStage1()method 
public static function newGroupNodeRouterStage1():GroupNodeRouterStage

Creates a new instance of this class.

Returns
GroupNodeRouterStage
newGroupNodeRouterStage2()method 
public static function newGroupNodeRouterStage2(coreLayouter:Layouter):GroupNodeRouterStage

Creates a new instance of this class.

Parameters

coreLayouter:Layouter — the core layouter invoked by this stage. The coreLayouter must contain an instance of com.yworks.yfiles.layout.router.OrthogonalEdgeRouter in its layout pipeline.

Returns
GroupNodeRouterStage

See also