Packagecom.yworks.yfiles.layout
Classpublic class SequentialLayouter
InheritanceSequentialLayouter Inheritance YObject Inheritance Object
Implements Layouter

This Layouter will take several com.yworks.yfiles.layout.Layouter implementations and will run these layout algorithms one after the other in the order in which they were added.

This class can for example be used to bundle several layout steps and handover a single layouter to a com.yworks.yfiles.layout.BufferedLayouter.

See also

com.yworks.yfiles.layout.Layouter
com.yworks.yfiles.layout.BufferedLayouter


Public Properties
 PropertyDefined By
  layouters : List
Getter: Returns a list of the layouters that are currently in the layout chain.
SequentialLayouter
Public Methods
 MethodDefined By
  
SequentialLayouter(init:Boolean = true)
SequentialLayouter
  
appendLayouter(layouter:Layouter):void
Appends the given layouter to the end of the layouter chain.
SequentialLayouter
  
appendLayouters(layouters:List):void
Appends the specified layouters to the end of the layouter chain.
SequentialLayouter
  
canLayout(graph:LayoutGraph):Boolean
SequentialLayouter
  
Clears the layouter chain and therefore removes all layouters.
SequentialLayouter
  
doLayout(graph:LayoutGraph):void
SequentialLayouter
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
SequentialLayouter
 Inherited
hashCode():int
YObject
  
[static]
SequentialLayouter
Protected Methods
 MethodDefined By
  
Initializes this object.
SequentialLayouter
Property Detail
layoutersproperty
layouters:List

Getter: Returns a list of the layouters that are currently in the layout chain.

Setter: Sets the given list of layouters as the layouter chain. Note: this will overwrite the current chain.


Implementation
    public function get layouters():List
    public function set layouters(value:List):void
Constructor Detail
SequentialLayouter()Constructor
public function SequentialLayouter(init:Boolean = true)

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
appendLayouter()method
public function appendLayouter(layouter:Layouter):void

Appends the given layouter to the end of the layouter chain.

Parameters

layouter:Layouter — the layouter that should be appended to the chain.

appendLayouters()method 
public function appendLayouters(layouters:List):void

Appends the specified layouters to the end of the layouter chain.

Parameters

layouters:List — the layouters that should be appended to the chain.

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

Parameters

graph:LayoutGraph

Returns
Boolean
clearLayouterChain()method 
public function clearLayouterChain():void

Clears the layouter chain and therefore removes all layouters.

doLayout()method 
public function doLayout(graph:LayoutGraph):void

Parameters

graph:LayoutGraph

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

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

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

See also

newSequentialLayouter()method 
public static function newSequentialLayouter():SequentialLayouter

Returns
SequentialLayouter