Packagecom.yworks.yfiles.layout
Classpublic class CompositeLayoutStage
InheritanceCompositeLayoutStage Inheritance AbstractLayoutStage Inheritance YObject Inheritance Object

A composite layout stage that allows to express a layout stage as a chain of more basic layout stages.


Public Properties
 PropertyDefined By
 InheritedcoreLayouter : Layouter
Specifies the core layouter.
AbstractLayoutStage
  layoutStages : List
[read-only] Returns the chain of layout stages that make up this composite layout stage.
CompositeLayoutStage
Public Methods
 MethodDefined By
  
CompositeLayoutStage(init:Boolean = true)
Creates a new instance of CompositeLayoutStage
CompositeLayoutStage
  
appendStage(stage:LayoutStage):void
Appends a stage to the layout pipeline.
CompositeLayoutStage
  
canLayout(graph:LayoutGraph):Boolean
[override] Returns true.
CompositeLayoutStage
  
doLayout(graph:LayoutGraph):void
[override] Assigns a new graph layout to the given layout graph.
CompositeLayoutStage
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
CompositeLayoutStage
 Inherited
hashCode():int
YObject
  
newCompositeLayoutStage1():CompositeLayoutStage
[static] Creates a new instance of CompositeLayoutStage
CompositeLayoutStage
  
newCompositeLayoutStage2(outerStage:LayoutStage, innerStage:LayoutStage):CompositeLayoutStage
[static] Creates a new instance of CompositeLayoutStage
CompositeLayoutStage
  
prependStage(stage:LayoutStage):void
Prepends a stage to this composite layout stage.
CompositeLayoutStage
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
doLayoutCore(graph:LayoutGraph):void
Invokes the layout routine of the core layouter.
AbstractLayoutStage
 Inherited
initAbstractLayoutStage1():void
AbstractLayoutStage
 Inherited
initAbstractLayoutStage2(core:Layouter):void
AbstractLayoutStage
  
initCompositeLayoutStage1():void
Initializes this object.
CompositeLayoutStage
  
initCompositeLayoutStage2(outerStage:LayoutStage, innerStage:LayoutStage):void
Initializes this object.
CompositeLayoutStage
Property Detail
layoutStagesproperty
layoutStages:List  [read-only]

Returns the chain of layout stages that make up this composite layout stage.


Implementation
    public function get layoutStages():List
Constructor Detail
CompositeLayoutStage()Constructor
public function CompositeLayoutStage(init:Boolean = true)

Creates a new instance of CompositeLayoutStage

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
appendStage()method
public function appendStage(stage:LayoutStage):void

Appends a stage to the layout pipeline. Stages added with this method will be invoked just before the core layouter of the composite layout stage will be invoked.

Parameters

stage:LayoutStage

canLayout()method 
override public function canLayout(graph:LayoutGraph):Boolean

Returns true.

Parameters

graph:LayoutGraph

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

Assigns a new graph layout to the given layout graph.

Parameters

graph:LayoutGraph

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

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

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

See also

newCompositeLayoutStage1()
initCompositeLayoutStage2()method 
protected final function initCompositeLayoutStage2(outerStage:LayoutStage, innerStage:LayoutStage):void

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

Parameters

outerStage:LayoutStage
 
innerStage:LayoutStage

See also

newCompositeLayoutStage2()
newCompositeLayoutStage1()method 
public static function newCompositeLayoutStage1():CompositeLayoutStage

Creates a new instance of CompositeLayoutStage

Returns
CompositeLayoutStage
newCompositeLayoutStage2()method 
public static function newCompositeLayoutStage2(outerStage:LayoutStage, innerStage:LayoutStage):CompositeLayoutStage

Creates a new instance of CompositeLayoutStage

Parameters

outerStage:LayoutStage
 
innerStage:LayoutStage

Returns
CompositeLayoutStage
prependStage()method 
public function prependStage(stage:LayoutStage):void

Prepends a stage to this composite layout stage. Stages added with this method will be invoked before any other stages will be invoked.

Parameters

stage:LayoutStage





Wed Oct 7 2015, 04:43 PM +02:00