Packagecom.yworks.yfiles.layout.hierarchic.incremental
Classpublic class TopLevelGroupToSwimlaneStage
InheritanceTopLevelGroupToSwimlaneStage Inheritance AbstractLayoutStage Inheritance YObject Inheritance Object

This layout stage can be used to automatically assign com.yworks.yfiles.layout.hierarchic.incremental.SwimLaneDescriptor instances to nodes using the com.yworks.yfiles.layout.hierarchic.IncrementalHierarchicLayouter.SWIMLANE_DESCRIPTOR_DPKEY by treating top-level group nodes as swimlanes. This stage will modify the hierarchy by removing the top level group nodes and assign corresponding descriptors to the remaining nodes. After running the core layout, the nodes will be arranged to function as swim lanes. This class allows for using the current coordinates of the group nodes to arrange the swim lanes from sketch (orderSwimlanesFromSketch). Also the spacing (spacing) between swim lanes may be specified.

This stage can be appended (com.yworks.yfiles.layout.CanonicMultiStageLayouter.appendStage()) to the com.yworks.yfiles.layout.hierarchic.IncrementalHierarchicLayouter.

See also

com.yworks.yfiles.layout.hierarchic.IncrementalHierarchicLayouter
com.yworks.yfiles.layout.hierarchic.incremental.SwimLaneDescriptor
com.yworks.yfiles.layout.grouping.GroupingKeys
com.yworks.yfiles.layout.hierarchic.IncrementalHierarchicLayouter.SWIMLANE_DESCRIPTOR_DPKEY
arrange the swim lanes from sketch
spacing
appended


Public Properties
 PropertyDefined By
 InheritedcoreLayouter : Layouter
Specifies the core layouter.
AbstractLayoutStage
  orderSwimlanesFromSketch : Boolean
Determines whether the order of the swimlanes should be read from the current sketch.
TopLevelGroupToSwimlaneStage
  spacing : Number
Determines the spacing between the lanes.
TopLevelGroupToSwimlaneStage
Public Methods
 MethodDefined By
  
TopLevelGroupToSwimlaneStage(init:Boolean = true)
TopLevelGroupToSwimlaneStage
  
canLayout(graph:LayoutGraph):Boolean
[override]
TopLevelGroupToSwimlaneStage
  
doLayout(graph:LayoutGraph):void
[override]
TopLevelGroupToSwimlaneStage
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
TopLevelGroupToSwimlaneStage
 Inherited
hashCode():int
YObject
  
[static]
TopLevelGroupToSwimlaneStage
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
  
TopLevelGroupToSwimlaneStage
Property Detail
orderSwimlanesFromSketchproperty
orderSwimlanesFromSketch:Boolean

Determines whether the order of the swimlanes should be read from the current sketch. The default is false.


Implementation
    public function get orderSwimlanesFromSketch():Boolean
    public function set orderSwimlanesFromSketch(value:Boolean):void
spacingproperty 
spacing:Number

Determines the spacing between the lanes. The default is 0.0d.


Implementation
    public function get spacing():Number
    public function set spacing(value:Number):void
Constructor Detail
TopLevelGroupToSwimlaneStage()Constructor
public function TopLevelGroupToSwimlaneStage(init:Boolean = true)



Parameters
init:Boolean (default = true)
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

Parameters

graph:LayoutGraph

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

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

newTopLevelGroupToSwimlaneStage()method 
public static function newTopLevelGroupToSwimlaneStage():TopLevelGroupToSwimlaneStage

Returns
TopLevelGroupToSwimlaneStage