com.itextpdf.layout.renderer

Class ListRenderer

java.lang.Object

com.itextpdf.layout.renderer.AbstractRenderer

com.itextpdf.layout.renderer.BlockRenderer

com.itextpdf.layout.renderer.ListRenderer

All Implemented Interfaces:

IPropertyContainer, IRenderer

public class ListRenderer
extends BlockRenderer

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

Constructor and Description
ListRenderer(List modelElement) Creates a ListRenderer from its corresponding layout object.

Method Summary

Modifier and Type	Method and Description
protected AbstractRenderer	createOverflowRenderer(int layoutResult) Creates an overflow renderer.
protected AbstractRenderer	createSplitRenderer(int layoutResult) Creates a split renderer.
MinMaxWidth	getMinMaxWidth() Calculates min and max width values for current renderer.
IRenderer	getNextRenderer() Gets a new instance of this class to be used as a next renderer, after this renderer is used, if 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.
protected IRenderer	makeListSymbolRenderer(int index, IRenderer renderer)

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

applyRotationLayout, applyVerticalAlignment, beginRotationIfApplied, createRotationTransformInsideOccupiedArea, draw, endRotationIfApplied, getOccupiedAreaBBox

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, 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 Detail

ListRenderer

public ListRenderer(List modelElement)

Creates a ListRenderer from its corresponding layout object.

Parameters:

modelElement - the List which this object should manage

Method Detail

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

getNextRenderer

public IRenderer getNextRenderer()

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

If a renderer overflows to the next area, iText uses this method to create a renderer for the overflow part. So if one wants to extend ListRenderer, one should override this method: otherwise the default method will be used and thus the default rather than the custom renderer will be created.

Returns:

new renderer instance

createSplitRenderer

protected AbstractRenderer createSplitRenderer(int layoutResult)

Description copied from class: BlockRenderer

Creates a split renderer.

Overrides:

createSplitRenderer in class BlockRenderer

Parameters:

layoutResult - the result of content layouting

Returns:

a new AbstractRenderer instance

createOverflowRenderer

protected AbstractRenderer createOverflowRenderer(int layoutResult)

Description copied from class: BlockRenderer

Creates an overflow renderer.

Overrides:

createOverflowRenderer in class BlockRenderer

Parameters:

layoutResult - the result of content layouting

Returns:

a new AbstractRenderer instance

getMinMaxWidth

public MinMaxWidth getMinMaxWidth()

Description copied from class: BlockRenderer

Calculates min and max width values for current renderer.

Overrides:

getMinMaxWidth in class BlockRenderer

Returns:

instance of MinMaxWidth

makeListSymbolRenderer

protected IRenderer makeListSymbolRenderer(int index,
                                           IRenderer renderer)