Package com.itextpdf.layout.renderer

Class FootnoteRenderer

java.lang.Object

com.itextpdf.layout.renderer.AbstractRenderer

com.itextpdf.layout.renderer.BlockRenderer

com.itextpdf.layout.renderer.FootnoteRenderer

All Implemented Interfaces:

IPropertyContainer, IRenderer

       public class FootnoteRenderer extends BlockRenderer
      

Renderer for Footnote representing a footnote placed at the bottom of the page.

Field Summary

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

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

Constructor Summary

Constructors

Constructor	Description
FootnoteRenderer(Footnote modelElement)	Creates a FootnoteRenderer from its corresponding layout object.

Method Summary

Modifier and Type	Method	Description
void	draw(DrawContext drawContext)	Flushes the renderer subtree contents, i.e.
IRenderer	getNextRenderer()	Gets a new instance of this class to be used as a next renderer, after this renderer is used, if IRenderer.layout(LayoutContext) is called more than once.
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.BlockRenderer

applyRotationLayout, applyVerticalAlignment, beginRotationIfApplied, createOverflowRenderer, createRotationTransformInsideOccupiedArea, createSplitRenderer, endRotationIfApplied, getMinMaxWidth, getMinMaxWidth, getOccupiedAreaBBox, getResolvedFont

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, createXObject, deleteOwnProperty, deleteProperty, drawBackground, drawBorder, drawChildren, endElementOpacityApplying, endTransformationIfApplied, getBackgroundArea, getBorderAreaBBox, getBorderRadii, getBorders, getChildRenderers, getDefaultProperty, getFirstYLineRecursively, getInnerAreaBBox, getLastYLineRecursively, getMargins, getModelElement, getOccupiedArea, getOwnProperties, getOwnProperty, getPaddings, getParent, getPositionenRenderers, 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

Constructor Details

FootnoteRenderer

             public FootnoteRenderer
             (Footnote modelElement)
            

Creates a FootnoteRenderer from its corresponding layout object.

Parameters:

modelElement - the Footnote which this object should manage

Method Details

getNextRenderer

             public IRenderer getNextRenderer()
            

Description copied from interface: IRenderer

Gets a new instance of this class to be used as a next renderer, after this renderer is used, if IRenderer.layout(LayoutContext) is called more than once.

Returns:

new renderer instance

layout

             public LayoutResult layout
             (LayoutContext layoutContext)
            

Description copied from class: BlockRenderer

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.

Specified by:

layout in interface IRenderer

Overrides:

layout in class BlockRenderer

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 BlockRenderer

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