gumbo.visualize.data.layout
Interface LayoutWhole

All Known Subinterfaces:

LayoutWholeView

All Known Implementing Classes:

GraphLayoutWholeView

public interface LayoutWhole

A container for a set of layout parts that are laid out as a whole. Typically used as input to a layout engine. As such, its contents must be current with the data model it represents before the engine performs a layout.

Version:

$Revision: 1.7 $

Author:

Jon Barrilleaux (jonb@jmbaai.com) of JMB and Associates Inc.

Method Summary

java.util.Collection	getLayoutParts(java.util.Collection retVal) Gets the layout parts in this whole.
AxisBound3	getPartsLayoutBound(AxisBound3 retVal) Returns the smallest bounds containing all of the parts in this whole, in layout space.
AxisBound3	getWholeLayoutBound(AxisBound3 retVal) Gets the largest bound allowed by the whole space, in layout space.

Method Detail

getLayoutParts

public java.util.Collection getLayoutParts(java.util.Collection retVal)

Gets the layout parts in this whole.

Returns:

Reference to retVal. Never null.

getPartsLayoutBound

public AxisBound3 getPartsLayoutBound(AxisBound3 retVal)

Returns the smallest bounds containing all of the parts in this whole, in layout space.

Parameters:

retVal - Return value object. Never null.

Returns:

Reference to retVal. Never null.

getWholeLayoutBound

public AxisBound3 getWholeLayoutBound(AxisBound3 retVal)

Gets the largest bound allowed by the whole space, in layout space.

Parameters:

retVal - Return value object. Never null.

Returns:

Reference to retVal. Never null.