com.yworks.yfiles.graph

Class GroupingSupport

java.lang.Object

com.yworks.yfiles.graph.GroupingSupport

public class GroupingSupport
extends Object

Contains less frequently used methods for analyzing and managing grouped graphs.

An instance of this class which is configured for a given IGraph instance can be obtained via IGraph.getGroupingSupport().

Constructor Summary

Constructors

Constructor and Description
GroupingSupport(IGraph graph) Creates a new instance which operates on the given graph.

Method Summary

Modifier and Type	Method and Description
RectD	calculateMinimumEnclosedArea(INode groupNode) Calculates the minimum area to enclose by the given group node with respect to its IGroupBoundsCalculator.
void	enlargeAllGroupNodes() Enlarges all group nodes in the graph so that the minimum enclosed area is respected.
void	enlargeAllGroupNodes(IInputModeContext context) Enlarges all group nodes in the graph in an interactive scenario, so that the minimum enclosed area is respected.
void	enlargeGroupNode(IInputModeContext context, INode node, boolean ancestors) Enlarges the group nodes in an interactive scenario, using IReshapeHandler implementations of the group nodes to perform the actual resizing.
void	enlargeGroupNode(INode groupNode, boolean ancestors) Enlarges the given group node to ensure that the minimum enclosed area is inside of its bounds.
IEnumerable<INode>	getDescendants(INode node) Returns all descendants of the provided node that are part of the grouped graph.
IEnumerable<INode>	getDescendantsBottomUp(INode node) Returns all descendants of the provided node that are part of the grouped graph.
INode	getNearestCommonAncestor(INode... nodes) Determines the nearest common ancestor of the provided nodes in the graph.
INode	getNearestCommonAncestor(Iterable<INode> nodes) Determines the nearest common ancestor of the provided nodes in the graph.
List<INode>	getPathToRoot(INode node) Gets the path to root traversing all parents of the given item.
boolean	hasGroupNodes() Whether there are group nodes in the graph.
boolean	isDescendant(INode node, INode ancestor) Determines whether ancestor is an ancestor of node in the grouped graph.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GroupingSupport

public GroupingSupport(IGraph graph)

Creates a new instance which operates on the given graph.

Parameters:

graph - The graph to operate on.

Method Detail

calculateMinimumEnclosedArea

public final RectD calculateMinimumEnclosedArea(INode groupNode)

Calculates the minimum area to enclose by the given group node with respect to its IGroupBoundsCalculator.

Parameters:

groupNode - The group node to calculate the minimum enclosed area of.

Returns:

The area to enclose for the given group node. This is RectD.EMPTY if the node is not a group node, or if it hasn't any children.

enlargeAllGroupNodes

public final void enlargeAllGroupNodes()

Enlarges all group nodes in the graph so that the minimum enclosed area is respected.

See Also:

enlargeGroupNode(INode, boolean)

enlargeAllGroupNodes

public final void enlargeAllGroupNodes(IInputModeContext context)

Enlarges all group nodes in the graph in an interactive scenario, so that the minimum enclosed area is respected.

This method should be used in an interactive editing scenario. It records an ICompoundEdit to support undoability and uses the IReshapeHandler for the resizing of the nodes. That way, e.g. orthogonally edited edges will be properly reshaped.

Parameters:

context - The context to use for the IReshapeHandlers.

See Also:

enlargeGroupNode(IInputModeContext, INode, boolean)

enlargeGroupNode

public final void enlargeGroupNode(IInputModeContext context,
                                   INode node,
                                   boolean ancestors)

Enlarges the group nodes in an interactive scenario, using IReshapeHandler implementations of the group nodes to perform the actual resizing.

This method should be used in an interactive editing scenario. It records an ICompoundEdit to support undoability and uses the IReshapeHandler for the resizing of the nodes. That way, e.g. orthogonally edited edges will be properly reshaped.

Parameters:

context - The context to use for the IReshapeHandlers.

node - The node to enlarge appropriately.

ancestors - if set to true ancestors the ancestor group nodes will be adjusted, too, if necessary.

See Also:

IReshapeHandler

enlargeGroupNode

public final void enlargeGroupNode(INode groupNode,
                                   boolean ancestors)

Enlarges the given group node to ensure that the minimum enclosed area is inside of its bounds.

This method can be used to resize a group node and all of its parent group nodes to fully contain its children, e.g. after a child node has changed its bounds. Note that this method will only enlarge the bounds of the group nodes, it will never reduce the size of a group node.

Parameters:

groupNode - The group node to resize.

ancestors - if set to true all ancestor group nodes will be resized, too, if necessary

See Also:

enlargeGroupNode(IInputModeContext, INode, boolean)

getDescendants

public final IEnumerable<INode> getDescendants(INode node)

Returns all descendants of the provided node that are part of the grouped graph.

The enumeration will be top down, i.e. all of a node's ancestors will be enumerated before the respective node.

Parameters:

node - The root node to get the descendants from.

Returns:

An enumeration of the children of the node at the time of this invocation in reverse DFS prefix order.

getDescendantsBottomUp

public final IEnumerable<INode> getDescendantsBottomUp(INode node)

Returns all descendants of the provided node that are part of the grouped graph.

The enumeration will be bottom up, i.e. all of a node's children will be enumerated before the respective node.

Parameters:

node - The root node to get the descendants from.

Returns:

An enumeration of the children of the node at the time of this invocation in DFS postfix order.

getNearestCommonAncestor

public final INode getNearestCommonAncestor(INode... nodes)

Determines the nearest common ancestor of the provided nodes in the graph.

Parameters:

nodes - The nodes to find the nearest common ancestor of.

getNearestCommonAncestor

public final INode getNearestCommonAncestor(Iterable<INode> nodes)

Determines the nearest common ancestor of the provided nodes in the graph.

Parameters:

nodes - The nodes to find the nearest common ancestor of.

getPathToRoot

public final List<INode> getPathToRoot(INode node)

Gets the path to root traversing all parents of the given item.

Parameters:

node - The node to start.

Returns:

A list that includes the node but not the root, unless they are identical and all parents in between them.

hasGroupNodes

public final boolean hasGroupNodes()

Whether there are group nodes in the graph.

This methods considers all group nodes with children as group nodes.

Returns:

true if there are group nodes with children.

isDescendant

public final boolean isDescendant(INode node,
                                  INode ancestor)

Determines whether ancestor is an ancestor of node in the grouped graph.

Parameters:

node - The node to check.

ancestor - The ancestor to check.

Returns:

Whether ancestor is an ancestor of node.