com.itextpdf.layout.renderer

Class BlockRenderer

java.lang.Object

com.itextpdf.layout.renderer.AbstractRenderer

com.itextpdf.layout.renderer.BlockRenderer

All Implemented Interfaces:

IPropertyContainer, IRenderer

Direct Known Subclasses:

CellRenderer, DivRenderer, GridContainerRenderer, LineSeparatorRenderer, ListRenderer, ParagraphRenderer

public abstract class BlockRenderer
extends AbstractRenderer

Represents a renderer for block elements.

Field Summary

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

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BlockRenderer(IElement modelElement) Creates a BlockRenderer from its corresponding layout object.

Method Summary

Modifier and Type	Method and Description
protected void	applyRotationLayout(Rectangle layoutBox) This method rotates content of the renderer and calculates correct occupied area for the rotated element.
protected void	applyVerticalAlignment() This method applies vertical alignment for the occupied area of the renderer and its children renderers.
protected void	beginRotationIfApplied(PdfCanvas canvas) This method starts rotation for the renderer if rotation angle property is specified.
protected AbstractRenderer	createOverflowRenderer(int layoutResult) Creates an overflow renderer.
protected AffineTransform	createRotationTransformInsideOccupiedArea() This method creates AffineTransform instance that could be used to rotate content inside the occupied area.
protected AbstractRenderer	createSplitRenderer(int layoutResult) Creates a split renderer.
void	draw(DrawContext drawContext) Flushes the renderer subtree contents, i.e.
protected void	endRotationIfApplied(PdfCanvas canvas) This method ends rotation for the renderer if applied.
MinMaxWidth	getMinMaxWidth() Calculates min and max width values for current renderer.
MinMaxWidth	getMinMaxWidth(Float parentBoxWidth) Calculates min and max width values for current renderer.
Rectangle	getOccupiedAreaBBox() Gets the bounding box that contains all content written to the DrawContext by this IRenderer.
protected PdfFont	getResolvedFont(PdfDocument pdfDocument) Get the font set in properties, if it is not set, then resolves the first PdfFont from FontProvider.
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.

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

addAllProperties, addChild, 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, drawBackground, drawBorder, drawChildren, endElementOpacityApplying, endTransformationIfApplied, getBackgroundArea, getBorderAreaBBox, getBorderRadii, getBorders, getChildRenderers, getDefaultProperty, getFirstYLineRecursively, getInnerAreaBBox, getLastYLineRecursively, getMargins, getModelElement, getOccupiedArea, 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, retrieveResolvedDeclaredHeight, 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

Constructor Detail

BlockRenderer

protected BlockRenderer(IElement modelElement)

Creates a BlockRenderer from its corresponding layout object.

Parameters:

modelElement - the IElement which this object should manage

Method Detail

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

draw

public void draw(DrawContext drawContext)

Description copied from class: AbstractRenderer

Flushes the renderer subtree contents, i.e. draws itself on canvas, adds necessary objects to the PdfDocument etc.

Specified by:

draw in interface IRenderer

Overrides:

draw in class AbstractRenderer

Parameters:

drawContext - contains the PdfDocument to which the renderer subtree if flushed, the PdfCanvas on which the renderer subtree is drawn and other additional parameters needed to perform drawing

getOccupiedAreaBBox

public Rectangle getOccupiedAreaBBox()

Description copied from class: AbstractRenderer

Gets the bounding box that contains all content written to the DrawContext by this IRenderer.

Overrides:

getOccupiedAreaBBox in class AbstractRenderer

Returns:

the smallest Rectangle that surrounds the content

createSplitRenderer

protected AbstractRenderer createSplitRenderer(int layoutResult)

Creates a split renderer.

Parameters:

layoutResult - the result of content layouting

Returns:

a new AbstractRenderer instance

createOverflowRenderer

protected AbstractRenderer createOverflowRenderer(int layoutResult)

Creates an overflow renderer.

Parameters:

layoutResult - the result of content layouting

Returns:

a new AbstractRenderer instance

applyVerticalAlignment

protected void applyVerticalAlignment()

This method applies vertical alignment for the occupied area of the renderer and its children renderers.

applyRotationLayout

protected void applyRotationLayout(Rectangle layoutBox)

This method rotates content of the renderer and calculates correct occupied area for the rotated element.

Parameters:

layoutBox - a Rectangle

createRotationTransformInsideOccupiedArea

protected AffineTransform createRotationTransformInsideOccupiedArea()

This method creates AffineTransform instance that could be used to rotate content inside the occupied area. Be aware that it should be used only after layout rendering is finished and correct occupied area for the rotated element is calculated.

Returns:

AffineTransform that rotates the content and places it inside occupied area.

beginRotationIfApplied

protected void beginRotationIfApplied(PdfCanvas canvas)

This method starts rotation for the renderer if rotation angle property is specified.

Parameters:

canvas - the PdfCanvas to draw on

endRotationIfApplied

protected void endRotationIfApplied(PdfCanvas canvas)

This method ends rotation for the renderer if applied.

Parameters:

canvas - the PdfCanvas to draw on

getResolvedFont

protected PdfFont getResolvedFont(PdfDocument pdfDocument)

Get the font set in properties, if it is not set, then resolves the first PdfFont from FontProvider. If FontProvider is not set, then returns null.

Parameters:

pdfDocument - the PdfDocument to get default font from.

Returns:

the font or null if it is not set and FontProvider is not set.

getMinMaxWidth

public MinMaxWidth getMinMaxWidth()

Calculates min and max width values for current renderer.

Overrides:

getMinMaxWidth in class AbstractRenderer

Returns:

instance of MinMaxWidth

getMinMaxWidth

public MinMaxWidth getMinMaxWidth(Float parentBoxWidth)

Calculates min and max width values for current renderer.

Overrides:

getMinMaxWidth in class AbstractRenderer

Parameters:

parentBoxWidth - max width of the area on which current renderer will be laid out

Returns:

instance of MinMaxWidth