com.yworks.yfiles.layout

Class MinimumSizeGroupBoundsCalculator

java.lang.Object

com.yworks.yfiles.layout.InsetsGroupBoundsCalculator

com.yworks.yfiles.layout.MinimumSizeGroupBoundsCalculator

All Implemented Interfaces:

IGroupBoundsCalculator

public class MinimumSizeGroupBoundsCalculator
extends InsetsGroupBoundsCalculator

This IGroupBoundsCalculator allows custom insets for group nodes and guarantees that their provided minimum sizes will be maintained.

As a subclass of InsetsGroupBoundsCalculator, this class supports custom insets for each group node. Furthermore, it guarantees that a desired minimum size is maintained. The minimum sizes are provided by a IDataProvider registered with the graph using the specified minimum node size key.

Constructor Summary

Constructors

Constructor and Description
MinimumSizeGroupBoundsCalculator() Creates a new instance of MinimumSizeGroupBoundsCalculator with default settings.
MinimumSizeGroupBoundsCalculator(Object minSizeDataProviderKey) Creates a new instance of MinimumSizeGroupBoundsCalculator with the given key as minimum node size key.

Method Summary

Modifier and Type	Method and Description
Rectangle2D	calculateBounds(LayoutGraph graph, Node groupNode, NodeList children) Calculates the bounds of the given group node, enlarges the bounds by the insets associated with the group node and makes sure that the size of the group node obeys the associated minimum size.
YDimension	getDefaultMinimumNodeSize() Gets the default minimum size (width and height) for group nodes.
Object	getMinimumNodeSizeDpKey() Gets the key to register a IDataProvider that is used to access the minimum sizes for the group nodes.
double	getXAlignment() Gets how the nodes are resized horizontally if the calculated width is smaller than the preferred minimum width of a group node.
double	getYAlignment() Gets how the nodes are resized vertically if the calculated height is smaller than the preferred minimum height of a group node.
void	setDefaultMinimumNodeSize(YDimension value) Sets the default minimum size (width and height) for group nodes.
void	setMinimumNodeSizeDpKey(Object value) Sets the key to register a IDataProvider that is used to access the minimum sizes for the group nodes.
void	setXAlignment(double value) Sets how the nodes are resized horizontally if the calculated width is smaller than the preferred minimum width of a group node.
void	setYAlignment(double value) Sets how the nodes are resized vertically if the calculated height is smaller than the preferred minimum height of a group node.

Methods inherited from class com.yworks.yfiles.layout.InsetsGroupBoundsCalculator

createEnlargedBounds, getDefaultInsets, getGroupNodeInsetsDpKey, isEdgeLabelConsiderationEnabled, isNodeHalosConsiderationEnabled, isNodeLabelConsiderationEnabled, setDefaultInsets, setEdgeLabelConsiderationEnabled, setGroupNodeInsetsDpKey, setNodeHalosConsiderationEnabled, setNodeLabelConsiderationEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

MinimumSizeGroupBoundsCalculator

public MinimumSizeGroupBoundsCalculator()

Creates a new instance of MinimumSizeGroupBoundsCalculator with default settings.

MinimumSizeGroupBoundsCalculator

public MinimumSizeGroupBoundsCalculator(Object minSizeDataProviderKey)

Creates a new instance of MinimumSizeGroupBoundsCalculator with the given key as minimum node size key.

Parameters:

minSizeDataProviderKey - the IDataProvider key to use as minimum size key

Method Detail

calculateBounds

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

Calculates the bounds of the given group node, enlarges the bounds by the insets associated with the group node and makes sure that the size of the group node obeys the associated minimum size.

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

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

Specified by:

calculateBounds in interface IGroupBoundsCalculator

Overrides:

calculateBounds in class InsetsGroupBoundsCalculator

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

getDefaultMinimumNodeSize

public YDimension getDefaultMinimumNodeSize()

Gets the default minimum size (width and height) for group nodes.

The default minimum size is used if the IDataProvider registered with the minimum size key does not contain a mapping for a group node.

Throws:

IllegalArgumentException - if the given YDimension is null

Default Value:

The default value is YDimension(0,0). A YDimension object with width and height set to 0.

Returns:

a YDimension instance representing the default minimum width and height

See Also:

setMinimumNodeSizeDpKey(Object), setDefaultMinimumNodeSize(YDimension)

getMinimumNodeSizeDpKey

public Object getMinimumNodeSizeDpKey()

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

The IDataProvider registered with this key must provide a mapping from each group node to a YDimension object defining the minimum width and height of the group node.

Default Value:

The default value is GroupingKeys.MINIMUM_NODE_SIZE_DPKEY

Returns:

the IDataProvider key for minimum node sizes

See Also:

setDefaultMinimumNodeSize(YDimension), setMinimumNodeSizeDpKey(Object)

getXAlignment

public double getXAlignment()

Gets how the nodes are resized horizontally if the calculated width is smaller than the preferred minimum width of a group node.

The alignment is defined to be a value between 0 and 1, such that:

• A value of 0 means that the nodes grow to the right while the left border remains unchanged.
• A value of 1 means that the nodes grow to the left while the right border remains unchanged.

Throws:

IllegalArgumentException - if the given value does not lie within [0,1]

Default Value:

The default value is 0.5. Nodes grow equally to the left and to the right, while the center remains unchanged.

Returns:

a horizontal alignment value from the interval [0,1]

See Also:

setXAlignment(double)

getYAlignment

public double getYAlignment()

Gets how the nodes are resized vertically if the calculated height is smaller than the preferred minimum height of a group node.

The alignment is defined to be a value between 0 and 1, such that:

• A value of 0 means that the nodes grow downwards while the top border remains unchanged.
• A value of 1 means that the nodes grow upwards while the bottom border remains unchanged.

Throws:

IllegalArgumentException - if the given value does not lie within [0,1]

Default Value:

The default value is 0.5. Nodes grow equally upwards and downwards, while the center remains unchanged.

Returns:

a vertical alignment value from the interval [0,1]

See Also:

setYAlignment(double)

setDefaultMinimumNodeSize

public void setDefaultMinimumNodeSize(YDimension value)

Sets the default minimum size (width and height) for group nodes.

The default minimum size is used if the IDataProvider registered with the minimum size key does not contain a mapping for a group node.

Throws:

IllegalArgumentException - if the given YDimension is null

Default Value:

The default value is YDimension(0,0). A YDimension object with width and height set to 0.

Parameters:

value - a YDimension instance representing the default minimum width and height

See Also:

setMinimumNodeSizeDpKey(Object), getDefaultMinimumNodeSize()

setMinimumNodeSizeDpKey

public void setMinimumNodeSizeDpKey(Object value)

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

The IDataProvider registered with this key must provide a mapping from each group node to a YDimension object defining the minimum width and height of the group node.

Default Value:

The default value is GroupingKeys.MINIMUM_NODE_SIZE_DPKEY

Parameters:

value - the IDataProvider key for minimum node sizes

See Also:

setDefaultMinimumNodeSize(YDimension), getMinimumNodeSizeDpKey()

setXAlignment

public void setXAlignment(double value)

Sets how the nodes are resized horizontally if the calculated width is smaller than the preferred minimum width of a group node.

The alignment is defined to be a value between 0 and 1, such that:

• A value of 0 means that the nodes grow to the right while the left border remains unchanged.
• A value of 1 means that the nodes grow to the left while the right border remains unchanged.

Throws:

IllegalArgumentException - if the given value does not lie within [0,1]

Default Value:

The default value is 0.5. Nodes grow equally to the left and to the right, while the center remains unchanged.

Parameters:

value - a horizontal alignment value from the interval [0,1]

See Also:

getXAlignment()

setYAlignment

public void setYAlignment(double value)

Sets how the nodes are resized vertically if the calculated height is smaller than the preferred minimum height of a group node.

The alignment is defined to be a value between 0 and 1, such that:

• A value of 0 means that the nodes grow downwards while the top border remains unchanged.
• A value of 1 means that the nodes grow upwards while the bottom border remains unchanged.

Throws:

IllegalArgumentException - if the given value does not lie within [0,1]

Default Value:

The default value is 0.5. Nodes grow equally upwards and downwards, while the center remains unchanged.

Parameters:

value - a vertical alignment value from the interval [0,1]

See Also:

getYAlignment()