| Package | com.yworks.yfiles.layout |
| Class | public class CompositeLayouter |
| Inheritance | CompositeLayouter  YObject Object |
| Implements | Layouter |
| Property | Defined By | ||
|---|---|---|---|
| layoutStages : List [read-only]
Returns the chain of layout stages that make up this composite layout stage. | CompositeLayouter | ||
| Method | Defined By | ||
|---|---|---|---|
Creates a new instance of CompositeLayouter with the specified LayoutStage prepended to the specified Layouter. | CompositeLayouter | ||
appendStage(stage:LayoutStage):void
Appends a stage to the layout pipeline. | CompositeLayouter | ||
canLayout(graph:LayoutGraph):Boolean
Returns true if all layout stages and the core layout stage can layout the given graph. | CompositeLayouter | ||
doLayout(graph:LayoutGraph):void
Assigns a new graph layout to the given layout graph. | CompositeLayouter | ||
 | equals(o:Object):Boolean | YObject | |
getClass():Class [override] | CompositeLayouter | ||
| hashCode():int | YObject | |
[static]
Creates a new instance of CompositeLayouter with the specified LayoutStage prepended to the specified Layouter. | CompositeLayouter | ||
prependStage(stage:LayoutStage):void
Prepends a stage to this composite layout stage. | CompositeLayouter | ||
| Method | Defined By | ||
|---|---|---|---|
Initializes this object. | CompositeLayouter | ||
| layoutStages | property |
Hide Inherited Public Methods
Show Inherited Public MethodslayoutStages:List [read-only] Returns the chain of layout stages that make up this composite layout stage.
public function get layoutStages():List| CompositeLayouter | () | Constructor |
public function CompositeLayouter(stage:LayoutStage, coreLayouter:Layouter, init:Boolean = true)
Creates a new instance of CompositeLayouter with the specified LayoutStage prepended to the specified Layouter.
stage:LayoutStage — a LayoutStage that is prepended to the specified core layouter.
| |
coreLayouter:Layouter — a Layouter that is used as core (i.e. innermost) layouter for this CompositeLayouter.
| |
init:Boolean (default = true) |
| appendStage | () | method |
public function appendStage(stage:LayoutStage):voidAppends 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 |
public function canLayout(graph:LayoutGraph):BooleanReturns true if all layout stages and the core layout stage can layout the given graph.
Parameters
graph:LayoutGraph |
Boolean |
| doLayout | () | method |
public function doLayout(graph:LayoutGraph):voidAssigns a new graph layout to the given layout graph.
Parameters
graph:LayoutGraph |
| getClass | () | method |
override public function getClass():ClassReturnsClass |
| initCompositeLayouter | () | method |
protected final function initCompositeLayouter(stage:LayoutStage, coreLayouter:Layouter):void
Initializes this object. See the documentation of the corresponding factory method newCompositeLayouter() for details.
Parameters
stage:LayoutStage | |
coreLayouter:Layouter |
See also
| newCompositeLayouter | () | method |
public static function newCompositeLayouter(stage:LayoutStage, coreLayouter:Layouter):CompositeLayouter
Creates a new instance of CompositeLayouter with the specified LayoutStage prepended to the specified Layouter.
Parameters
stage:LayoutStage — a LayoutStage that is prepended to the specified core layouter.
| |
coreLayouter:Layouter — a Layouter that is used as core (i.e. innermost) layouter for this CompositeLayouter.
|
CompositeLayouter |
| prependStage | () | method |
public function prependStage(stage:LayoutStage):voidPrepends a stage to this composite layout stage. Stage added with this method will be invoked before any other stages will be invoked.
Parameters
stage:LayoutStage |