com.jrefinery.report.targets.base.bandlayout
Interface BandLayoutManager

All Known Implementing Classes:
AbstractBandLayoutManager

public interface BandLayoutManager

An interface that defines the methods to be supported by a band layout manager.

See the AWT LayoutManager for the idea :)

Author:
Thomas Morgner
See Also:
StaticLayoutManager

Field Summary
static StyleKey LAYOUTMANAGER
          The LayoutManager styleKey.
 
Method Summary
 void doLayout(Band b)
          Performs the layout of a band.
 LayoutSupport getLayoutSupport()
          Returns the output target for the layout manager.
 void invalidateLayout(Band container)
          Clears any cached items used by the layout manager.
 java.awt.geom.Dimension2D minimumLayoutSize(Band b, java.awt.geom.Dimension2D containerDims)
          Calculates the minimum layout size for a band.
 java.awt.geom.Dimension2D preferredLayoutSize(Band b, java.awt.geom.Dimension2D containerDims)
          Calculates the preferred layout size for a band.
 void setLayoutSupport(LayoutSupport target)
          Sets the output target for the layout manager.
 

Field Detail

LAYOUTMANAGER

public static final StyleKey LAYOUTMANAGER
The LayoutManager styleKey. All bands must define their LayoutManager by using this key when using the PageableReportProcessor.

Method Detail

preferredLayoutSize

public java.awt.geom.Dimension2D preferredLayoutSize(Band b,
                                                     java.awt.geom.Dimension2D containerDims)
Calculates the preferred layout size for a band.

Parameters:
b - the band.
containerDims - the bounds of the surrounding container.
Returns:
the preferred size.

minimumLayoutSize

public java.awt.geom.Dimension2D minimumLayoutSize(Band b,
                                                   java.awt.geom.Dimension2D containerDims)
Calculates the minimum layout size for a band.

Parameters:
b - the band.
containerDims - the bounds of the surrounding container.
Returns:
the minimum size.

doLayout

public void doLayout(Band b)
Performs the layout of a band.

Parameters:
b - the band.

setLayoutSupport

public void setLayoutSupport(LayoutSupport target)
Sets the output target for the layout manager.

Parameters:
target - the target.

getLayoutSupport

public LayoutSupport getLayoutSupport()
Returns the output target for the layout manager.

Returns:
the target.

invalidateLayout

public void invalidateLayout(Band container)
Clears any cached items used by the layout manager. Invalidates the layout.

Parameters:
container - the container.