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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	ListRenderer.ConstantFontTextRenderer

Field Summary

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
ListRenderer(List modelElement)	Creates a ListRenderer from its corresponding layout object.

Method Summary

Modifier and Type	Method	Description
private LayoutResult	correctListSplitting(IRenderer splitRenderer, IRenderer overflowRenderer, IRenderer causeOfNothing, LayoutArea occupiedArea)	Corrects split and overflow renderers when Property.FORCED_PLACEMENT is applied.
private IRenderer	createListSymbolRenderer(int index, IRenderer renderer)
protected AbstractRenderer	createOverflowRenderer(int layoutResult)	Creates an overflow renderer.
protected AbstractRenderer	createSplitRenderer(int layoutResult)	Creates a split renderer.
(package private) static Object	getListItemOrListProperty(IRenderer listItem, IRenderer list, int propertyId)
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.
private LayoutResult	initializeListSymbols(LayoutContext layoutContext)
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)
private LineRenderer	surroundTextBullet(IRenderer bulletRenderer)

Methods inherited from class BlockRenderer

applyMaxHeight, applyMinHeight, applyRotationLayout, applyVerticalAlignment, applyWidth, beginRotationIfApplied, correctFixedLayout, createRotationTransformInsideOccupiedArea, createSplitAndOverflowRenderers, decreaseLayoutBoxAfterChildPlacement, draw, endRotationIfApplied, fixOccupiedAreaIfOverflowedX, fixOccupiedAreaIfOverflowedY, getMinMaxWidth, getOccupiedAreaBBox, getResolvedFont, handleForcedPlacement, processNotFullChildResult, recalculateLayoutBoxBeforeChildLayout, recalculateOccupiedAreaAfterChildLayout, startChildMarginsHandling, stopLayoutingChildrenIfChildResultNotFull

Methods inherited from class AbstractRenderer

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

Constructor Details

ListRenderer

public ListRenderer(List modelElement)

Creates a ListRenderer from its corresponding layout object.

Parameters:

modelElement - the List which this object should manage

Method Details

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)

getListItemOrListProperty

static Object getListItemOrListProperty(IRenderer listItem,
 IRenderer list,
 int propertyId)

createListSymbolRenderer

private IRenderer createListSymbolRenderer(int index,
 IRenderer renderer)

surroundTextBullet

private LineRenderer surroundTextBullet(IRenderer bulletRenderer)

correctListSplitting

private LayoutResult correctListSplitting(IRenderer splitRenderer,
 IRenderer overflowRenderer,
 IRenderer causeOfNothing,
 LayoutArea occupiedArea)

Corrects split and overflow renderers when Property.FORCED_PLACEMENT is applied.

We assume that Property.FORCED_PLACEMENT is applied when the first ListItemRenderer cannot be fully layouted. This means that the problem has occurred in one of the first list item renderer's children. In that case we force the placement of all first item renderer's children before the one, which was the cause of LayoutResult.NOTHING, including this child.

Notice that we do not expect Property.FORCED_PLACEMENT to be applied if we can render the first item renderer and strongly recommend not to set Property.FORCED_PLACEMENT manually.

Parameters:

splitRenderer - the split renderer before correction

overflowRenderer - the overflow renderer before correction

causeOfNothing - the renderer which has produced LayoutResult.NOTHING

occupiedArea - the area occupied by layout before correction

Returns:

corrected layout result

initializeListSymbols

private LayoutResult initializeListSymbols(LayoutContext layoutContext)