org.jfree.report.flow.layoutprocessor

Class StaticTextLayoutController

public class StaticTextLayoutController extends AbstractLayoutController

Creation-Date: 24.11.2006, 15:06:56

Author: Thomas Morgner

Field Summary
static intFINISHED
static intNOT_STARTED
Constructor Summary
StaticTextLayoutController()
Method Summary
LayoutControlleradvance(ReportTarget target)
Advances the processing position.
LayoutControllercreatePrecomputeInstance(FlowController fc)
Derives a copy of this controller that is suitable to perform a precomputation.
booleanisAdvanceable()
Checks, whether the layout controller would be advanceable.
LayoutControllerjoin(FlowController flowController)
Joins with a delegated process flow.

Field Detail

FINISHED

public static final int FINISHED

NOT_STARTED

public static final int NOT_STARTED

Constructor Detail

StaticTextLayoutController

public StaticTextLayoutController()

Method Detail

advance

public LayoutController advance(ReportTarget target)
Advances the processing position.

Parameters: target the report target that receives generated events.

Returns: the new layout controller instance representing the new state.

Throws: DataSourceException if there was a problem reading data from the datasource. ReportProcessingException if there was a general problem during the report processing. ReportDataFactoryException if a query failed.

createPrecomputeInstance

public LayoutController createPrecomputeInstance(FlowController fc)
Derives a copy of this controller that is suitable to perform a precomputation. The returned layout controller must be independent from the it's anchestor controller.

Parameters: fc a new flow controller for the precomputation.

Returns: a copy that is suitable for precomputation.

isAdvanceable

public boolean isAdvanceable()
Checks, whether the layout controller would be advanceable. If this method returns true, it is generally safe to call the 'advance()' method.

Returns: true, if the layout controller is advanceable, false otherwise.

join

public LayoutController join(FlowController flowController)
Joins with a delegated process flow. This is generally called from a child flow and should *not* (I mean it!) be called from outside. If you do, you'll suffer.

Parameters: flowController the flow controller of the parent.

Returns: the joined layout controller that incorperates all changes from the delegate.