Package com.itextpdf.kernel.pdf

Class PdfPages

java.lang.Object

com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfDictionary>

com.itextpdf.kernel.pdf.PdfPages

class PdfPages
extends PdfObjectWrapper<PdfDictionary>

Field Summary

Fields

Modifier and Type	Field	Description
private PdfNumber	count
private int	from
private PdfArray	kids
private PdfPages	parent

Constructor Summary

Constructors

Constructor	Description
PdfPages(int from, int maxCount, PdfDictionary pdfObject, PdfPages parent)
PdfPages(int from, PdfDocument pdfDocument)
PdfPages(int from, PdfDocument pdfDocument, PdfPages parent)

Method Summary

Modifier and Type	Method	Description
boolean	addPage(int index, PdfPage pdfPage)
void	addPage(PdfDictionary page)
void	addPages(PdfPages pdfPages)
int	compareTo(int index)
void	correctFrom(int correction)
void	decrementCount()
int	getCount()
int	getFrom()
PdfArray	getKids()
PdfPages	getParent()
void	incrementCount()
protected boolean	isWrappedObjectMustBeIndirect()	Defines if the object behind this wrapper must be an indirect object in the resultant document.
void	removeFromParent()
boolean	removePage(int pageNum)

Methods inherited from class com.itextpdf.kernel.pdf.PdfObjectWrapper

ensureObjectIsAddedToDocument, ensureUnderlyingObjectHasIndirectReference, flush, getPdfObject, isFlushed, makeIndirect, makeIndirect, markObjectAsIndirect, setForbidRelease, setModified, setPdfObject, unsetForbidRelease

Methods inherited from class java.lang.Object

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

Field Detail

from

private int from

count

private PdfNumber count

kids

private final PdfArray kids

parent

private final PdfPages parent

Constructor Detail

PdfPages

public PdfPages(int from,
                PdfDocument pdfDocument,
                PdfPages parent)

PdfPages

public PdfPages(int from,
                PdfDocument pdfDocument)

PdfPages

public PdfPages(int from,
                int maxCount,
                PdfDictionary pdfObject,
                PdfPages parent)

Method Detail

addPage

public void addPage(PdfDictionary page)

addPage

public boolean addPage(int index,
                       PdfPage pdfPage)

removePage

public boolean removePage(int pageNum)

addPages

public void addPages(PdfPages pdfPages)

removeFromParent

public void removeFromParent()

getFrom

public int getFrom()

getCount

public int getCount()

correctFrom

public void correctFrom(int correction)

getKids

public PdfArray getKids()

getParent

public PdfPages getParent()

incrementCount

public void incrementCount()

decrementCount

public void decrementCount()

compareTo

public int compareTo(int index)

isWrappedObjectMustBeIndirect

protected boolean isWrappedObjectMustBeIndirect()

Description copied from class: PdfObjectWrapper

Defines if the object behind this wrapper must be an indirect object in the resultant document.

If this method returns true it doesn't necessarily mean that object must be in the indirect state at any moment, but rather defines that when the object will be written to the document it will be transformed into indirect object if it's not indirect yet.

Return value of this method shouldn't depend on any logic, it should return always true or false.

Specified by:

isWrappedObjectMustBeIndirect in class PdfObjectWrapper<PdfDictionary>

Returns:

true if in the resultant document the object behind the wrapper must be indirect, otherwise false.