org.pentaho.reporting.engine.classic.core.layout
Interface Renderer

All Superinterfaces:

Cloneable

All Known Implementing Classes:

AbstractRenderer, FlowRenderer, PageableRenderer, StreamingRenderer

public interface Renderer
extends Cloneable

Creation-Date: 08.04.2007, 16:35:29

Author:

Thomas Morgner

Nested Class Summary

static class

Renderer.LayoutResult

Field Summary

static int	TYPE_FOOTER
static int	TYPE_HEADER
static int	TYPE_NORMALFLOW
static int	TYPE_REPEATED_FOOTER
static int	TYPE_WATERMARK

Method Summary

void	add(Band band, ExpressionRuntime runtime, ReportStateKey stateKey)
void	add(RenderBox box)
void	addEmptyRootLevelBand(ReportStateKey stateKey)
void	addPagebreak(ReportStateKey stateKey)
void	applyAutoCommit()
void	applyRollbackInformation()
boolean	clearPendingPageStart(LayoutPagebreakHandler layoutPagebreakHandler)
Object	clone()
LayoutBuilder	createBufferedLayoutBuilder()
void	createRollbackInformation()
Renderer	deriveForPagebreak()
Renderer	deriveForStorage()
void	endGroup()
void	endGroupBody()
void	endReport()
InlineSubreportMarker[]	endSection()
void	endSubReport()
ReportStateKey	getLastStateKey()
OutputProcessor	getOutputProcessor()
int	getPagebreaks()
int	getPageCount()
boolean	isCurrentPageEmpty()
boolean	isOpen()
boolean	isPageStartPending()
boolean	isPendingPageHack()
boolean	isSafeToStore()
boolean	isValid()
void	newPageStarted()
void	print()
void	processIncrementalUpdate(boolean performOutput)
boolean	processPage(LayoutPagebreakHandler handler, Object commitMarker, boolean performOutput)
void	rollback()
void	setStateKey(Object stateKey)
void	startGroup(Group group)
void	startGroupBody(GroupBody groupBody)
void	startReport(ReportDefinition pageDefinition)
void	startSection(int type)
void	startSubReport(ReportDefinition report, InstanceID insertationPoint)
Renderer.LayoutResult	validatePages()

Field Detail

TYPE_NORMALFLOW

static final int TYPE_NORMALFLOW

See Also:

Constant Field Values

TYPE_HEADER

static final int TYPE_HEADER

See Also:

Constant Field Values

TYPE_FOOTER

static final int TYPE_FOOTER

See Also:

Constant Field Values

TYPE_REPEATED_FOOTER

static final int TYPE_REPEATED_FOOTER

See Also:

Constant Field Values

TYPE_WATERMARK

static final int TYPE_WATERMARK

See Also:

Constant Field Values

Method Detail

getOutputProcessor

OutputProcessor getOutputProcessor()

startReport

void startReport(ReportDefinition pageDefinition)

startSubReport

void startSubReport(ReportDefinition report,
                    InstanceID insertationPoint)

startGroup

void startGroup(Group group)

startGroupBody

void startGroupBody(GroupBody groupBody)

startSection

void startSection(int type)

endSection

InlineSubreportMarker[] endSection()

addEmptyRootLevelBand

void addEmptyRootLevelBand(ReportStateKey stateKey)
                           throws ReportProcessingException

Throws:

ReportProcessingException

add

void add(Band band,
         ExpressionRuntime runtime,
         ReportStateKey stateKey)
         throws ReportProcessingException

Throws:

ReportProcessingException

add

void add(RenderBox box)

endGroupBody

void endGroupBody()

endGroup

void endGroup()

endSubReport

void endSubReport()

endReport

void endReport()

validatePages

Renderer.LayoutResult validatePages()
                                    throws ContentProcessingException

Throws:

ContentProcessingException

processPage

boolean processPage(LayoutPagebreakHandler handler,
                    Object commitMarker,
                    boolean performOutput)
                    throws ContentProcessingException

Throws:

ContentProcessingException

processIncrementalUpdate

void processIncrementalUpdate(boolean performOutput)
                              throws ContentProcessingException

Throws:

ContentProcessingException

getPagebreaks

int getPagebreaks()

isOpen

boolean isOpen()

clone

Object clone()
             throws CloneNotSupportedException

Throws:

CloneNotSupportedException

getLastStateKey

ReportStateKey getLastStateKey()

addPagebreak

void addPagebreak(ReportStateKey stateKey)

clearPendingPageStart

boolean clearPendingPageStart(LayoutPagebreakHandler layoutPagebreakHandler)

isPageStartPending

boolean isPageStartPending()

isCurrentPageEmpty

boolean isCurrentPageEmpty()

deriveForStorage

Renderer deriveForStorage()

deriveForPagebreak

Renderer deriveForPagebreak()

isValid

boolean isValid()

createRollbackInformation

void createRollbackInformation()

applyRollbackInformation

void applyRollbackInformation()

rollback

void rollback()

setStateKey

void setStateKey(Object stateKey)

applyAutoCommit

void applyAutoCommit()

createBufferedLayoutBuilder

LayoutBuilder createBufferedLayoutBuilder()

isPendingPageHack

boolean isPendingPageHack()

isSafeToStore

boolean isSafeToStore()

print

void print()

newPageStarted

void newPageStarted()

getPageCount

int getPageCount()