com.itextpdf.kernel.pdf

Class PdfPage

java.lang.Object

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

com.itextpdf.kernel.pdf.PdfPage

All Implemented Interfaces:

Serializable

public class PdfPage
extends PdfObjectWrapper<PdfDictionary>

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PdfPage(PdfDictionary pdfObject)
protected	PdfPage(PdfDocument pdfDocument)
protected	PdfPage(PdfDocument pdfDocument, PageSize pageSize)

Method Summary

Modifier and Type	Method and Description
PdfPage	addAnnotation(int index, PdfAnnotation annotation, boolean tagAnnotation)
PdfPage	addAnnotation(PdfAnnotation annotation)
boolean	containsAnnotation(PdfAnnotation annotation)
PdfFormXObject	copyAsFormXObject(PdfDocument toDocument) Copies page as FormXObject to the specified document.
PdfPage	copyTo(PdfDocument toDocument) Copies page to the specified document.
PdfPage	copyTo(PdfDocument toDocument, IPdfPageExtraCopier copier) Copies page to the specified document.
void	flush() Flushes page and it's content stream.
void	flush(boolean flushXObjects) Flushes page and its content stream.
List<PdfAnnotation>	getAnnotations()
int	getAnnotsSize()
Rectangle	getArtBox()
byte[]	getContentBytes() Get decoded bytes for the whole page content.
PdfStream	getContentStream(int index)
int	getContentStreamCount()
Rectangle	getCropBox()
PdfDocument	getDocument()
PdfStream	getFirstContentStream()
PdfStream	getLastContentStream()
Rectangle	getMediaBox()
int	getNextMcid() Calculates and returns next available MCID reference.
List<PdfOutline>	getOutlines(boolean updateOutlines) This method gets outlines of a current page
Rectangle	getPageSize()
Rectangle	getPageSizeWithRotation() Gets the rotated page.
PdfResources	getResources()
int	getRotation()
byte[]	getStreamBytes(int index) Gets decoded bytes of a certain stream of a page content.
Integer	getStructParentIndex()
Rectangle	getTrimBox()
PdfStream	getXmpMetadata()
boolean	isIgnorePageRotationForContent()
boolean	isPageRotationInverseMatrixWritten() This flag is meaningful for the case, when page rotation is applied and ignorePageRotationForContent is set to true.
protected boolean	isWrappedObjectMustBeIndirect() Defines if the object behind this wrapper must be an indirect object in the resultant document.
PdfStream	newContentStreamAfter()
PdfStream	newContentStreamBefore()
PdfPage	put(PdfName key, PdfObject value)
PdfPage	removeAnnotation(PdfAnnotation annotation) Removes an annotation from the page.
PdfPage	setAdditionalAction(PdfName key, PdfAction action)
PdfPage	setArtBox(Rectangle rectangle)
PdfPage	setCropBox(Rectangle rectangle)
PdfPage	setIgnorePageRotationForContent(boolean ignorePageRotationForContent) If true - defines that in case the page has a rotation, then new content will be automatically rotated in the opposite direction.
PdfPage	setMediaBox(Rectangle rectangle)
PdfPage	setPageLabel(PageLabelNumberingStyleConstants numberingStyle, String labelPrefix) This method adds or replaces a page label.
PdfPage	setPageLabel(PageLabelNumberingStyleConstants numberingStyle, String labelPrefix, int firstPage) This method adds or replaces a page label.
void	setPageRotationInverseMatrixWritten() NOTE: For internal usage!
PdfPage	setResources(PdfResources pdfResources)
PdfPage	setRotation(int degAngle)
PdfPage	setTrimBox(Rectangle rectangle)
void	setXmpMetadata(byte[] xmpMetadata) Use this method to set the XMP Metadata for each page.
void	setXmpMetadata(XMPMeta xmpMeta)
void	setXmpMetadata(XMPMeta xmpMeta, SerializeOptions serializeOptions)

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

ensureObjectIsAddedToDocument, 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

Constructor Detail

PdfPage

protected PdfPage(PdfDictionary pdfObject)

PdfPage

protected PdfPage(PdfDocument pdfDocument,
                  PageSize pageSize)

PdfPage

protected PdfPage(PdfDocument pdfDocument)

Method Detail

getPageSize

public Rectangle getPageSize()

getPageSizeWithRotation

public Rectangle getPageSizeWithRotation()

Gets the rotated page.

Returns:

the rotated rectangle

getRotation

public int getRotation()

setRotation

public PdfPage setRotation(int degAngle)

getContentStream

public PdfStream getContentStream(int index)

getContentStreamCount

public int getContentStreamCount()

getFirstContentStream

public PdfStream getFirstContentStream()

getLastContentStream

public PdfStream getLastContentStream()

newContentStreamBefore

public PdfStream newContentStreamBefore()

newContentStreamAfter

public PdfStream newContentStreamAfter()

getResources

public PdfResources getResources()

setResources

public PdfPage setResources(PdfResources pdfResources)

setXmpMetadata

public void setXmpMetadata(byte[] xmpMetadata)
                    throws IOException

Use this method to set the XMP Metadata for each page.

Parameters:

xmpMetadata - The xmpMetadata to set.

Throws:

IOException

setXmpMetadata

public void setXmpMetadata(XMPMeta xmpMeta,
                           SerializeOptions serializeOptions)
                    throws XMPException,
                           IOException

Throws:

XMPException

IOException

setXmpMetadata

public void setXmpMetadata(XMPMeta xmpMeta)
                    throws XMPException,
                           IOException

Throws:

XMPException

IOException

getXmpMetadata

public PdfStream getXmpMetadata()
                         throws XMPException

Throws:

XMPException

copyTo

public PdfPage copyTo(PdfDocument toDocument)

Copies page to the specified document.

NOTE: Works only for pages from the document opened in reading mode, otherwise an exception is thrown.

Parameters:

toDocument - a document to copy page to.

Returns:

copied page.

copyTo

public PdfPage copyTo(PdfDocument toDocument,
                      IPdfPageExtraCopier copier)

Copies page to the specified document.

NOTE: Works only for pages from the document opened in reading mode, otherwise an exception is thrown.

Parameters:

toDocument - a document to copy page to.

copier - a copier which bears a specific copy logic. May be NULL

Returns:

copied page.

copyAsFormXObject

public PdfFormXObject copyAsFormXObject(PdfDocument toDocument)
                                 throws IOException

Copies page as FormXObject to the specified document.

Parameters:

toDocument - a document to copy to.

Returns:

resultant XObject.

Throws:

IOException

getDocument

public PdfDocument getDocument()

flush

public void flush()

Flushes page and it's content stream.

If the page belongs to the document which is tagged, page flushing also triggers flushing of the tags, which are considered to belong to the page. The logic that defines if the given tag (structure element) belongs to the page is the following: if all the marked content references (dictionary or number references), that are the descenders of the given structure element, belong to the current page - the tag is considered to belong to the page. If tag has descenders from several pages - it is flushed, if all other pages except the current one are flushed.

Overrides:

flush in class PdfObjectWrapper<PdfDictionary>

flush

public void flush(boolean flushXObjects)

Flushes page and its content stream. If flushXObjects is true the images and FormXObjects associated with this page will also be flushed.
For notes about tag structure flushing see PdfPage#flush() method.

If PdfADocument is used, flushing will be applied only if flushXObjects is true.

Parameters:

flushXObjects - if true the images and FormXObjects associated with this page will also be flushed.

getMediaBox

public Rectangle getMediaBox()

setMediaBox

public PdfPage setMediaBox(Rectangle rectangle)

getCropBox

public Rectangle getCropBox()

setCropBox

public PdfPage setCropBox(Rectangle rectangle)

setArtBox

public PdfPage setArtBox(Rectangle rectangle)

getArtBox

public Rectangle getArtBox()

setTrimBox

public PdfPage setTrimBox(Rectangle rectangle)

getTrimBox

public Rectangle getTrimBox()

getContentBytes

public byte[] getContentBytes()

Get decoded bytes for the whole page content.

Returns:

byte array.

Throws:

PdfException - in case any @see IOException.

getStreamBytes

public byte[] getStreamBytes(int index)

Gets decoded bytes of a certain stream of a page content.

Parameters:

index - index of stream inside Content.

Returns:

byte array.

Throws:

PdfException - in case any @see IOException.

getNextMcid

public int getNextMcid()

Calculates and returns next available MCID reference.

Returns:

calculated MCID reference.

Throws:

PdfException

getStructParentIndex

public Integer getStructParentIndex()

setAdditionalAction

public PdfPage setAdditionalAction(PdfName key,
                                   PdfAction action)

getAnnotations

public List<PdfAnnotation> getAnnotations()

containsAnnotation

public boolean containsAnnotation(PdfAnnotation annotation)

addAnnotation

public PdfPage addAnnotation(PdfAnnotation annotation)

addAnnotation

public PdfPage addAnnotation(int index,
                             PdfAnnotation annotation,
                             boolean tagAnnotation)

removeAnnotation

public PdfPage removeAnnotation(PdfAnnotation annotation)

Removes an annotation from the page.

NOTE: If document is tagged, PdfDocument's PdfTagStructure instance will point at annotation tag parent after method call.

Parameters:

annotation - an annotation to be removed.

Returns:

this PdfPage instance.

getAnnotsSize

public int getAnnotsSize()

getOutlines

public List<PdfOutline> getOutlines(boolean updateOutlines)

This method gets outlines of a current page

Parameters:

updateOutlines -

Returns:

return all outlines of a current page

Throws:

PdfException

isIgnorePageRotationForContent

public boolean isIgnorePageRotationForContent()

Returns:

true - if in case the page has a rotation, then new content will be automatically rotated in the opposite direction. On the rotated page this would look like if new content ignores page rotation.

setIgnorePageRotationForContent

public PdfPage setIgnorePageRotationForContent(boolean ignorePageRotationForContent)

If true - defines that in case the page has a rotation, then new content will be automatically rotated in the opposite direction. On the rotated page this would look like if new content ignores page rotation. Default value - false.

Parameters:

ignorePageRotationForContent - - true to ignore rotation of the new content on the rotated page.

setPageLabel

public PdfPage setPageLabel(PageLabelNumberingStyleConstants numberingStyle,
                            String labelPrefix)

This method adds or replaces a page label.

Parameters:

numberingStyle - The numbering style that shall be used for the numeric portion of each page label. May be NULL

labelPrefix - The label prefix for page labels in this range. May be NULL

Returns:

setPageLabel

public PdfPage setPageLabel(PageLabelNumberingStyleConstants numberingStyle,
                            String labelPrefix,
                            int firstPage)

This method adds or replaces a page label.

Parameters:

numberingStyle - The numbering style that shall be used for the numeric portion of each page label. May be NULL

labelPrefix - The label prefix for page labels in this range. May be NULL

firstPage - The value of the numeric portion for the first page label in the range. Must be greater or equal 1.

Returns:

put

public PdfPage put(PdfName key,
                   PdfObject value)

isPageRotationInverseMatrixWritten

public boolean isPageRotationInverseMatrixWritten()

This flag is meaningful for the case, when page rotation is applied and ignorePageRotationForContent is set to true. NOTE: It is needed for the internal usage.

This flag defines if inverse matrix (which rotates content into the opposite direction from page rotation direction in order to give the impression of the not rotated text) is already applied to the page content stream. See setIgnorePageRotationForContent(boolean)

Returns:

true, if inverse matrix is already applied, false otherwise.

setPageRotationInverseMatrixWritten

public void setPageRotationInverseMatrixWritten()

NOTE: For internal usage! Use this method only if you know what you are doing.

This method is called when inverse matrix (which rotates content into the opposite direction from page rotation direction in order to give the impression of the not rotated text) is applied to the page content stream. See setIgnorePageRotationForContent(boolean)

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.