| Package | com.yworks.yfiles.layout.tree |
| Class | public class TreeComponentLayouter |
| Inheritance | TreeComponentLayouter  YObject Object |
| Implements | LayoutStage |
| Property | Defined By | ||
|---|---|---|---|
| coreLayouter : Layouter
Specifies the core layouter. | TreeComponentLayouter | ||
| orientationOptimizationActive : Boolean
Getter:
Returns true if this layouter tries to improve tree component placement by changing the components orientation and false otherwise. | TreeComponentLayouter | ||
| treeComponentCoreLayouter : Layouter
Specifies the core layouter used for tree components. | TreeComponentLayouter | ||
| Method | Defined By | ||
|---|---|---|---|
TreeComponentLayouter(treeCoreLayouter:Layouter, init:Boolean = true)
Creates a new instance of TreeComponentLayouter using the specified layouter for laying out the subtrees. | TreeComponentLayouter | ||
canLayout(graph:LayoutGraph):Boolean
Returns true iff the given graph can be laid out by this algorithm. | TreeComponentLayouter | ||
doLayout(graph:LayoutGraph):void
Assigns a new graph layout to the given layout graph. | TreeComponentLayouter | ||
 | equals(o:Object):Boolean | YObject | |
getClass():Class [override] | TreeComponentLayouter | ||
| hashCode():int | YObject | |
[static]
Creates a new instance of TreeComponentLayouter using the specified layouter for laying out the subtrees. | TreeComponentLayouter | ||
| Method | Defined By | ||
|---|---|---|---|
Called by doLayout() to delegate to the coreLayouter, adding the dummy provider to the graph instance. | TreeComponentLayouter | ||
initTreeComponentLayouter(treeCoreLayouter:Layouter):void
Initializes this object. | TreeComponentLayouter | ||
| Constant | Defined By | ||
|---|---|---|---|
| DUMMY_NODE_DPKEY : Object = y.layout.tree.TreeComponentLayouter.DUMMY_NODE_DPKEY [static]
During the main run of the layout dummy nodes can be identified by looking at the value of the registered DataProvider which can be obtained from the graph using this key. | TreeComponentLayouter | ||
| coreLayouter | property |
Hide Inherited Public Methods
Show Inherited Public MethodscoreLayouter:LayouterSpecifies the core layouter.
public function get coreLayouter():Layouter public function set coreLayouter(value:Layouter):void| orientationOptimizationActive | property |
orientationOptimizationActive:Boolean
Getter:
Returns true if this layouter tries to improve tree component placement by changing the components orientation and false otherwise.
public function get orientationOptimizationActive():Boolean public function set orientationOptimizationActive(value:Boolean):void| treeComponentCoreLayouter | property |
treeComponentCoreLayouter:LayouterSpecifies the core layouter used for tree components.
public function get treeComponentCoreLayouter():Layouter public function set treeComponentCoreLayouter(value:Layouter):void| TreeComponentLayouter | () | Constructor |
public function TreeComponentLayouter(treeCoreLayouter:Layouter, init:Boolean = true)Creates a new instance of TreeComponentLayouter using the specified layouter for laying out the subtrees.
ParameterstreeCoreLayouter:Layouter | |
init:Boolean (default = true) |
| canLayout | () | method |
public function canLayout(graph:LayoutGraph):Boolean
Returns true iff the given graph can be laid out by this algorithm.
Calling doLayout with the given graph as its argument will only success if this method returns true.
Parameters
graph:LayoutGraph |
Boolean |
| doLayout | () | method |
public function doLayout(graph:LayoutGraph):voidAssigns a new graph layout to the given layout graph.
Parameters
graph:LayoutGraph |
| doLayoutUsingDummies | () | method |
protected function doLayoutUsingDummies(graph:LayoutGraph, dummyDp:DataProvider):voidCalled by doLayout() to delegate to the coreLayouter, adding the dummy provider to the graph instance.
Parameters
graph:LayoutGraph | |
dummyDp:DataProvider |
See also
| getClass | () | method |
override public function getClass():ClassReturnsClass |
| initTreeComponentLayouter | () | method |
protected final function initTreeComponentLayouter(treeCoreLayouter:Layouter):void
Initializes this object. See the documentation of the corresponding factory method newTreeComponentLayouter() for details.
Parameters
treeCoreLayouter:Layouter |
See also
| newTreeComponentLayouter | () | method |
public static function newTreeComponentLayouter(treeCoreLayouter:Layouter):TreeComponentLayouterCreates a new instance of TreeComponentLayouter using the specified layouter for laying out the subtrees.
Parameters
treeCoreLayouter:Layouter |
TreeComponentLayouter |
| DUMMY_NODE_DPKEY | Constant |
public static const DUMMY_NODE_DPKEY:Object = y.layout.tree.TreeComponentLayouter.DUMMY_NODE_DPKEYDuring the main run of the layout dummy nodes can be identified by looking at the value of the registered DataProvider which can be obtained from the graph using this key.