Package com.itextpdf.layout

Class ColumnDocumentRenderer

java.lang.Object

com.itextpdf.layout.renderer.AbstractRenderer

com.itextpdf.layout.renderer.RootRenderer

com.itextpdf.layout.renderer.DocumentRenderer

com.itextpdf.layout.ColumnDocumentRenderer

All Implemented Interfaces:

IPropertyContainer, IRenderer

       public class ColumnDocumentRenderer extends DocumentRenderer
      

This class is used for convenient multi-column Document Layouting

Field Summary

Fields

Modifier and Type	Field	Description
protected Rectangle[]	columns
protected int	nextAreaNumber

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

document, targetCounterHandler, wrappedContentPage

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

currentArea, immediateFlush, waitingDrawingElements

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	Description
ColumnDocumentRenderer(Document document, boolean immediateFlush, Rectangle[] columns)	Creates a ColumnDocumentRenderer whose elements need not be flushed immediately.
ColumnDocumentRenderer(Document document, Rectangle[] columns)	Creates a ColumnDocumentRenderer.

Method Summary

Modifier and Type	Method	Description
int	getNextAreaNumber()	Gets the array index of the next area that will be written on after the current one is full (overflowed).
IRenderer	getNextRenderer()	For DocumentRenderer, this has a meaning of the renderer that will be used for relayout.
protected LayoutArea	updateCurrentArea(LayoutResult overflowResult)

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

addNewPage, ensureDocumentHasNPages, flushSingleRenderer, getOccupiedArea, getTargetCounterHandler, isRelayoutRequired

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

addChild, close, flush, flushWaitingDrawingElements, getCurrentArea, layout, shrinkCurrentAreaAndProcessRenderer

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, getMinMaxWidth, getModelElement, 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, 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

Field Details

columns

             protected Rectangle[] columns
            

nextAreaNumber

             protected int nextAreaNumber
            

Constructor Details

ColumnDocumentRenderer

             public ColumnDocumentRenderer
             (Document document, Rectangle[] columns)
            

Creates a ColumnDocumentRenderer. Sets RootRenderer.immediateFlush to true.

Parameters:

document - the Document on which this Renderer will calculate and execute element placements

columns - an array of Rectangle specifying the acceptable positions for elements on a page

ColumnDocumentRenderer

             public ColumnDocumentRenderer
             (Document document, boolean immediateFlush, Rectangle[] columns)
            

Creates a ColumnDocumentRenderer whose elements need not be flushed immediately.

Parameters:

document - the Document on which this Renderer will calculate and execute element placements

immediateFlush - whether or not to flush contents as soon as possible

columns - an array of Rectangle specifying the acceptable positions for elements on a page

Method Details

getNextAreaNumber

             public int getNextAreaNumber()
            

Gets the array index of the next area that will be written on after the current one is full (overflowed).

Returns:

the array index of the next area that will be written on

getNextRenderer

             public IRenderer getNextRenderer()
            

Description copied from class: DocumentRenderer

For DocumentRenderer, this has a meaning of the renderer that will be used for relayout.

Specified by:

getNextRenderer in interface IRenderer

Overrides:

getNextRenderer in class DocumentRenderer

Returns:

relayout renderer.

updateCurrentArea

             protected LayoutArea updateCurrentArea
             (LayoutResult overflowResult)
            

Overrides:

updateCurrentArea in class DocumentRenderer