com.yworks.yfiles.layout

Class InsetsGroupBoundsCalculator

java.lang.Object

com.yworks.yfiles.layout.InsetsGroupBoundsCalculator

All Implemented Interfaces:

IGroupBoundsCalculator

Direct Known Subclasses:

MinimumSizeGroupBoundsCalculator

public class InsetsGroupBoundsCalculator
extends Object
implements IGroupBoundsCalculator

This IGroupBoundsCalculator calculates the bounds of group nodes and allows to specify custom insets for each group node.

Insets are provided by a IDataProvider that must have been registered with the graph using the specified insets key prior to the invocation of the layout algorithm.

Constructor Summary

Constructors

Constructor and Description
InsetsGroupBoundsCalculator() Constructs an instance of InsetsGroupBoundsCalculator using the given IDataProvider key as group node insets key and the given insets as default insets.
InsetsGroupBoundsCalculator(Object insetsDataProviderKey) Constructs an instance of InsetsGroupBoundsCalculator using the given IDataProvider key as group node insets key and the given insets as default insets.
InsetsGroupBoundsCalculator(Object insetsDataProviderKey, YInsets defaultInsets) Constructs an instance of InsetsGroupBoundsCalculator using the given IDataProvider key as group node insets key and the given insets as default insets.

Method Summary

Modifier and Type	Method and Description
Rectangle2D	calculateBounds(LayoutGraph graph, Node groupNode, NodeList children) Calculates the bounds of the given group node and enlarges the bounds by the insets associated with the group node.
protected Rectangle2D	createEnlargedBounds(LayoutGraph graph, Node groupNode, NodeList children, Rectangle2D bounds) Enlarges the given graph bounds by the insets associated with the given group node.
YInsets	getDefaultInsets() Gets the default insets that will be used if the IDataProvider registered with the insets key does not contain a mapping for a specific node.
Object	getGroupNodeInsetsDpKey() Gets the key to register a IDataProvider that is used to access the insets for the group nodes.
boolean	isEdgeLabelConsiderationEnabled() Gets whether or not the labels of edges contained in a group are considered while calculating the bounds of the group node.
boolean	isNodeHalosConsiderationEnabled() Gets whether or not the calculation of the bounds of a group node considers the NodeHalos associated with the group's child nodes.
boolean	isNodeLabelConsiderationEnabled() Gets whether or not the labels of nodes contained in a group are considered while calculating the bounds of the group node.
void	setDefaultInsets(YInsets value) Sets the default insets that will be used if the IDataProvider registered with the insets key does not contain a mapping for a specific node.
void	setEdgeLabelConsiderationEnabled(boolean value) Sets whether or not the labels of edges contained in a group are considered while calculating the bounds of the group node.
void	setGroupNodeInsetsDpKey(Object value) Sets the key to register a IDataProvider that is used to access the insets for the group nodes.
void	setNodeHalosConsiderationEnabled(boolean value) Sets whether or not the calculation of the bounds of a group node considers the NodeHalos associated with the group's child nodes.
void	setNodeLabelConsiderationEnabled(boolean value) Sets whether or not the labels of nodes contained in a group are considered while calculating the bounds of the group node.

Methods inherited from class java.lang.Object

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

Constructor Detail

InsetsGroupBoundsCalculator

public InsetsGroupBoundsCalculator()

Constructs an instance of InsetsGroupBoundsCalculator using the given IDataProvider key as group node insets key and the given insets as default insets.

InsetsGroupBoundsCalculator

public InsetsGroupBoundsCalculator(Object insetsDataProviderKey)

Constructs an instance of InsetsGroupBoundsCalculator using the given IDataProvider key as group node insets key and the given insets as default insets.

Parameters:

insetsDataProviderKey - the IDataProvider key to use as insets key

InsetsGroupBoundsCalculator

public InsetsGroupBoundsCalculator(Object insetsDataProviderKey,
                                   YInsets defaultInsets)

Constructs an instance of InsetsGroupBoundsCalculator using the given IDataProvider key as group node insets key and the given insets as default insets.

Parameters:

insetsDataProviderKey - the IDataProvider key to use as insets key

defaultInsets - the insets to use as default insets

Method Detail

calculateBounds

public Rectangle2D calculateBounds(LayoutGraph graph,
                                   Node groupNode,
                                   NodeList children)

Calculates the bounds of the given group node and enlarges the bounds by the insets associated with the group node.

The insets associated with the group node will be retrieved from a IDataProvider registered with the graph with the current insets key.

Specified by:

calculateBounds in interface IGroupBoundsCalculator

Parameters:

graph - the input graph

groupNode - the group node whose bounds will be calculated

children - a NodeList containing the nodes that reside inside the group node

Returns:

a Rectangle2D instance that describes the bounds of the group node

createEnlargedBounds

protected Rectangle2D createEnlargedBounds(LayoutGraph graph,
                                           Node groupNode,
                                           NodeList children,
                                           Rectangle2D bounds)

Enlarges the given graph bounds by the insets associated with the given group node.

The insets associated with the group node will be retrieved from a IDataProvider registered with the graph with the current insets key.

This method is called while calculating the group bounds to realize the support for custom insets. It may be overridden to change the way specific insets influence the group node bounds.

Parameters:

graph - the input graph

groupNode - the group node whose bounds should be enlarged

children - the list of nodes that the given group node contains

bounds - a Rectangle2D instance representing the bounds of the given group node

Returns:

a Rectangle2D instance representing the enlarged bounds of the given group node

getDefaultInsets

public YInsets getDefaultInsets()

Gets the default insets that will be used if the IDataProvider registered with the insets key does not contain a mapping for a specific node.

Default Value:

The default value is Insets(15,15,15,15). The insets from the top, left, bottom and right are set to 15.

Returns:

the default insets used for group nodes without specific insets

See Also:

setDefaultInsets(YInsets)

getGroupNodeInsetsDpKey

public Object getGroupNodeInsetsDpKey()

Gets the key to register a IDataProvider that is used to access the insets for the group nodes.

The IDataProvider registered with this key must provide a mapping from each group node to a YInsets (or YInsets) instance.

Default Value:

The default value is GroupingKeys.GROUP_NODE_INSETS_DPKEY

Returns:

the IDataProvider key

See Also:

setGroupNodeInsetsDpKey(Object)

isEdgeLabelConsiderationEnabled

public boolean isEdgeLabelConsiderationEnabled()

Gets whether or not the labels of edges contained in a group are considered while calculating the bounds of the group node.

Default Value:

The default value is false. Edge labels are not considered during the group bounds calculation.

Returns:

true if the labels of the edges are considered when calculating the bounds of group nodes, false otherwise

See Also:

setEdgeLabelConsiderationEnabled(boolean)

isNodeHalosConsiderationEnabled

public boolean isNodeHalosConsiderationEnabled()

Gets whether or not the calculation of the bounds of a group node considers the NodeHalos associated with the group's child nodes.

Default Value:

The default value is true. NodeHalos are considered during the group bounds calculation.

Returns:

true if NodeHalos associated with nodes should be considered, false otherwise

See Also:

setNodeHalosConsiderationEnabled(boolean)

isNodeLabelConsiderationEnabled

public boolean isNodeLabelConsiderationEnabled()

Gets whether or not the labels of nodes contained in a group are considered while calculating the bounds of the group node.

Default Value:

The default value is false. Node labels are not considered during the group bounds calculation.

Returns:

true if the labels of the nodes are considered when calculating the bounds of the node's parent group, false otherwise

See Also:

setNodeLabelConsiderationEnabled(boolean)

setDefaultInsets

public void setDefaultInsets(YInsets value)

Sets the default insets that will be used if the IDataProvider registered with the insets key does not contain a mapping for a specific node.

Default Value:

The default value is Insets(15,15,15,15). The insets from the top, left, bottom and right are set to 15.

Parameters:

value - the default insets used for group nodes without specific insets

See Also:

getDefaultInsets()

setEdgeLabelConsiderationEnabled

public void setEdgeLabelConsiderationEnabled(boolean value)

Sets whether or not the labels of edges contained in a group are considered while calculating the bounds of the group node.

Default Value:

The default value is false. Edge labels are not considered during the group bounds calculation.

Parameters:

value - true if the labels of the edges are considered when calculating the bounds of group nodes, false otherwise

See Also:

isEdgeLabelConsiderationEnabled()

setGroupNodeInsetsDpKey

public void setGroupNodeInsetsDpKey(Object value)

Sets the key to register a IDataProvider that is used to access the insets for the group nodes.

The IDataProvider registered with this key must provide a mapping from each group node to a YInsets (or YInsets) instance.

Default Value:

The default value is GroupingKeys.GROUP_NODE_INSETS_DPKEY

Parameters:

value - the IDataProvider key

See Also:

getGroupNodeInsetsDpKey()

setNodeHalosConsiderationEnabled

public void setNodeHalosConsiderationEnabled(boolean value)

Sets whether or not the calculation of the bounds of a group node considers the NodeHalos associated with the group's child nodes.

Default Value:

The default value is true. NodeHalos are considered during the group bounds calculation.

Parameters:

value - true if NodeHalos associated with nodes should be considered, false otherwise

See Also:

isNodeHalosConsiderationEnabled()

setNodeLabelConsiderationEnabled

public void setNodeLabelConsiderationEnabled(boolean value)

Sets whether or not the labels of nodes contained in a group are considered while calculating the bounds of the group node.

Default Value:

The default value is false. Node labels are not considered during the group bounds calculation.

Parameters:

value - true if the labels of the nodes are considered when calculating the bounds of the node's parent group, false otherwise

See Also:

isNodeLabelConsiderationEnabled()