Class PdfPage

java.lang.Object

com.gitlab.pdftk_java.com.lowagie.text.pdf.PdfObject

com.gitlab.pdftk_java.com.lowagie.text.pdf.PdfDictionary

com.gitlab.pdftk_java.com.lowagie.text.pdf.PdfPage

public class PdfPage
extends PdfDictionary

PdfPage is the PDF Page-object.

A Page object is a dictionary whose keys describe a single page containing text, graphics, and images. A Page onjects is a leaf of the Pages tree.
This object is described in the 'Portable Document Format Reference Manual version 1.3' section 6.4 (page 73-81)

See Also:

• PdfPageElement
• PdfPages

Field Summary

Fields

Modifier and Type	Field	Description
private static final PdfName[]	boxNames
private static final String[]	boxStrings
static final PdfNumber	INVERTEDPORTRAIT	value of the Rotate key for a page in INVERTEDPORTRAIT
static final PdfNumber	LANDSCAPE	value of the Rotate key for a page in LANDSCAPE
(package private) PdfRectangle	mediaBox	value of the MediaBox key
static final PdfNumber	PORTRAIT	value of the Rotate key for a page in PORTRAIT
static final PdfNumber	SEASCAPE	value of the Rotate key for a page in SEASCAPE

Fields inherited from class PdfDictionary

CATALOG, FONT, hashMap, OUTLINES, PAGE, PAGES

Fields inherited from class PdfObject

ARRAY, BOOLEAN, bytes, DICTIONARY, INDIRECT, indRef, m_NULL, NAME, NOTHING, NUMBER, STREAM, STRING, TEXT_PDFDOCENCODING, TEXT_UNICODE, type

Constructor Summary

Constructors

Constructor	Description
PdfPage(PdfRectangle mediaBox, HashMap boxSize, PdfDictionary resources)	Constructs a PdfPage.
PdfPage(PdfRectangle mediaBox, HashMap boxSize, PdfDictionary resources, int rotate)	Constructs a PdfPage.

Method Summary

Modifier and Type	Method	Description
(package private) void	add(PdfIndirectReference contents)	Adds an indirect reference pointing to a PdfContents-object.
(package private) PdfRectangle	getMediaBox()	Returns the MediaBox of this Page.
boolean	isParent()	Checks if this page element is a tree of pages.
(package private) PdfRectangle	rotateMediaBox()	Rotates the mediabox, but not the text in it.

Methods inherited from class PdfDictionary

contains, get, getAsArray, getAsBoolean, getAsDict, getAsIndirectObject, getAsName, getAsNumber, getAsStream, getAsString, getDirectObject, getKeys, isCatalog, isDictionaryType, isFont, isOutlineTree, isPage, isPages, merge, mergeDifferent, put, putAll, putDel, putEx, remove, size, toPdf

Methods inherited from class PdfObject

canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, toString, type

Methods inherited from class Object

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

Field Details

boxStrings

private static final String[] boxStrings

boxNames

private static final PdfName[] boxNames

PORTRAIT

public static final PdfNumber PORTRAIT

value of the Rotate key for a page in PORTRAIT

LANDSCAPE

public static final PdfNumber LANDSCAPE

value of the Rotate key for a page in LANDSCAPE

INVERTEDPORTRAIT

public static final PdfNumber INVERTEDPORTRAIT

value of the Rotate key for a page in INVERTEDPORTRAIT

SEASCAPE

public static final PdfNumber SEASCAPE

value of the Rotate key for a page in SEASCAPE

mediaBox

PdfRectangle mediaBox

value of the MediaBox key

Constructor Details

PdfPage

PdfPage(PdfRectangle mediaBox,
 HashMap boxSize,
 PdfDictionary resources,
 int rotate)

Constructs a PdfPage.

Parameters:

mediaBox - a value for the MediaBox key

resources - an indirect reference to a PdfResources-object

rotate - a value for the Rotate key

PdfPage

PdfPage(PdfRectangle mediaBox,
 HashMap boxSize,
 PdfDictionary resources)

Constructs a PdfPage.

Parameters:

mediaBox - a value for the MediaBox key

resources - an indirect reference to a PdfResources-object

Method Details

isParent

public boolean isParent()

Checks if this page element is a tree of pages.

This method allways returns false.

Returns:

false because this is a single page

add

void add(PdfIndirectReference contents)

Adds an indirect reference pointing to a PdfContents-object.

Parameters:

contents - an indirect reference to a PdfContents-object

rotateMediaBox

PdfRectangle rotateMediaBox()

Rotates the mediabox, but not the text in it.

Returns:

a PdfRectangle

getMediaBox

PdfRectangle getMediaBox()

Returns the MediaBox of this Page.

Returns:

a PdfRectangle