Packagecom.yworks.yfiles.layout.hierarchic.incremental
Classpublic class GroupingSupport
InheritanceGroupingSupport Inheritance YObject Inheritance Object

Helper class that is used to manage hierarchically grouped graphs.



Public Properties
 PropertyDefined By
  active : Boolean
[read-only] Returns whether or not groupingSupport is active.
GroupingSupport
  minimumGroupDistance : Number
GroupingSupport
Public Methods
 MethodDefined By
  
GroupingSupport(init:Boolean = true)
GroupingSupport
  
GroupingSupport
  
assignLabelNodesToGroups(layers:Layers, itemFactory:ItemFactory):void
GroupingSupport
 Inherited
equals(o:Object):Boolean
YObject
  
Returns the direct children of the given group node.
GroupingSupport
  
getClass():Class
[override]
GroupingSupport
  
Returns all direct and indirect children of the given group node.
GroupingSupport
  
Returns the parent group node of the given node, or null if the given node is a top-level node.
GroupingSupport
 Inherited
hashCode():int
YObject
  
Hides the group nodes and adjacent edges from the graph.
GroupingSupport
  
isDescendant(node:Node, groupNode:Node):Boolean
Returns whether or not the given node is a direct or indirect child of the given group node.
GroupingSupport
  
isGroupNode(node:Node):Boolean
Returns whether or not the given node is a non-empty group node.
GroupingSupport
  
GroupingSupport
  
Unhides all previously hidden group nodes and adjacent edges
GroupingSupport
  
Visits all descendants of the given group node.
GroupingSupport
Property Detail
activeproperty
active:Boolean  [read-only]

Returns whether or not groupingSupport is active. All return values of the methods of this class will be invalid if groupingSupport is inactive.


Implementation
    public function get active():Boolean
minimumGroupDistanceproperty 
minimumGroupDistance:Number


Implementation
    public function get minimumGroupDistance():Number
    public function set minimumGroupDistance(value:Number):void
Constructor Detail
GroupingSupport()Constructor
public function GroupingSupport(init:Boolean = true)



Parameters
init:Boolean (default = true)
Method Detail
assignEdgeGroupNodesToGroups()method
public function assignEdgeGroupNodesToGroups(layers:Layers):void

Parameters

layers:Layers

assignLabelNodesToGroups()method 
public function assignLabelNodesToGroups(layers:Layers, itemFactory:ItemFactory):void

Parameters

layers:Layers
 
itemFactory:ItemFactory

getChildren()method 
public function getChildren(groupNode:Node):NodeList

Returns the direct children of the given group node.

Parameters

groupNode:Node

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

Returns
Class
getDecendants()method 
public function getDecendants(groupNode:Node):NodeList

Returns all direct and indirect children of the given group node.

Parameters

groupNode:Node

Returns
NodeList
getParentNode()method 
public function getParentNode(node:Node):Node

Returns the parent group node of the given node, or null if the given node is a top-level node.

Parameters

node:Node

Returns
Node
hideGroupNodes()method 
public function hideGroupNodes():void

Hides the group nodes and adjacent edges from the graph.

isDescendant()method 
public function isDescendant(node:Node, groupNode:Node):Boolean

Returns whether or not the given node is a direct or indirect child of the given group node.

Parameters

node:Node
 
groupNode:Node

Returns
Boolean
isGroupNode()method 
public function isGroupNode(node:Node):Boolean

Returns whether or not the given node is a non-empty group node.

Parameters

node:Node

Returns
Boolean
removeEdgeGroupAssignment()method 
public function removeEdgeGroupAssignment(layers:Layers):void

Parameters

layers:Layers

unhideGroupNodes()method 
public function unhideGroupNodes():void

Unhides all previously hidden group nodes and adjacent edges

visitDecendants()method 
public function visitDecendants(groupNode:Node, visitor:GroupingSupport_Visitor):void

Visits all descendants of the given group node.

Parameters

groupNode:Node
 
visitor:GroupingSupport_Visitor