| Package | com.yworks.yfiles.layout.tree |
| Class | public class HVTreeLayouter |
| Inheritance | HVTreeLayouter  CanonicMultiStageLayouter YObject Object |
| Property | Defined By | ||
|---|---|---|---|
| comparator : Comparator
Specifies the java.util.Comparator that will be used to sort the outgoing edges (com.yworks.yfiles.base.Node.sortOutEdges()) of each local root in the tree before they are being arranged. | HVTreeLayouter | ||
 | componentLayouter : LayoutStage
Specifies the LayoutStage responsible for laying out the connected components of the graph. | CanonicMultiStageLayouter | |
| componentLayouterEnabled : Boolean
Getter:
Returns whether or not ComponentLayouter is enabled. | CanonicMultiStageLayouter | |
| groupNodeHider : LayoutStage
Specifies the LayoutStage that is responsible for hiding away grouping information for the layout algorithm. | CanonicMultiStageLayouter | |
| hideGroupNodes : Boolean
Specifies whether or not to hide away group nodes before the layout begins. | CanonicMultiStageLayouter | |
| horizontalSpace : Number
Specifies the horizontal distance between adjacent nodes. | HVTreeLayouter | ||
| labelLayouter : LayoutStage
Getter:
Returns the algorithm used for placing labels. | CanonicMultiStageLayouter | |
| labelLayouterEnabled : Boolean
Getter:
Returns whether or not LabelLayouter is enabled. | CanonicMultiStageLayouter | |
| layoutOrientation : int
Specifies the main layout orientation. | CanonicMultiStageLayouter | |
| orientationLayouter : LayoutStage
Specifies the LayoutStage that is responsible for changing the orientation of the computed layout. | CanonicMultiStageLayouter | |
| orientationLayouterEnabled : Boolean
Getter:
Returns whether or not the OrientationLayouter is enabled. | CanonicMultiStageLayouter | |
| parallelEdgeLayouter : LayoutStage
Getter:
Returns the LayoutStage responsible for routing parallel edges. | CanonicMultiStageLayouter | |
| parallelEdgeLayouterEnabled : Boolean
Getter:
Returns whether or not the ParallelEdgeLayouter is enabled. | CanonicMultiStageLayouter | |
| selfLoopLayouter : LayoutStage
Getter:
Returns the LayoutStage used for routing Self-loops. | CanonicMultiStageLayouter | |
| selfLoopLayouterEnabled : Boolean
Getter:
Returns whether or not the SelfLoopLayouter is enabled. | CanonicMultiStageLayouter | |
| subgraphLayouter : LayoutStage
Specifies the LayoutStage that is responsible for constraining the layout process to a subgraph of the target graph. | CanonicMultiStageLayouter | |
| subgraphLayouterEnabled : Boolean
Getter:
Returns whether or not the SubgraphLayouter is enabled. | CanonicMultiStageLayouter | |
| verticalSpace : Number
Specifies the vertical distance between adjacent nodes. | HVTreeLayouter | ||
| Property | Defined By | ||
|---|---|---|---|
| graph : LayoutGraph
The layout graph being acted upon. | HVTreeLayouter | ||
| Method | Defined By | ||
|---|---|---|---|
HVTreeLayouter(init:Boolean = true) | HVTreeLayouter | ||
| appendStage(stage:LayoutStage):void
Appends a stage to the layout pipeline. | CanonicMultiStageLayouter | |
|
Returns a layout for the given layout graph. | CanonicMultiStageLayouter | |
|
Returns a layout for the given graph interface and layout. | CanonicMultiStageLayouter | |
| canLayout(graph:LayoutGraph):Boolean
Tests whether or not the given graph can be laid out by this layouter. | CanonicMultiStageLayouter | |
canLayoutCore(graph:LayoutGraph):Boolean [override]
The core layouter can layout trees. | HVTreeLayouter | ||
| doLayout(layoutGraph:LayoutGraph):void
Calculates a layout for the given graph. | CanonicMultiStageLayouter | |
|
Calculates a layout for the given graph interface and layout. | CanonicMultiStageLayouter | |
doLayoutCore(graph:LayoutGraph):void [override]
Core layout routine. | HVTreeLayouter | ||
| enableOnlyCore():void
Disables all layout stages and performs only the core layouter. | CanonicMultiStageLayouter | |
| equals(o:Object):Boolean | YObject | |
getClass():Class [override] | HVTreeLayouter | ||
| hashCode():int | YObject | |
[static] | HVTreeLayouter | ||
| prependStage(stage:LayoutStage):void
Prepends a stage to the layout pipeline. | CanonicMultiStageLayouter | |
| removeStage(stage:LayoutStage):void
Removes a LayoutStage that has been previously added by the methods appendStage() or prependStage(). | CanonicMultiStageLayouter | |
| Method | Defined By | ||
|---|---|---|---|
| checkGroupNodeSize(layout:GraphLayout, node:Object):void
This method throws an com.yworks.bridge.util.IllegalArgumentException if the width/height of the given group node object is zero. | CanonicMultiStageLayouter | |
| checkNodeSize(layout:GraphLayout, node:Object):void
This method throws an com.yworks.bridge.util.IllegalArgumentException if the width/height of the given node object is zero. | CanonicMultiStageLayouter | |
| HVTreeLayouter | |||
| CanonicMultiStageLayouter | ||
initHVTreeLayouter():void
Initializes this object. | HVTreeLayouter | ||
isHorizontalRoot(v:Node):Boolean
Returns whether or not the subtree rooted at the given node should be laid out horizontally. | HVTreeLayouter | ||
isVerticalRoot(v:Node):Boolean
Returns whether or not the subtree rooted at the given node should be laid out vertically. | HVTreeLayouter | ||
| Constant | Defined By | ||
|---|---|---|---|
| HORIZONTAL_SUBTREE : Object = y.layout.tree.HVTreeLayouter.HORIZONTAL_SUBTREE [static]
Subtree orientation specifier. | HVTreeLayouter | ||
| SUBTREE_ORIENTATION : Object = y.layout.tree.HVTreeLayouter.SUBTREE_ORIENTATION [static]
The data provider key used to specify the subtree orientation of each node in the tree. | HVTreeLayouter | ||
| VERTICAL_SUBTREE : Object = y.layout.tree.HVTreeLayouter.VERTICAL_SUBTREE [static]
Subtree orientation specifier. | HVTreeLayouter | ||
| comparator | property |
Hide Inherited Public Properties
Show Inherited Public Propertiescomparator:Comparator
Specifies the java.util.Comparator that will be used to sort the outgoing edges (com.yworks.yfiles.base.Node.sortOutEdges()) of each local root in the tree before they are being arranged.
The default value is null which indicates that the algorithm should use its built-in logic.
public function get comparator():Comparator public function set comparator(value:Comparator):voidSee also
| graph | property |
protected var graph:LayoutGraphThe layout graph being acted upon.
| horizontalSpace | property |
horizontalSpace:Number
Specifies the horizontal distance between adjacent nodes.
By default a value of 10 is set.
public function get horizontalSpace():Number public function set horizontalSpace(value:Number):void| verticalSpace | property |
verticalSpace:Number
Specifies the vertical distance between adjacent nodes.
By default a value of 10 is set.
public function get verticalSpace():Number public function set verticalSpace(value:Number):void| HVTreeLayouter | () | Constructor |
public function HVTreeLayouter(init:Boolean = true)Parameters
init:Boolean (default = true) |
| canLayoutCore | () | method |
override public function canLayoutCore(graph:LayoutGraph):BooleanThe core layouter can layout trees.
Parameters
graph:LayoutGraph |
Boolean |
| doLayoutCore | () | method |
override public function doLayoutCore(graph:LayoutGraph):voidCore layout routine.
Parameters
graph:LayoutGraph |
| getClass | () | method |
override public function getClass():ClassReturnsClass |
| getSuccessors | () | method |
protected function getSuccessors(localParent:Node):NodeCursorParameters
localParent:Node |
NodeCursor |
| initHVTreeLayouter | () | method |
protected final function initHVTreeLayouter():void
Initializes this object. See the documentation of the corresponding factory method newHVTreeLayouter() for details.
See also
| isHorizontalRoot | () | method |
protected function isHorizontalRoot(v:Node):BooleanReturns whether or not the subtree rooted at the given node should be laid out horizontally.
Parameters
v:Node |
Boolean |
| isVerticalRoot | () | method |
protected function isVerticalRoot(v:Node):BooleanReturns whether or not the subtree rooted at the given node should be laid out vertically.
Parameters
v:Node |
Boolean |
| newHVTreeLayouter | () | method |
| HORIZONTAL_SUBTREE | Constant |
public static const HORIZONTAL_SUBTREE:Object = y.layout.tree.HVTreeLayouter.HORIZONTAL_SUBTREESubtree orientation specifier. This specifier indicated that the subtree rooted at the associated node should be laid out horizontally.
| SUBTREE_ORIENTATION | Constant |
public static const SUBTREE_ORIENTATION:Object = y.layout.tree.HVTreeLayouter.SUBTREE_ORIENTATIONThe data provider key used to specify the subtree orientation of each node in the tree. This layout algorithm will try to retrieve a data provider from the tree to be laid out with this key. The looked up data provider should provide either HORIZONTAL_SUBTREE, VERTICAL_SUBTREE
See also
| VERTICAL_SUBTREE | Constant |
public static const VERTICAL_SUBTREE:Object = y.layout.tree.HVTreeLayouter.VERTICAL_SUBTREESubtree orientation specifier. This specifier indicated that the subtree rooted at the associated node should be laid out vertically.