org.jfree.layouting.renderer
Class AbstractRenderer

java.lang.Object
  extended by org.jfree.layouting.renderer.AbstractRenderer
All Implemented Interfaces:
Renderer, StatefullComponent
Direct Known Subclasses:
PaginatingRenderer, StreamingRenderer

public abstract class AbstractRenderer
extends java.lang.Object
implements Renderer

Creation-Date: 16.06.2006, 14:10:40

Author:
Thomas Morgner

Nested Class Summary
protected static class AbstractRenderer.RendererState
           
 
Constructor Summary
protected AbstractRenderer(LayoutProcess layoutProcess, boolean init)
           
 
Method Summary
 void addContent(LayoutContext context, ContentToken content)
           
 void addPassThroughContent(LayoutContext context, ContentToken content)
           
 void finishedBlock()
           
 void finishedDocument()
           
 void finishedFlow()
           
 void finishedInline()
           
 void finishedMarker()
           
 void finishedPassThrough()
           
 void finishedRootInline()
           
 void finishedTable()
           
 void finishedTableCaption()
           
 void finishedTableCell()
           
 void finishedTableColumn()
           
 void finishedTableColumnGroup()
           
 void finishedTableRow()
           
 void finishedTableSection()
           
protected  RenderBox getInsertationPoint()
           
 LayoutProcess getLayoutProcess()
           
 LogicalPageBox getLogicalPageBox()
           
 RenderPageContext getPageContext()
           
 RenderPageContext getRenderPageContext()
           
 void handlePageBreak(PageContext pageContext)
          A call-back that informs the renderer, that a new page must be started.
protected  boolean isProcessingNormalFlow()
           
 void setLayoutFailureReason(int layoutFailureReason, java.lang.Object layoutFailureNodeId)
           
 void startedBlock(LayoutContext context)
           
 void startedDocument(PageContext pageContext)
          Starts the document and initalizes the default page context.
 void startedFlow(LayoutContext context)
          Starts a floating, absolute or static element.
 void startedInline(LayoutContext context)
           
 void startedMarker(LayoutContext context)
           
 void startedPassThrough(LayoutContext context)
           
 void startedRootInline(LayoutContext context)
           
 void startedTable(LayoutContext context)
           
 void startedTableCaption(LayoutContext context)
           
 void startedTableCell(LayoutContext context)
           
 void startedTableColumn(LayoutContext context)
           
 void startedTableColumnGroup(LayoutContext context)
           
 void startedTableRow(LayoutContext context)
           
 void startedTableSection(LayoutContext context)
           
protected  void tryValidateOutput(java.lang.Object instanceId)
           
protected abstract  void validateOutput()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.jfree.layouting.StatefullComponent
saveState
 

Constructor Detail

AbstractRenderer

protected AbstractRenderer(LayoutProcess layoutProcess,
                           boolean init)
Method Detail

getLogicalPageBox

public LogicalPageBox getLogicalPageBox()

getLayoutProcess

public LayoutProcess getLayoutProcess()

getRenderPageContext

public RenderPageContext getRenderPageContext()

setLayoutFailureReason

public void setLayoutFailureReason(int layoutFailureReason,
                                   java.lang.Object layoutFailureNodeId)

startedDocument

public void startedDocument(PageContext pageContext)
Description copied from interface: Renderer
Starts the document and initalizes the default page context.

Specified by:
startedDocument in interface Renderer

tryValidateOutput

protected final void tryValidateOutput(java.lang.Object instanceId)
                                throws NormalizationException
Parameters:
instanceId - can be null if there is no meaningful instanceid.
Throws:
NormalizationException

validateOutput

protected abstract void validateOutput()
                                throws NormalizationException
Throws:
NormalizationException

getInsertationPoint

protected RenderBox getInsertationPoint()

isProcessingNormalFlow

protected boolean isProcessingNormalFlow()

startedFlow

public void startedFlow(LayoutContext context)
                 throws NormalizationException
Description copied from interface: Renderer
Starts a floating, absolute or static element. This establishes a new normal flow for the element.

Specified by:
startedFlow in interface Renderer
Throws:
NormalizationException

startedTable

public void startedTable(LayoutContext context)
                  throws NormalizationException
Specified by:
startedTable in interface Renderer
Throws:
NormalizationException

startedTableColumnGroup

public void startedTableColumnGroup(LayoutContext context)
                             throws NormalizationException
Specified by:
startedTableColumnGroup in interface Renderer
Throws:
NormalizationException

startedTableColumn

public void startedTableColumn(LayoutContext context)
                        throws NormalizationException
Specified by:
startedTableColumn in interface Renderer
Throws:
NormalizationException

startedTableSection

public void startedTableSection(LayoutContext context)
                         throws NormalizationException
Specified by:
startedTableSection in interface Renderer
Throws:
NormalizationException

startedTableRow

public void startedTableRow(LayoutContext context)
                     throws NormalizationException
Specified by:
startedTableRow in interface Renderer
Throws:
NormalizationException

startedTableCell

public void startedTableCell(LayoutContext context)
                      throws NormalizationException
Specified by:
startedTableCell in interface Renderer
Throws:
NormalizationException

startedBlock

public void startedBlock(LayoutContext context)
                  throws NormalizationException
Specified by:
startedBlock in interface Renderer
Throws:
NormalizationException

startedMarker

public void startedMarker(LayoutContext context)
                   throws NormalizationException
Specified by:
startedMarker in interface Renderer
Throws:
NormalizationException

startedRootInline

public void startedRootInline(LayoutContext context)
                       throws NormalizationException
Specified by:
startedRootInline in interface Renderer
Throws:
NormalizationException

startedInline

public void startedInline(LayoutContext context)
                   throws NormalizationException
Specified by:
startedInline in interface Renderer
Throws:
NormalizationException

addContent

public void addContent(LayoutContext context,
                       ContentToken content)
                throws NormalizationException
Specified by:
addContent in interface Renderer
Throws:
NormalizationException

finishedInline

public void finishedInline()
                    throws NormalizationException
Specified by:
finishedInline in interface Renderer
Throws:
NormalizationException

finishedRootInline

public void finishedRootInline()
                        throws NormalizationException
Specified by:
finishedRootInline in interface Renderer
Throws:
NormalizationException

finishedMarker

public void finishedMarker()
                    throws NormalizationException
Specified by:
finishedMarker in interface Renderer
Throws:
NormalizationException

finishedBlock

public void finishedBlock()
                   throws NormalizationException
Specified by:
finishedBlock in interface Renderer
Throws:
NormalizationException

finishedTableCell

public void finishedTableCell()
                       throws NormalizationException
Specified by:
finishedTableCell in interface Renderer
Throws:
NormalizationException

finishedTableRow

public void finishedTableRow()
                      throws NormalizationException
Specified by:
finishedTableRow in interface Renderer
Throws:
NormalizationException

finishedTableSection

public void finishedTableSection()
                          throws NormalizationException
Specified by:
finishedTableSection in interface Renderer
Throws:
NormalizationException

finishedTableColumnGroup

public void finishedTableColumnGroup()
                              throws NormalizationException
Specified by:
finishedTableColumnGroup in interface Renderer
Throws:
NormalizationException

finishedTableColumn

public void finishedTableColumn()
                         throws NormalizationException
Specified by:
finishedTableColumn in interface Renderer
Throws:
NormalizationException

finishedTable

public void finishedTable()
                   throws NormalizationException
Specified by:
finishedTable in interface Renderer
Throws:
NormalizationException

finishedFlow

public void finishedFlow()
                  throws NormalizationException
Specified by:
finishedFlow in interface Renderer
Throws:
NormalizationException

finishedDocument

public void finishedDocument()
                      throws NormalizationException
Specified by:
finishedDocument in interface Renderer
Throws:
NormalizationException

getPageContext

public RenderPageContext getPageContext()

handlePageBreak

public void handlePageBreak(PageContext pageContext)
Description copied from interface: Renderer
A call-back that informs the renderer, that a new page must be started. This closes the old page context and copies all pending content to the new context.

This method is triggered by a call to 'LayoutProcess.pageBreakEncountered'

Specified by:
handlePageBreak in interface Renderer

startedPassThrough

public void startedPassThrough(LayoutContext context)
Specified by:
startedPassThrough in interface Renderer

addPassThroughContent

public void addPassThroughContent(LayoutContext context,
                                  ContentToken content)
Specified by:
addPassThroughContent in interface Renderer

finishedPassThrough

public void finishedPassThrough()
Specified by:
finishedPassThrough in interface Renderer

startedTableCaption

public void startedTableCaption(LayoutContext context)
                         throws NormalizationException
Specified by:
startedTableCaption in interface Renderer
Throws:
NormalizationException

finishedTableCaption

public void finishedTableCaption()
                          throws NormalizationException
Specified by:
finishedTableCaption in interface Renderer
Throws:
NormalizationException