com.helger.pdflayout.element

Class PLPageSet

java.lang.Object

com.helger.pdflayout.base.AbstractPLObject<PLPageSet>

com.helger.pdflayout.element.PLPageSet

All Implemented Interfaces:

com.helger.commons.id.IHasID<String>, com.helger.commons.traits.IGenericImplTrait<PLPageSet>, IPLHasBorder<PLPageSet>, IPLHasFillColor<PLPageSet>, IPLHasMargin<PLPageSet>, IPLHasMarginBorderPadding<PLPageSet>, IPLHasOutline, IPLHasPadding<PLPageSet>, IPLObject<PLPageSet>

@NotThreadSafe
public class PLPageSet
extends AbstractPLObject<PLPageSet>
implements IPLHasMarginBorderPadding<PLPageSet>, IPLHasFillColor<PLPageSet>

Represents a single page layout as element. It consists of a page size, a page header and footer as well as a set of page body elements.

Author:

Philip Helger

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PLPageSet.PageSetPrepareResult

Field Summary

Fields inherited from interface com.helger.pdflayout.base.IPLHasMargin

DEFAULT_MARGIN

Fields inherited from interface com.helger.pdflayout.base.IPLHasPadding

DEFAULT_PADDING

Fields inherited from interface com.helger.pdflayout.base.IPLHasBorder

DEFAULT_BORDER

Fields inherited from interface com.helger.pdflayout.base.IPLHasFillColor

DEFAULT_FILL_COLOR

Constructor Summary

Constructors

Constructor and Description
PLPageSet(float fWidth, float fHeight)
PLPageSet(org.apache.pdfbox.pdmodel.common.PDRectangle aPageRect)
PLPageSet(SizeSpec aPageSize)

Method Summary

Modifier and Type	Method and Description
PLPageSet	addElement(IPLRenderableObject<?> aElement)
void	forEachElement(Consumer<? super IPLRenderableObject<?>> aConsumer)
com.helger.commons.collection.ext.ICommonsList<? extends IPLRenderableObject<?>>	getAllElements()
float	getAvailableHeight()
float	getAvailableWidth()
BorderSpec	getBorder()
int	getElementCount()
Color	getFillColor()
MarginSpec	getMargin()
PaddingSpec	getPadding()
IPLElement<?>	getPageFooter()
IPLElement<?>	getPageHeader()
float	getPageHeight()
SizeSpec	getPageSize()
float	getPageWidth()
IRenderingContextCustomizer	getRenderingContextCustomizer()
float	getYTop()
PLPageSet.PageSetPrepareResult	prepareAllPages(PreparationContextGlobal aGlobalCtx)
void	renderAllPages(PLPageSet.PageSetPrepareResult aPrepareResult, org.apache.pdfbox.pdmodel.PDDocument aDoc, boolean bDebug, int nPageSetIndex, int nTotalPageStartIndex, int nTotalPageCount) Render all pages of this layout to the specified PDDocument
PLPageSet	setBorder(BorderSpec aBorder) Set the border values.
PLPageSet	setFillColor(Color aFillColor) Set the element fill color.
PLPageSet	setMargin(MarginSpec aMargin) Set the margin values.
PLPageSet	setPadding(PaddingSpec aPadding) Set the padding values.
PLPageSet	setPageFooter(IPLElement<?> aPageFooter) Set the global page footer
PLPageSet	setPageHeader(IPLElement<?> aPageHeader) Set the global page header
PLPageSet	setRenderingContextCustomizer(IRenderingContextCustomizer aRCCustomizer)
String	toString()

Methods inherited from class com.helger.pdflayout.base.AbstractPLObject

getDebugID, getID, setBasicDataFrom, setID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.pdflayout.base.IPLHasMarginBorderPadding

getFullBottom, getFullLeft, getFullRight, getFullTop, getFullXSum, getFullYSum, getMarginAndBorderBottom, getMarginAndBorderLeft, getMarginAndBorderRight, getMarginAndBorderTop, getMarginAndBorderXSum, getMarginAndBorderYSum

Methods inherited from interface com.helger.pdflayout.base.IPLHasMargin

getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMarginXSum, getMarginYSum, setMargin, setMargin, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop

Methods inherited from interface com.helger.pdflayout.base.IPLHasPadding

getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPaddingXSum, getPaddingYSum, setPadding, setPadding, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop

Methods inherited from interface com.helger.pdflayout.base.IPLHasBorder

getBorderBottomWidth, getBorderLeftWidth, getBorderRightWidth, getBorderTopWidth, getBorderXSumWidth, getBorderYSumWidth, setBorder, setBorder, setBorder, setBorderBottom, setBorderLeft, setBorderRight, setBorderTop

Methods inherited from interface com.helger.pdflayout.base.IPLObject

getAsSplittable, getDebugID, isSplittable

Methods inherited from interface com.helger.commons.id.IHasID

getComparatorID, getID

Methods inherited from interface com.helger.commons.traits.IGenericImplTrait

thisAsT

Methods inherited from interface com.helger.pdflayout.base.IPLHasFillColor

hasFillColor

Constructor Detail

PLPageSet

public PLPageSet(@Nonnull
                 org.apache.pdfbox.pdmodel.common.PDRectangle aPageRect)

PLPageSet

public PLPageSet(@Nonnegative
                 float fWidth,
                 @Nonnegative
                 float fHeight)

PLPageSet

public PLPageSet(@Nonnull
                 SizeSpec aPageSize)

Method Detail

getPageSize

@Nonnull
public SizeSpec getPageSize()

getPageWidth

public float getPageWidth()

getPageHeight

public float getPageHeight()

setMargin

@Nonnull
public final PLPageSet setMargin(@Nonnull
                                           MarginSpec aMargin)

Description copied from interface: IPLHasMargin

Set the margin values. This method may not be called after an element got prepared!

Specified by:

setMargin in interface IPLHasMargin<PLPageSet>

Parameters:

aMargin - Margin to use. May not be null.

Returns:

this

getMargin

@Nonnull
public final MarginSpec getMargin()

Specified by:

getMargin in interface IPLHasMargin<PLPageSet>

Returns:

The current margin. Never null.

setPadding

@Nonnull
public final PLPageSet setPadding(@Nonnull
                                            PaddingSpec aPadding)

Description copied from interface: IPLHasPadding

Set the padding values. This method may not be called after an element got prepared!

Specified by:

setPadding in interface IPLHasPadding<PLPageSet>

Parameters:

aPadding - Padding to use. May not be null.

Returns:

this

getPadding

@Nonnull
public final PaddingSpec getPadding()

Specified by:

getPadding in interface IPLHasPadding<PLPageSet>

Returns:

The current padding. Never null.

setBorder

@Nonnull
public final PLPageSet setBorder(@Nonnull
                                           BorderSpec aBorder)

Description copied from interface: IPLHasBorder

Set the border values. This method may not be called after an element got prepared!

Specified by:

setBorder in interface IPLHasBorder<PLPageSet>

Parameters:

aBorder - Border to use. May not be null.

Returns:

this

getBorder

@Nonnull
public final BorderSpec getBorder()

Specified by:

getBorder in interface IPLHasBorder<PLPageSet>

Returns:

The current border. Never null.

setFillColor

@Nonnull
public PLPageSet setFillColor(@Nullable
                                        Color aFillColor)

Description copied from interface: IPLHasFillColor

Set the element fill color.

Specified by:

setFillColor in interface IPLHasFillColor<PLPageSet>

Parameters:

aFillColor - The fill color to use. May be null.

Returns:

this

getFillColor

@Nullable
public Color getFillColor()

Specified by:

getFillColor in interface IPLHasFillColor<PLPageSet>

Returns:

The current fill color. May be null.

getRenderingContextCustomizer

@Nullable
public IRenderingContextCustomizer getRenderingContextCustomizer()

setRenderingContextCustomizer

@Nonnull
public PLPageSet setRenderingContextCustomizer(@Nullable
                                                         IRenderingContextCustomizer aRCCustomizer)

getAvailableWidth

@Nonnegative
public float getAvailableWidth()

Returns:

The usable page width without the x-paddings and x-margins

getAvailableHeight

@Nonnegative
public float getAvailableHeight()

Returns:

The usable page height without the y-paddings and y-margins

getPageHeader

@Nullable
public IPLElement<?> getPageHeader()

Returns:

The global page header. May be null.

setPageHeader

@Nonnull
public PLPageSet setPageHeader(@Nullable
                                         IPLElement<?> aPageHeader)

Set the global page header

Parameters:

aPageHeader - The global page header. May be null.

Returns:

this

getAllElements

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.ext.ICommonsList<? extends IPLRenderableObject<?>> getAllElements()

getElementCount

@Nonnegative
public int getElementCount()

forEachElement

public void forEachElement(@Nonnull
                           Consumer<? super IPLRenderableObject<?>> aConsumer)

addElement

@Nonnull
public PLPageSet addElement(@Nonnull
                                      IPLRenderableObject<?> aElement)

getPageFooter

@Nullable
public IPLElement<?> getPageFooter()

Returns:

The global page footer. May be null.

setPageFooter

@Nonnull
public PLPageSet setPageFooter(@Nullable
                                         IPLElement<?> aPageFooter)

Set the global page footer

Parameters:

aPageFooter - The global page footer. May be null.

Returns:

this

getYTop

public float getYTop()

Returns:

The y-top of the page

prepareAllPages

@Nonnull
public PLPageSet.PageSetPrepareResult prepareAllPages(@Nonnull
                                                                PreparationContextGlobal aGlobalCtx)
                                                         throws IOException

Throws:

IOException

renderAllPages

public void renderAllPages(@Nonnull
                           PLPageSet.PageSetPrepareResult aPrepareResult,
                           @Nonnull
                           org.apache.pdfbox.pdmodel.PDDocument aDoc,
                           boolean bDebug,
                           @Nonnegative
                           int nPageSetIndex,
                           @Nonnegative
                           int nTotalPageStartIndex,
                           @Nonnegative
                           int nTotalPageCount)
                    throws IOException

Render all pages of this layout to the specified PDDocument

Parameters:

aPrepareResult - The preparation result. May not be null.

aDoc - The PDDocument. May not be null.

bDebug - true for debug output

nPageSetIndex - Page set index. Always ≥ 0.

nTotalPageStartIndex - Total page index. Always ≥ 0.

nTotalPageCount - Total page count. Always ≥ 0.

Throws:

IOException - In case of render errors

toString

public String toString()

Overrides:

toString in class AbstractPLObject<PLPageSet>