GroupingSupport (yFiles-for-JavaFX-Complete-3.0 API)

java.lang.Object
- com.yworks.yfiles.layout.hierarchic.GroupingSupport

```
public class GroupingSupport
extends Object
```
This class is responsible for managing hierarchically grouped graphs.
The grouping information is provided through IDataProviders registered with the graph with keys GroupingKeys.NODE_ID_DPKEY, GroupingKeys.PARENT_NODE_ID_DPKEY and GroupingKeys.GROUP_DPKEY.

See Also:

GroupingSupport, GroupingKeys

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GroupingSupport.IVisitor
Visitor interface that can be used to traverse the descendants of a group node.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GroupingSupport.IVisitor` Visitor interface that can be used to traverse the descendants of a group node.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`assignEdgeGroupNodesToGroups(ILayers layers)` Assigns edge group nodes to groups based on a given `ILayers` instance.
`void`	`assignLabelNodesToGroups(ILayers layers, IItemFactory itemFactory)` Assigns label nodes to groups.
`NodeList`	`getChildren(Node groupNode)` Returns the direct children of the given group node.
`NodeList`	`getDescendants(Node groupNode)` Returns the descendant `Node`s of the given group node.
`double`	`getMinimumGroupDistance()` Gets the minimum distance between group nodes.
`Node`	`getParentNode(Node node)` Returns the parent group node of the given `Node` or `null` if the given node is a top-level node.
`void`	`hideGroupNodes()` Hides the group nodes and incident edges from the graph.
`boolean`	`isActive()` Gets whether or not `GroupingSupport` is active.
`boolean`	`isDescendant(Node node, Node groupNode)` Returns whether or not the given node is a descendant `Node` of the given group node.
`boolean`	`isGroupNode(Node node)` Returns whether or not the given `Node` is a non-empty group node.
`void`	`removeEdgeGroupAssignment(ILayers layers)` Removes the current assignment of source/target edge groups from a given `ILayers` instance.
`void`	`setMinimumGroupDistance(double value)` Sets the minimum distance between group nodes.
`void`	`unhideGroupNodes()` Un-hides all previously hidden group nodes and incident edges.
`void`	`visitDescendants(Node groupNode, GroupingSupport.IVisitor visitor)` Visits all descendant `Node`s of the given group node.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - assignEdgeGroupNodesToGroups
```
public void assignEdgeGroupNodesToGroups(ILayers layers)
```
    Assigns edge group nodes to groups based on a given ILayers instance.
    
    This method will have an effect only if method Active returns true.
    
    Parameters:
    
    layers - the given ILayers instance containing the elements in the layering
    
    See Also:
    
    NodeDataType.SOURCE_GROUP_NODE, NodeDataType.TARGET_GROUP_NODE
  - assignLabelNodesToGroups
```
public void assignLabelNodesToGroups(ILayers layers,
                                     IItemFactory itemFactory)
```
    Assigns label nodes to groups.
    
    This method will have an effect only if method Active returns true.
    
    Parameters:
    
    layers - the given ILayers instance containing the elements in the layering
    
    itemFactory - the IItemFactory used temporarily for modifying the graph instance
    
    See Also:
    
    NodeDataType.LABEL, NodeDataType.BEND, NodeDataType.GROUP_BEGIN, NodeDataType.GROUP_END
  - getChildren
```
public NodeList getChildren(Node groupNode)
```
    Returns the direct children of the given group node.
    
    This method will return null if GroupingSupport is not active.
    
    Parameters:
    
    groupNode - the given group node
    
    Returns:
    
    a NodeList of all direct children or null if GroupingSupport is not active
  - getDescendants
```
public NodeList getDescendants(Node groupNode)
```
    Returns the descendant Nodes of the given group node.
    The descendants are all direct or indirect children of a group node.
    
    This method will return null if GroupingSupport is not active.
    
    Parameters:
    
    groupNode - the given group node
    
    Returns:
    
    a NodeList of all descendants or null if GroupingSupport is not active
  - getMinimumGroupDistance
```
public double getMinimumGroupDistance()
```
    Gets the minimum distance between group nodes.
    The minimum distance should be greater than 0.
    
    Throws:
    
    IllegalArgumentException - if the minimum distance is negative
    
    Default Value:
    The default value is 0.0d.
    
    Returns:
    
    the minimum distance between group nodes
    
    See Also:
    
    setMinimumGroupDistance(double)
  - getParentNode
```
public Node getParentNode(Node node)
```
    Returns the parent group node of the given Node or null if the given node is a top-level node.
    
    This method will return null if GroupingSupport is not active.
    
    Parameters:
    
    node - the given Node
    
    Returns:
    
    the parent group node or null if the given node is a top-level node or if GroupingSupport is not active
  - hideGroupNodes
```
public void hideGroupNodes()
```
    Hides the group nodes and incident edges from the graph.
  - isActive
```
public boolean isActive()
```
    Gets whether or not GroupingSupport is active.
    
    All return values of the methods of this class will be invalid if GroupingSupport is inactive.
    
    Returns:
    
    true if GroupingSupport is active, false otherwise
  - isDescendant
```
public boolean isDescendant(Node node,
                            Node groupNode)
```
    Returns whether or not the given node is a descendant Node of the given group node.
    The descendants are all direct or indirect children of a group node.
    
    Parameters:
    
    node - the given node
    
    groupNode - the given group node
    
    Returns:
    
    true if the given node is a descendant of the given group node, false otherwise
  - isGroupNode
```
public boolean isGroupNode(Node node)
```
    Returns whether or not the given Node is a non-empty group node.
    
    This method will return false if GroupingSupport is not active.
    
    Parameters:
    
    node - the given Node
    
    Returns:
    
    true if the given node is a non-empty group node, false otherwise
  - removeEdgeGroupAssignment
```
public void removeEdgeGroupAssignment(ILayers layers)
```
    Removes the current assignment of source/target edge groups from a given ILayers instance.
    
    This method will have an effect only if method Active returns true.
    
    Parameters:
    
    layers - the given ILayers instance containing the elements in the layering
    
    See Also:
    
    NodeDataType.SOURCE_GROUP_NODE, NodeDataType.TARGET_GROUP_NODE
  - setMinimumGroupDistance
```
public void setMinimumGroupDistance(double value)
```
    Sets the minimum distance between group nodes.
    The minimum distance should be greater than 0.
    
    Throws:
    
    IllegalArgumentException - if the minimum distance is negative
    
    Default Value:
    The default value is 0.0d.
    
    Parameters:
    
    value - the minimum distance between group nodes
    
    See Also:
    
    getMinimumGroupDistance()
  - unhideGroupNodes
```
public void unhideGroupNodes()
```
    Un-hides all previously hidden group nodes and incident edges.
  - visitDescendants
```
public void visitDescendants(Node groupNode,
                             GroupingSupport.IVisitor visitor)
```
    Visits all descendant Nodes of the given group node.
    The descendants are all direct or indirect children of a group node.
    
    This method will have an effect only if method Active returns true.
    
    Parameters:
    
    groupNode - the given group node
    
    visitor - a GroupingSupport.IVisitor implementation

Class GroupingSupport

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

assignEdgeGroupNodesToGroups

assignLabelNodesToGroups

getChildren

getDescendants

getMinimumGroupDistance

getParentNode

hideGroupNodes

isActive

isDescendant

isGroupNode

removeEdgeGroupAssignment

setMinimumGroupDistance

unhideGroupNodes

visitDescendants