Package com.helger.pdflayout.render

Class PagePreRenderContext

java.lang.Object

com.helger.pdflayout.render.PagePreRenderContext

@Immutable
public class PagePreRenderContext
extends Object

This class describes the index of the current page.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
PagePreRenderContext(PLPageSet aPageSet, org.apache.pdfbox.pdmodel.PDDocument aDoc, org.apache.pdfbox.pdmodel.PDPage aPage, int nPageSetIndex, int nPageSetCount, int nPageSetPageIndex, int nPageSetPageCount, int nTotalPageIndex, int nTotalPageCount)

Method Summary

Modifier and Type	Method	Description
void	addPlaceholder(String sKey, int nValue)
void	addPlaceholder(String sKey, String sValue)
com.helger.commons.collection.impl.ICommonsOrderedMap<String,String>	getAllPlaceholders()
org.apache.pdfbox.pdmodel.PDDocument	getDocument()
org.apache.pdfbox.pdmodel.PDPage	getPage()
PLPageSet	getPageSet()
int	getPageSetCount()
int	getPageSetIndex()
int	getPageSetNumber()
int	getPageSetPageCount()
int	getPageSetPageIndex()
int	getPageSetPageNumber()
String	getPlaceholder(String sKey)
int	getPlaceholderAsInt(String sKey, int nDefault)
int	getTotalPageCount()
int	getTotalPageIndex()
int	getTotalPageNumber()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PagePreRenderContext

public PagePreRenderContext(@Nonnull
                            PLPageSet aPageSet,
                            @Nonnull
                            org.apache.pdfbox.pdmodel.PDDocument aDoc,
                            @Nonnull
                            org.apache.pdfbox.pdmodel.PDPage aPage,
                            @Nonnegative
                            int nPageSetIndex,
                            @Nonnegative
                            int nPageSetCount,
                            @Nonnegative
                            int nPageSetPageIndex,
                            @Nonnegative
                            int nPageSetPageCount,
                            @Nonnegative
                            int nTotalPageIndex,
                            @Nonnegative
                            int nTotalPageCount)

Method Detail

getPageSet

@Nonnull
public PLPageSet getPageSet()

Returns:

the document

getDocument

@Nonnull
public org.apache.pdfbox.pdmodel.PDDocument getDocument()

Returns:

the PDFBox document

getPage

@Nonnull
public org.apache.pdfbox.pdmodel.PDPage getPage()

Returns:

the new PDFBox page

getPageSetIndex

@Nonnegative
public int getPageSetIndex()

Returns:

The index of the current page set. 0-based. Always ≥ 0.

getPageSetNumber

@Nonnegative
public int getPageSetNumber()

Returns:

The number of the current page set. 1-based. Always ≥ 1.

getPageSetCount

@Nonnegative
public int getPageSetCount()

Returns:

The total number of page sets. Always ≥ 1.

getPageSetPageIndex

@Nonnegative
public int getPageSetPageIndex()

Returns:

The index of the page in the current page set. 0-based. Always ≥ 0.

getPageSetPageNumber

@Nonnegative
public int getPageSetPageNumber()

Returns:

The number of the page in the current page set. 1-based. Always ≥ 1.

getPageSetPageCount

@Nonnegative
public int getPageSetPageCount()

Returns:

The total number of pages in the current page set. Always ≥ 0.

getTotalPageIndex

@Nonnegative
public int getTotalPageIndex()

Returns:

The index of the page over all page sets. 0-based. Always ≥ 0.

getTotalPageNumber

@Nonnegative
public int getTotalPageNumber()

Returns:

The number of the page over all page sets. 1-based. Always ≥ 1.

getTotalPageCount

@Nonnegative
public int getTotalPageCount()

Returns:

The overall number of pages. Always ≥ 0.

getAllPlaceholders

@Nonnull
@ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsOrderedMap<String,String> getAllPlaceholders()

getPlaceholder

@Nullable
public String getPlaceholder(@Nullable
                             String sKey)

getPlaceholderAsInt

public int getPlaceholderAsInt(@Nullable
                               String sKey,
                               int nDefault)

addPlaceholder

public void addPlaceholder(@Nonnull @Nonempty
                           String sKey,
                           int nValue)

addPlaceholder

public void addPlaceholder(@Nonnull @Nonempty
                           String sKey,
                           @Nonnull
                           String sValue)

toString

public String toString()

Overrides:

toString in class Object