Class DocumentRenderer

java.lang.Object

com.itextpdf.layout.renderer.AbstractRenderer

com.itextpdf.layout.renderer.RootRenderer

com.itextpdf.layout.renderer.DocumentRenderer

All Implemented Interfaces:

IPropertyContainer, IRenderer

Direct Known Subclasses:

ColumnDocumentRenderer

public class DocumentRenderer
extends RootRenderer

Field Summary

Fields

Modifier and Type	Field	Description
protected Document	document
protected TargetCounterHandler	targetCounterHandler
protected List<Integer>	wrappedContentPage

Fields inherited from class RootRenderer

currentArea, floatRendererAreas, immediateFlush, waitingDrawingElements

Fields inherited from class AbstractRenderer

BOTTOM_SIDE, childRenderers, EPS, flushed, INF, isLastRendererForModelElement, LEFT_SIDE, modelElement, occupiedArea, OVERLAP_EPSILON, parent, positionedRenderers, properties, RIGHT_SIDE, TOP_SIDE

Constructor Summary

Constructors

Constructor	Description
DocumentRenderer(Document document)
DocumentRenderer(Document document, boolean immediateFlush)

Method Summary

Modifier and Type	Method	Description
protected PageSize	addNewPage(PageSize customPageSize)	Adds new page with defined page size to PDF document.
protected PageSize	ensureDocumentHasNPages(int n, PageSize customPageSize)	Ensures that PDF document has n pages.
protected void	flushSingleRenderer(IRenderer resultRenderer)
private Rectangle	getCurrentPageEffectiveArea(PageSize pageSize)
IRenderer	getNextRenderer()	For DocumentRenderer, this has a meaning of the renderer that will be used for relayout.
LayoutArea	getOccupiedArea()	Gets the resultant occupied area after the last call to the IRenderer.layout(LayoutContext) method.
TargetCounterHandler	getTargetCounterHandler()	Get handler for target-counters.
boolean	isRelayoutRequired()	Indicates if relayout is required for targetCounterHandler.
private void	possiblyFlushPreviousPage(int currentPageNumber)
protected LayoutArea	updateCurrentArea(LayoutResult overflowResult)

Methods inherited from class RootRenderer

addChild, close, flush, flushWaitingDrawingElements, flushWaitingDrawingElements, getCurrentArea, layout, linkRenderToDocument, shrinkCurrentAreaAndProcessRenderer

Methods inherited from class AbstractRenderer

addAllChildRenderers, addAllChildRenderers, addAllProperties, addChildRenderer, alignChildHorizontally, allowLastYLineRecursiveExtraction, applyAbsolutePosition, applyAbsolutePositionIfNeeded, applyAction, applyBorderBox, applyBorderBox, applyDestination, applyDestinationsAndAnnotation, applyLinkAnnotation, applyMargins, applyMargins, applyMarginsBordersPaddings, applyPaddings, applyPaddings, applyRelativePositioningTranslation, beginElementOpacityApplying, beginTransformationIfApplied, calculateAbsolutePdfBBox, calculateAdditionalWidth, calculateBBox, calculatePaddingBorderHeight, calculatePaddingBorderWidth, calculateShiftToPositionBBoxOfPointsAt, clipBackgroundArea, clipBackgroundArea, clipBorderArea, createFontCharacteristics, createXObject, deleteOwnProperty, deleteProperty, draw, drawBackground, drawBorder, drawChildren, drawPositionedChildren, endElementOpacityApplying, endTransformationIfApplied, getAspectRatio, getBackgroundArea, getBorderAreaBBox, getBorderRadii, getBorders, getBorders, getChildRenderers, getDefaultProperty, getFirstYLineRecursively, getInnerAreaBBox, getLastYLineRecursively, getMargins, getMinMaxWidth, getMinMaxWidth, getModelElement, getOccupiedAreaBBox, getOwnProperties, getOwnProperty, getPaddings, getParent, getPdfDocument, getProperty, getProperty, getPropertyAsBoolean, getPropertyAsColor, getPropertyAsFloat, getPropertyAsFloat, getPropertyAsFloat, getPropertyAsFont, getPropertyAsInteger, getPropertyAsTransparentColor, getPropertyAsUnitValue, getPropertyAsUnitValue, getRootRenderer, hasAbsoluteUnitValue, hasAspectRatio, hasOwnOrModelProperty, hasOwnProperty, hasProperty, hasRelativeUnitValue, initElementAreas, isAbsolutePosition, isBorderBoxSizing, isFirstOnRootArea, isFirstOnRootArea, isFixedLayout, isFlushed, isKeepTogether, isKeepTogether, isNotFittingHeight, isNotFittingLayoutArea, isNotFittingWidth, isOverflowFit, isOverflowProperty, isOverflowProperty, isOverflowProperty, isPositioned, isRelativePosition, isStaticLayout, logWarningIfGetNextRendererNotOverridden, move, noAbsolutePositionInfo, preparePositionedRendererAndAreaForLayout, processWaitingDrawing, rectangleToPointsList, removeAllChildRenderers, removeChildRenderer, replaceOwnProperty, resolveFirstPdfFont, resolveFirstPdfFont, retrieveHeight, retrieveMaxHeight, retrieveMaxWidth, retrieveMinHeight, retrieveMinWidth, retrieveResolvedDeclaredHeight, retrieveUnitValue, retrieveUnitValue, retrieveWidth, returnBackOwnProperty, setBorders, setChildRenderer, setChildRenderers, setMinMaxWidthBasedOnFixedWidth, setParent, setProperty, setThisAsParent, shrinkOccupiedAreaForAbsolutePosition, toString, transformPoints, updateHeight, updateHeightsOnSplit, updateHeightsOnSplit, updateMaxHeight, updateMinHeight, updateWidth

Methods inherited from class Object

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

Field Details

document

protected Document document

wrappedContentPage

protected List<Integer> wrappedContentPage

targetCounterHandler

protected TargetCounterHandler targetCounterHandler

Constructor Details

DocumentRenderer

public DocumentRenderer(Document document)

DocumentRenderer

public DocumentRenderer(Document document,
 boolean immediateFlush)

Method Details

getTargetCounterHandler

public TargetCounterHandler getTargetCounterHandler()

Get handler for target-counters.

Returns:

the TargetCounterHandler instance

isRelayoutRequired

public boolean isRelayoutRequired()

Indicates if relayout is required for targetCounterHandler.

Returns:

true if relayout is required, false otherwise

getOccupiedArea

public LayoutArea getOccupiedArea()

Description copied from class: AbstractRenderer

Gets the resultant occupied area after the last call to the IRenderer.layout(LayoutContext) method.

Specified by:

getOccupiedArea in interface IRenderer

Overrides:

getOccupiedArea in class AbstractRenderer

Returns:

LayoutArea instance

getNextRenderer

public IRenderer getNextRenderer()

For DocumentRenderer, this has a meaning of the renderer that will be used for relayout.

Returns:

relayout renderer.

updateCurrentArea

protected LayoutArea updateCurrentArea(LayoutResult overflowResult)

Specified by:

updateCurrentArea in class RootRenderer

flushSingleRenderer

protected void flushSingleRenderer(IRenderer resultRenderer)

Specified by:

flushSingleRenderer in class RootRenderer

addNewPage

protected PageSize addNewPage(PageSize customPageSize)

Adds new page with defined page size to PDF document.

Parameters:

customPageSize - the size of new page, can be null

Returns:

the page size of created page

ensureDocumentHasNPages

protected PageSize ensureDocumentHasNPages(int n,
 PageSize customPageSize)

Ensures that PDF document has n pages. If document has fewer pages, adds new pages by calling addNewPage(PageSize) method.

Parameters:

n - the expected number of pages if document

customPageSize - the size of created pages, can be null

Returns:

the page size of the last created page, or null if no page was created

getCurrentPageEffectiveArea

private Rectangle getCurrentPageEffectiveArea(PageSize pageSize)

possiblyFlushPreviousPage

private void possiblyFlushPreviousPage(int currentPageNumber)