Package com.helger.pdflayout.base

Class PLPageSet

java.lang.Object

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

com.helger.pdflayout.base.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>, IPLVisitable

@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

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	DEFAULT_DIFFERENT_FIRST_PAGE_FOOTER
static boolean	DEFAULT_DIFFERENT_FIRST_PAGE_HEADER

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

DEFAULT_BORDER

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

DEFAULT_FILL_COLOR

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

DEFAULT_MARGIN

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

DEFAULT_PADDING

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
PLPageSet	addElement(IPLRenderableObject<?> aElement)	Add an element to this page set.
void	forEachElement(Consumer<? super IPLRenderableObject<?>> aConsumer)
com.helger.commons.collection.impl.ICommonsList<? extends IPLRenderableObject<?>>	getAllElements()
float	getAvailableHeight()
float	getAvailableWidth()
BorderSpec	getBorder()
int	getElementCount()
Color	getFillColor()
IPLRenderableObject<?>	getFirstPageFooter()
IPLRenderableObject<?>	getFirstPageHeader()
MarginSpec	getMargin()
PaddingSpec	getPadding()
IPLRenderableObject<?>	getPageFooter()
IPLRenderableObject<?>	getPageHeader()
float	getPageHeight()
SizeSpec	getPageSize()
float	getPageWidth()
IPreRenderContextCustomizer	getPreRenderContextCustomizer()
IRenderContextCustomizer	getRenderContextCustomizer()
float	getYTop()
boolean	hasFirstPageFooter()
boolean	hasFirstPageHeader()
boolean	hasPageFooter()
boolean	hasPageHeader()
boolean	isDifferentFirstPageFooter()
boolean	isDifferentFirstPageHeader()
PLPageSetPrepareResult	prepareAllPages(PreparationContextGlobal aGlobalCtx)
void	renderAllPages(PLPageSetPrepareResult aPrepareResult, org.apache.pdfbox.pdmodel.PDDocument aDoc, boolean bCompressPDF, int nPageSetIndex, int nPageSetCount, int nTotalPageStartIndex, int nTotalPageCount)	Render all pages of this layout to the specified PDDocument
PLPageSet	setBorder(BorderSpec aBorder)	Set the border values.
PLPageSet	setDifferentFirstPageFooter(boolean bDifferentFirstPageFooter)	Enable/disable usage of special footer on the first page.
PLPageSet	setDifferentFirstPageHeader(boolean bDifferentFirstPageHeader)	Enable/disable usage of special header on the first page.
PLPageSet	setFillColor(Color aFillColor)	Set the element fill color.
PLPageSet	setFirstPageFooter(IPLRenderableObject<?> aFirstPageFooter)	Set the global page footer.
PLPageSet	setFirstPageHeader(IPLRenderableObject<?> aPageHeader)	Set the global first page header.
PLPageSet	setMargin(MarginSpec aMargin)	Set the margin values.
PLPageSet	setPadding(PaddingSpec aPadding)	Set the padding values.
PLPageSet	setPageFooter(IPLRenderableObject<?> aPageFooter)	Set the global page footer
PLPageSet	setPageHeader(IPLRenderableObject<?> aPageHeader)	Set the global page header
PLPageSet	setPreRenderContextCustomizer(IPreRenderContextCustomizer aPRCCustomizer)
PLPageSet	setRenderContextCustomizer(IRenderContextCustomizer aRCCustomizer)
String	toString()
com.helger.commons.state.EChange	visit(IPLVisitor aVisitor)	Visit this object and all descendants

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

getDebugID, getID, onAfterSetID, 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.commons.traits.IGenericImplTrait

thisAsT

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

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

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

hasFillColor

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

addMarginBottom, addMarginLeft, addMarginRight, addMarginTop, addMarginX, addMarginY, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMarginXSum, getMarginYSum, setMargin, setMargin, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMarginX, setMarginY

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

getOutlineBottom, getOutlineLeft, getOutlineRight, getOutlineTop, getOutlineXSum, getOutlineYSum

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

addPaddingBottom, addPaddingLeft, addPaddingRight, addPaddingTop, addPaddingX, addPaddingY, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPaddingXSum, getPaddingYSum, setPadding, setPadding, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPaddingX, setPaddingY

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

getAsSplittable, hasID, isVertSplittable

Field Detail

DEFAULT_DIFFERENT_FIRST_PAGE_HEADER

public static final boolean DEFAULT_DIFFERENT_FIRST_PAGE_HEADER

See Also:

Constant Field Values

DEFAULT_DIFFERENT_FIRST_PAGE_FOOTER

public static final boolean DEFAULT_DIFFERENT_FIRST_PAGE_FOOTER

See Also:

Constant Field Values

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 final SizeSpec getPageSize()

Returns:

The page size as specified in the constructor. Never null.

See Also:

getPageWidth(), getPageHeight()

getPageWidth

public final float getPageWidth()

Returns:

The page width as specified in the constructor. Never null.

See Also:

getPageSize(), getPageHeight()

getPageHeight

public final float getPageHeight()

Returns:

The page height as specified in the constructor. Never null.

See Also:

getPageSize(), getPageWidth()

getMargin

@Nonnull
public final MarginSpec getMargin()

Specified by:

getMargin in interface IPLHasMargin<PLPageSet>

Returns:

The current margin. Never null.

setMargin

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

Description copied from interface: IPLHasMargin

Set the margin values.

Specified by:

setMargin in interface IPLHasMargin<PLPageSet>

Parameters:

aMargin - Margin 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.

setPadding

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

Description copied from interface: IPLHasPadding

Set the padding values.

Specified by:

setPadding in interface IPLHasPadding<PLPageSet>

Parameters:

aPadding - Padding 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.

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

getFillColor

@Nullable
public final Color getFillColor()

Specified by:

getFillColor in interface IPLHasFillColor<PLPageSet>

Returns:

The current fill color. May be null.

setFillColor

@Nonnull
public final 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

getPreRenderContextCustomizer

@Nullable
public final IPreRenderContextCustomizer getPreRenderContextCustomizer()

setPreRenderContextCustomizer

@Nonnull
public final PLPageSet setPreRenderContextCustomizer(@Nullable
                                                     IPreRenderContextCustomizer aPRCCustomizer)

getRenderContextCustomizer

@Nullable
public final IRenderContextCustomizer getRenderContextCustomizer()

setRenderContextCustomizer

@Nonnull
public final PLPageSet setRenderContextCustomizer(@Nullable
                                                  IRenderContextCustomizer aRCCustomizer)

getAvailableWidth

@Nonnegative
public float getAvailableWidth()

Returns:

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

getAvailableHeight

@Nonnegative
public float getAvailableHeight()

Returns:

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

isDifferentFirstPageHeader

public boolean isDifferentFirstPageHeader()

Returns:

true if a special page header should be used on the first page, false if the same header should be used.

Since:

5.0.2

setDifferentFirstPageHeader

@Nonnull
public PLPageSet setDifferentFirstPageHeader(boolean bDifferentFirstPageHeader)

Enable/disable usage of special header on the first page. To have an effect, setFirstPageHeader(IPLRenderableObject) must be called

Parameters:

bDifferentFirstPageHeader - true for special page header on the first page

Returns:

this for chaining

Since:

5.0.2

See Also:

setFirstPageHeader(IPLRenderableObject)

getFirstPageHeader

@Nullable
public IPLRenderableObject<?> getFirstPageHeader()

Returns:

The global first page header. May be null.

Since:

5.0.2

hasFirstPageHeader

public boolean hasFirstPageHeader()

Returns:

true if a global first page header is present, false if not.

Since:

5.0.2

setFirstPageHeader

@Nonnull
public PLPageSet setFirstPageHeader(@Nullable
                                    IPLRenderableObject<?> aPageHeader)

Set the global first page header. Must be enabled explicitly via setDifferentFirstPageHeader(boolean) to take effect.

Parameters:

aPageHeader - The global page header. May be null.

Returns:

this

Since:

5.0.2

See Also:

setDifferentFirstPageHeader(boolean)

getPageHeader

@Nullable
public IPLRenderableObject<?> getPageHeader()

Returns:

The global page header. May be null.

hasPageHeader

public boolean hasPageHeader()

Returns:

true if a global page header is present, false if not.

setPageHeader

@Nonnull
public PLPageSet setPageHeader(@Nullable
                               IPLRenderableObject<?> 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.impl.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)

Add an element to this page set.

Parameters:

aElement - The element to add. May not be null.

Returns:

this for chaining.

isDifferentFirstPageFooter

public boolean isDifferentFirstPageFooter()

Returns:

true if a special page footer should be used on the first page, false if the same footer should be used.

Since:

5.0.2

setDifferentFirstPageFooter

@Nonnull
public PLPageSet setDifferentFirstPageFooter(boolean bDifferentFirstPageFooter)

Enable/disable usage of special footer on the first page. To have an effect, setFirstPageFooter(IPLRenderableObject) must be called.

Parameters:

bDifferentFirstPageFooter - true for special page footer on the first page

Returns:

this for chaining

Since:

5.0.2

See Also:

setFirstPageFooter(IPLRenderableObject)

getFirstPageFooter

@Nullable
public IPLRenderableObject<?> getFirstPageFooter()

Returns:

The global first page footer. May be null.

Since:

5.0.2

hasFirstPageFooter

public boolean hasFirstPageFooter()

Returns:

true if a global first page footer is present, false if not.

Since:

5.0.2

setFirstPageFooter

@Nonnull
public PLPageSet setFirstPageFooter(@Nullable
                                    IPLRenderableObject<?> aFirstPageFooter)

Set the global page footer. Must be enabled explicitly via setDifferentFirstPageFooter(boolean) to take effect.

Parameters:

aFirstPageFooter - The global first page footer. May be null.

Returns:

this

Since:

5.0.2

See Also:

setDifferentFirstPageFooter(boolean)

getPageFooter

@Nullable
public IPLRenderableObject<?> getPageFooter()

Returns:

The global page footer. May be null.

hasPageFooter

public boolean hasPageFooter()

Returns:

true if a global page footer is present, false if not.

setPageFooter

@Nonnull
public PLPageSet setPageFooter(@Nullable
                               IPLRenderableObject<?> 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 excluding top padding, top-border and top-margin

visit

@Nonnull
public com.helger.commons.state.EChange visit(@Nonnull
                                              IPLVisitor aVisitor)
                                       throws IOException

Description copied from interface: IPLVisitable

Visit this object and all descendants

Specified by:

visit in interface IPLVisitable

Parameters:

aVisitor - The visitor to use. May not be null.

Returns:

EChange.CHANGED if something changed internally.

Throws:

IOException - on PDFBox error

prepareAllPages

@Nonnull
public PLPageSetPrepareResult prepareAllPages(@Nonnull
                                              PreparationContextGlobal aGlobalCtx)

renderAllPages

public void renderAllPages(@Nonnull
                           PLPageSetPrepareResult aPrepareResult,
                           @Nonnull
                           org.apache.pdfbox.pdmodel.PDDocument aDoc,
                           boolean bCompressPDF,
                           @Nonnegative
                           int nPageSetIndex,
                           @Nonnegative
                           int nPageSetCount,
                           @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.

bCompressPDF - true for create enflated PDF content

nPageSetIndex - Page set index. Always ≥ 0.

nPageSetCount - Page set count. Always ≥ 1.

nTotalPageStartIndex - Total page index. Always ≥ 0.

nTotalPageCount - Total page count. Always ≥ 1.

Throws:

IOException - In case of render errors

toString

public String toString()

Overrides:

toString in class AbstractPLObject<PLPageSet>