com.itextpdf.layout.renderer

Class RootRenderer

java.lang.Object

com.itextpdf.layout.renderer.AbstractRenderer

com.itextpdf.layout.renderer.RootRenderer

All Implemented Interfaces:

IPropertyContainer, IRenderer

Direct Known Subclasses:

CanvasRenderer, DocumentRenderer

public abstract class RootRenderer
extends AbstractRenderer

Field Summary

Fields

Modifier and Type	Field and Description
protected RootLayoutArea	currentArea
protected int	currentPageNumber
protected boolean	immediateFlush
protected List<IRenderer>	waitingDrawingElements

Fields inherited from class com.itextpdf.layout.renderer.AbstractRenderer

childRenderers, EPS, flushed, INF, isLastRendererForModelElement, modelElement, occupiedArea, parent, positionedRenderers, properties

Constructor Summary

Constructors

Constructor and Description
RootRenderer()

Method Summary

Modifier and Type	Method and Description
void	addChild(IRenderer renderer) Adds a child to the current renderer
void	close() This method correctly closes the RootRenderer instance.
void	flush() Draws (flushes) the content.
protected abstract void	flushSingleRenderer(IRenderer resultRenderer)
protected void	flushWaitingDrawingElements()
LayoutArea	getCurrentArea()
LayoutResult	layout(LayoutContext layoutContext) This method simulates positioning of the renderer, including all of its children, and returns the LayoutResult, representing the layout result, including occupied area, status, i.e.
protected void	shrinkCurrentAreaAndProcessRenderer(IRenderer renderer, List<IRenderer> resultRenderers, LayoutResult result)
protected abstract LayoutArea	updateCurrentArea(LayoutResult overflowResult)

Methods inherited from class com.itextpdf.layout.renderer.AbstractRenderer

addAllProperties, alignChildHorizontally, allowLastYLineRecursiveExtraction, applyAbsolutePosition, applyAction, applyBorderBox, applyBorderBox, applyDestination, applyDestinationsAndAnnotation, applyLinkAnnotation, applyMargins, applyMargins, applyPaddings, applyPaddings, applyRelativePositioningTranslation, beginElementOpacityApplying, beginTransformationIfApplied, calculateAbsolutePdfBBox, calculateBBox, calculateShiftToPositionBBoxOfPointsAt, clipBackgroundArea, clipBackgroundArea, clipBorderArea, createXObject, deleteOwnProperty, deleteProperty, draw, drawBackground, drawBorder, drawChildren, endElementOpacityApplying, endTransformationIfApplied, getBackgroundArea, getBorderAreaBBox, getBorderRadii, getBorders, getChildRenderers, getDefaultProperty, getFirstYLineRecursively, getInnerAreaBBox, getLastYLineRecursively, getMargins, getMinMaxWidth, getModelElement, getOccupiedArea, getOccupiedAreaBBox, getOwnProperties, getOwnProperty, getPaddings, getParent, getProperty, getProperty, getPropertyAsBoolean, getPropertyAsColor, getPropertyAsFloat, getPropertyAsFloat, getPropertyAsFont, getPropertyAsInteger, getPropertyAsTransparentColor, getPropertyAsUnitValue, hasAbsoluteUnitValue, hasOwnOrModelProperty, hasOwnProperty, hasProperty, hasRelativeUnitValue, initElementAreas, isAbsolutePosition, isBorderBoxSizing, isFirstOnRootArea, isFixedLayout, isFlushed, isKeepTogether, isNotFittingHeight, isNotFittingLayoutArea, isNotFittingWidth, isOverflowFit, isOverflowProperty, isOverflowProperty, isOverflowProperty, isPositioned, isRelativePosition, isStaticLayout, move, rectangleToPointsList, retrieveHeight, retrieveMaxHeight, retrieveMaxWidth, retrieveMinHeight, retrieveMinWidth, retrieveUnitValue, retrieveUnitValue, retrieveWidth, setBorders, setMinMaxWidthBasedOnFixedWidth, setParent, setProperty, toString, transformPoints, updateHeight, updateHeightsOnSplit, updateMaxHeight, updateMinHeight, updateWidth

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.itextpdf.layout.renderer.IRenderer

getNextRenderer

Field Detail

immediateFlush

protected boolean immediateFlush

currentArea

protected RootLayoutArea currentArea

currentPageNumber

protected int currentPageNumber

waitingDrawingElements

protected List<IRenderer> waitingDrawingElements

Constructor Detail

RootRenderer

public RootRenderer()

Method Detail

addChild

public void addChild(IRenderer renderer)

Description copied from class: AbstractRenderer

Adds a child to the current renderer

Specified by:

addChild in interface IRenderer

Overrides:

addChild in class AbstractRenderer

Parameters:

renderer - a child to be added

flush

public void flush()

Draws (flushes) the content.

See Also:

AbstractRenderer.draw(com.itextpdf.layout.renderer.DrawContext)

close

public void close()

This method correctly closes the RootRenderer instance. There might be hanging elements, like in case of Property.KEEP_WITH_NEXT is set to true and when no consequent element has been added. This method addresses such situations.

layout

public LayoutResult layout(LayoutContext layoutContext)

This method simulates positioning of the renderer, including all of its children, and returns the LayoutResult, representing the layout result, including occupied area, status, i.e. if there was enough place to fit the renderer subtree, etc. LayoutResult can be extended to return custom layout results for custom elements, e.g. TextRenderer uses TextLayoutResult as its result. This method can be called standalone to learn how much area the renderer subtree needs, or can be called before IRenderer.draw(DrawContext), to prepare the renderer to be flushed to the output stream.

Parameters:

layoutContext - the description of layout area and any other additional information

Returns:

result of the layout process

getCurrentArea

public LayoutArea getCurrentArea()

flushSingleRenderer

protected abstract void flushSingleRenderer(IRenderer resultRenderer)

updateCurrentArea

protected abstract LayoutArea updateCurrentArea(LayoutResult overflowResult)

shrinkCurrentAreaAndProcessRenderer

protected void shrinkCurrentAreaAndProcessRenderer(IRenderer renderer,
                                                   List<IRenderer> resultRenderers,
                                                   LayoutResult result)

flushWaitingDrawingElements

protected void flushWaitingDrawingElements()