Packagecom.yworks.yfiles.layout.router
Classpublic class PartitionGridRouterStage
InheritancePartitionGridRouterStage Inheritance AbstractLayoutStage Inheritance YObject Inheritance Object

Layout stage for com.yworks.yfiles.layout.router.OrthogonalEdgeRouter that should be applied when routing edges in a partition grid. Note: This stage can only be applied if all nodes are contained within a single partition grid, i.e., edges can never cross the border of the partition grid.

See also

com.yworks.yfiles.layout.grid.PartitionGrid
com.yworks.yfiles.layout.router.OrthogonalEdgeRouter


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

Parameters

graph:LayoutGraph

See also

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

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

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

See also

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

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

Parameters

coreLayouter:Layouter

See also

newPartitionGridRouterStage1()method 
public static function newPartitionGridRouterStage1():PartitionGridRouterStage

Creates a new instance of this class.

Returns
PartitionGridRouterStage
newPartitionGridRouterStage2()method 
public static function newPartitionGridRouterStage2(coreLayouter:Layouter):PartitionGridRouterStage

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
PartitionGridRouterStage

See also