Package org.pentaho.reporting.engine.classic.core.layout

Class FlowRenderer

java.lang.Object

org.pentaho.reporting.engine.classic.core.layout.AbstractRenderer

org.pentaho.reporting.engine.classic.core.layout.FlowRenderer

All Implemented Interfaces:

Cloneable, Renderer

public class FlowRenderer
extends AbstractRenderer

A flow renderer is a light-weight paginating renderer. It does not care about the page-size but searches for manual breaks. Once a manual break is encountered, the flow shifts and creates a page-event. (This is the behavior of the old table-exporters.)

This implementation is a mix of a paginated and streaming renderer.

Author:

Thomas Morgner

Nested Class Summary

Nested classes/interfaces inherited from interface org.pentaho.reporting.engine.classic.core.layout.Renderer

Renderer.LayoutResult, Renderer.SectionType

Constructor Summary

Constructors

Constructor	Description
FlowRenderer(OutputProcessor outputProcessor)

Method Summary

Modifier and Type	Method	Description
boolean	clearPendingPageStart(LayoutPagebreakHandler layoutPagebreakHandler)
protected void	close()
protected void	debugPrint(LogicalPageBox pageBox)	A hook to allow easier debugging.
int	getPageCount()
protected void	initializeRendererOnStartReport(ProcessingContext processingContext)
boolean	isCurrentPageEmpty()
protected boolean	isPageFinished()
boolean	isPageStartPending()
protected boolean	performPagination(LayoutPagebreakHandler layoutPagebreakHandler, boolean performOutput)
void	processIncrementalUpdate(boolean performOutput)
void	startReport(ReportDefinition report, ProcessingContext processingContext, PerformanceMonitorContext performanceMonitorContext)

Methods inherited from class org.pentaho.reporting.engine.classic.core.layout.AbstractRenderer

add, addEmptyRootLevelBand, addPagebreak, addProgressBox, addToNormalFlow, applyAutoCommit, applyRollbackInformation, clearDirty, clone, createComponentFactory, createRenderModelBuilder, createRollbackInformation, deriveForPagebreak, deriveForStorage, endGroup, endGroupBody, endReport, endSection, endSubReport, getLastStateKey, getMetaData, getNormalFlowLayoutModelBuilder, getOutputProcessor, getPageBox, getPagebreaks, getPaginateStopWatch, getPerformanceMonitorContext, getRenderModelBuilder, getValidateStopWatch, initialize, isDirty, isOpen, isPendingPageHack, isSafeToStore, isValid, isWidowOrphanDefinitionsEncountered, markDirty, newPageStarted, performParanoidModelCheck, preparePagination, print, printLayoutStateToFile, processPage, rollback, setLastStateKey, setPagebreaks, setStateKey, startGroup, startGroupBody, startSection, startSubReport, validateAfterCommit, validatePages

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowRenderer

public FlowRenderer(OutputProcessor outputProcessor)

Method Detail

isPageFinished

protected boolean isPageFinished()

Specified by:

isPageFinished in class AbstractRenderer

startReport

public void startReport(ReportDefinition report,
                        ProcessingContext processingContext,
                        PerformanceMonitorContext performanceMonitorContext)

Specified by:

startReport in interface Renderer

Overrides:

startReport in class AbstractRenderer

debugPrint

protected void debugPrint(LogicalPageBox pageBox)

Description copied from class: AbstractRenderer

A hook to allow easier debugging.

Overrides:

debugPrint in class AbstractRenderer

Parameters:

pageBox - the current page box.

processIncrementalUpdate

public void processIncrementalUpdate(boolean performOutput)
                              throws ContentProcessingException

Specified by:

processIncrementalUpdate in interface Renderer

Overrides:

processIncrementalUpdate in class AbstractRenderer

Throws:

ContentProcessingException

performPagination

protected boolean performPagination(LayoutPagebreakHandler layoutPagebreakHandler,
                                    boolean performOutput)
                             throws ContentProcessingException

Specified by:

performPagination in class AbstractRenderer

Throws:

ContentProcessingException

getPageCount

public int getPageCount()

Specified by:

getPageCount in interface Renderer

Overrides:

getPageCount in class AbstractRenderer

isCurrentPageEmpty

public boolean isCurrentPageEmpty()

Specified by:

isCurrentPageEmpty in interface Renderer

Overrides:

isCurrentPageEmpty in class AbstractRenderer

clearPendingPageStart

public boolean clearPendingPageStart(LayoutPagebreakHandler layoutPagebreakHandler)

Specified by:

clearPendingPageStart in interface Renderer

Overrides:

clearPendingPageStart in class AbstractRenderer

isPageStartPending

public boolean isPageStartPending()

Specified by:

isPageStartPending in interface Renderer

Overrides:

isPageStartPending in class AbstractRenderer

initializeRendererOnStartReport

protected void initializeRendererOnStartReport(ProcessingContext processingContext)

Overrides:

initializeRendererOnStartReport in class AbstractRenderer

close

protected void close()

Overrides:

close in class AbstractRenderer