com.yworks.yfiles.layout.hierarchic.HierarchicGroupLayouter

Public Properties

	Property		Defined By
		bendReductionThreshold : int Specifies the limit, when bends are removed and a straight line is drawn instead.	HierarchicLayouter
		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
		drawer : Drawer [override] Specifies the drawer which is responsible for the third phase of the algorithm.	HierarchicGroupLayouter
		globalSequencingActive : Boolean Getter: Returns the current strategy for the node sequencing.	HierarchicGroupLayouter
		groupBoundsCalculator : GroupBoundsCalculator Getter: Gets the current GroupBoundsCalculator instance.	HierarchicGroupLayouter
		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
		labelLayouter : LayoutStage Getter: Returns the algorithm used for placing labels.	CanonicMultiStageLayouter
		labelLayouterEnabled : Boolean Getter: Returns whether or not LabelLayouter is enabled.	CanonicMultiStageLayouter
		layerer : OldLayerer [override]	HierarchicGroupLayouter
		layeringStrategy : int [override]	HierarchicGroupLayouter
		layerSequencer : LayerSequencer [override]	HierarchicGroupLayouter
		layoutOrientation : int Specifies the main layout orientation.	CanonicMultiStageLayouter
		layoutStyle : int [override]	HierarchicGroupLayouter
		maximalDuration : uint Specifies a time limit for the algorithm in milliseconds	HierarchicLayouter
		mementoSupport : MementoSupport [read-only] Gets the cookie for the memento support of the hierarchic layout algorithm.	HierarchicLayouter
		minimalEdgeDistance : Number Specifies the minimal distance between edges that run in parallel.	HierarchicLayouter
		minimalFirstSegmentLength : Number Specifies the minimal length of first and last edge segments for edge routing.	HierarchicLayouter
		minimalLayerDistance : Number Specifies the minimal distance between two layers.	HierarchicLayouter
		minimalNodeDistance : Number Specifies the minimal distance between two nodes in the same layer.	HierarchicLayouter
		optimizePortConstraints : Boolean Specifies whether the algorithm should try to optimize PortConstraints, that are either com.yworks.yfiles.layout.PortConstraint.ANY_SIDE or null.	HierarchicLayouter
		optimizeSameLayerEdgeRouting : Boolean Getter: Returns whether the algorithm tries to optimize the routing of same layer edges whose PortConstraints don't impose the routing.	HierarchicLayouter
		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
		removeFalseCrossings : Boolean Specifies whether or not false crossings should be removed from the layout.	HierarchicLayouter
		routingStyle : int Getter: Returns the routing style being used.	HierarchicLayouter
		selfLoopLayouter : LayoutStage Getter: Returns the LayoutStage used for routing Self-loops.	CanonicMultiStageLayouter
		selfLoopLayouterEnabled : Boolean Getter: Returns whether or not the SelfLoopLayouter is enabled.	CanonicMultiStageLayouter
		strongPortsScalingActive : Boolean Specifies the property strongPortsScalingActive.	HierarchicGroupLayouter
		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

	Property	Defined By
		grouping : GraphGrouping [read-only] Returns the associated Grouping instance.	HierarchicGroupLayouter

	Method	Defined By
		HierarchicGroupLayouter(init:Boolean = true) Creates a new instance of HierarchicGroupLayouter	HierarchicGroupLayouter
		appendStage(stage:LayoutStage):void Appends a stage to the layout pipeline.	CanonicMultiStageLayouter
		calcLayout(layoutGraph:LayoutGraph):GraphLayout Returns a layout for the given layout graph.	CanonicMultiStageLayouter
		calcLayout2(graph:GraphInterface, layout:GraphLayout):GraphLayout 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] Returns true..	HierarchicGroupLayouter
		disposeMementoSupport():void Disposes the memento support if it is existent, i.e.	HierarchicLayouter
		doLayout(graph:LayoutGraph):void [override]	HierarchicGroupLayouter
		doLayout2(graph:GraphInterface, layout:GraphLayout):void Calculates a layout for the given graph interface and layout.	CanonicMultiStageLayouter
		doLayoutCore(g:LayoutGraph):void [override] Layouts the given graph.	HierarchicGroupLayouter
		enableOnlyCore():void Disables all layout stages and performs only the core layouter.	CanonicMultiStageLayouter
		equals(o:Object):Boolean	YObject
		getClass():Class [override]	HierarchicGroupLayouter
		hashCode():int	YObject
		newHierarchicGroupLayouter():HierarchicGroupLayouter [static] Creates a new instance of HierarchicGroupLayouter	HierarchicGroupLayouter
		newHierarchicLayouter():HierarchicLayouter [static] Instantiates a new HierarchicLayouter.	HierarchicLayouter
		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
		getLayerSequence(g:LayoutGraph, LAYER_KEY:NodeMap, maxLayer:int):Vector.<Object> [override]	HierarchicGroupLayouter
		initCanonicMultiStageLayouter():void	CanonicMultiStageLayouter
		initHierarchicGroupLayouter():void Initializes this object.	HierarchicGroupLayouter
		initHierarchicLayouter():void Initializes this object.	HierarchicLayouter
		layoutLevel(root:Node, levelNodes:NodeList, buildGraphsOnly:Boolean):Rectangle2D Layouts the children of root recursively.	HierarchicGroupLayouter

	Constant	Defined By
		LAYERING_BFS : int = 4 [static] Layering strategy specifier.	HierarchicLayouter
		LAYERING_FROM_SKETCH : int = 5 [static] Layering strategy specifier.	HierarchicLayouter
		LAYERING_HIERARCHICAL_DOWNSHIFT : int = 3 [static] Layering strategy specifier.	HierarchicLayouter
		LAYERING_HIERARCHICAL_OPTIMAL : int = 1 [static] Layering strategy specifier.	HierarchicLayouter
		LAYERING_HIERARCHICAL_TIGHT_TREE : int = 2 [static] Layering strategy specifier.	HierarchicLayouter
		LAYERING_HIERARCHICAL_TOPMOST : int = 0 [static] Layering strategy specifier.	HierarchicLayouter
		LAYERING_STRATEGY_UNKNOWN : int = -1 [static] Dummy layering strategy specifier.	HierarchicLayouter
		LAYERING_USER_DEFINED : int = 6 [static] Layering strategy specifier.	HierarchicLayouter
		LINEAR_SEGMENTS : int = 1 [static] Layout style specifier.	HierarchicLayouter
		MEDIAN_SIMPLEX : int = 5 [static] Layout style specifier.	HierarchicLayouter
		PENDULUM : int = 0 [static] Layout style specifier.	HierarchicLayouter
		POLYLINE : int = 2 [static] Layout style specifier.	HierarchicLayouter
		ROUTE_ORTHOGONAL : int = 1 [static] Edge routing style specifier.	HierarchicLayouter
		ROUTE_POLYLINE : int = 0 [static] Edge routing style specifier.	HierarchicLayouter
		SIMPLEX : int = 4 [static] Layout style specifier.	HierarchicLayouter
		TREE : int = 3 [static] Layout style specifier.	HierarchicLayouter

Property Detail

drawer

property

drawer:Drawer[override]

Specifies the drawer which is responsible for the third phase of the algorithm. A drawer is responsible for the layout style of this layouter.

Implementation
public function get drawer():Drawer
public function set drawer(value:Drawer):void

globalSequencingActive

property

globalSequencingActive:Boolean

Getter: Returns the current strategy for the node sequencing.

Setter: Determines whether a global sequencing heuristic should be used.

Implementation
public function get globalSequencingActive():Boolean
public function set globalSequencingActive(value:Boolean):void

groupBoundsCalculator

property

groupBoundsCalculator:GroupBoundsCalculator

Getter: Gets the current GroupBoundsCalculator instance.

Setter: Sets the GroupBoundsCalculator instance. By specifying an instance of the GroupBoundsCalculator interface one can control the sizes of the group nodes. For every group of nodes which is in it's open state the instance will be asked to calculate the bounds for the given child nodes. The resulting size will be used during the ongoing layout.

Implementation
public function get groupBoundsCalculator():GroupBoundsCalculator
public function set groupBoundsCalculator(value:GroupBoundsCalculator):void

grouping

property

grouping:GraphGrouping [read-only]

Returns the associated Grouping instance.

Implementation
protected function get grouping():GraphGrouping

layerer

property

layerer:OldLayerer[override]

Implementation
public function get layerer():OldLayerer
public function set layerer(value:OldLayerer):void

layeringStrategy

property

layeringStrategy:int[override]

Implementation
public function get layeringStrategy():int
public function set layeringStrategy(value:int):void

layerSequencer

property

layerSequencer:LayerSequencer[override]

Implementation
public function get layerSequencer():LayerSequencer
public function set layerSequencer(value:LayerSequencer):void

layoutStyle

property

layoutStyle:int[override]

Implementation
public function get layoutStyle():int
public function set layoutStyle(value:int):void

strongPortsScalingActive

property

strongPortsScalingActive:Boolean

Specifies the property strongPortsScalingActive. This property determines whether strong port constraints at group nodes should be interpreted as coordinates, that should be scaled to the same amount as the sizes of the group nodes vary. The default value is true.

Implementation
public function get strongPortsScalingActive():Boolean
public function set strongPortsScalingActive(value:Boolean):void

Constructor Detail

HierarchicGroupLayouter

()

Constructor

public function HierarchicGroupLayouter(init:Boolean = true)

Creates a new instance of HierarchicGroupLayouter

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

canLayoutCore

()

method

override public function canLayoutCore(graph:LayoutGraph):Boolean

Returns true..

Parameters

graph:LayoutGraph

Returns

Boolean

doLayout

()

method

override public function doLayout(graph:LayoutGraph):void

Parameters

graph:LayoutGraph

doLayoutCore

()

method

override public function doLayoutCore(g:LayoutGraph):void

Layouts the given graph.

Parameters

g:LayoutGraph

getClass

()

method

override public function getClass():Class

Returns

Class

getLayerSequence

()

method

override protected function getLayerSequence(g:LayoutGraph, LAYER_KEY:NodeMap, maxLayer:int):Vector.<Object>

Parameters

	`g:LayoutGraph`

	`LAYER_KEY:NodeMap`

	`maxLayer:int`

Returns

Vector.<Object>

initHierarchicGroupLayouter

()

method

protected final function initHierarchicGroupLayouter():void

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

yFiles FLEX Client Layout Extension 1.5 API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
HierarchicGroupLayouter	Properties \| Methods \| Constants

Package	com.yworks.yfiles.layout.hierarchic
Class	public class HierarchicGroupLayouter
Inheritance	HierarchicGroupLayouter HierarchicLayouter CanonicMultiStageLayouter YObject Object

	`root:Node` — The current root node (parent, invisible during layout)

	`levelNodes:NodeList` — The nodes to be laid out

	`buildGraphsOnly:Boolean`