com.lowagie.text.pdf: public class: PdfPage

com.lowagie.text.pdf
public class: PdfPage [javadoc | source]

java.lang.Object
   com.lowagie.text.pdf.PdfObject
      com.lowagie.text.pdf.PdfDictionary
         com.lowagie.text.pdf.PdfPage

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 object 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)

Also see:

PdfPages

Field Summary
public static final PdfNumber	PORTRAIT	value of the Rotate key for a page in PORTRAIT
public static final PdfNumber	LANDSCAPE	value of the Rotate key for a page in LANDSCAPE
public static final PdfNumber	INVERTEDPORTRAIT	value of the Rotate key for a page in INVERTEDPORTRAIT
public static final PdfNumber	SEASCAPE	value of the Rotate key for a page in SEASCAPE
PdfRectangle	mediaBox	value of the MediaBox key

Fields inherited from com.lowagie.text.pdf.PdfDictionary:
FONT, OUTLINES, PAGE, PAGES, CATALOG, hashMap

Fields inherited from com.lowagie.text.pdf.PdfObject:
BOOLEAN, NUMBER, STRING, NAME, ARRAY, DICTIONARY, STREAM, NULL, INDIRECT, NOTHING, TEXT_PDFDOCENCODING, TEXT_UNICODE, bytes, type, indRef

Constructor:

Constructor:
PdfPage(PdfRectangle mediaBox, HashMap boxSize, PdfDictionary resources) { this(mediaBox, boxSize, resources, 0); } Constructs a `PdfPage`. Parameters: `mediaBox` - a value for the MediaBox key `resources` - an indirect reference to a `PdfResources`-object
PdfPage(PdfRectangle mediaBox, HashMap boxSize, PdfDictionary resources, int rotate) { // constructors // PdfPage(PdfRectangle mediaBox, Rectangle cropBox, PdfIndirectReference resources, PdfNumber rotate) { // super(PAGE); // this.mediaBox = mediaBox; // put(PdfName.MEDIABOX, mediaBox); // put(PdfName.RESOURCES, resources); // if (rotate != null) { // put(PdfName.ROTATE, rotate); // } // if (cropBox != null) // put(PdfName.CROPBOX, new PdfRectangle(cropBox)); // } super(PAGE); this.mediaBox = mediaBox; put(PdfName.MEDIABOX, mediaBox); put(PdfName.RESOURCES, resources); if (rotate != 0) { put(PdfName.ROTATE, new PdfNumber(rotate)); } for (int k = 0; k < boxStrings.length; ++k) { PdfObject rect = (PdfObject)boxSize.get(boxStrings[k]); if (rect != null) put(boxNames[k], rect); } } 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(PdfRectangle mediaBox,
    HashMap boxSize,
    PdfDictionary resources) {
        this(mediaBox, boxSize, resources, 0);
}

PdfPage

Parameters:

mediaBox - a value for the MediaBox key

resources - an indirect reference to a PdfResources-object

 PdfPage(PdfRectangle mediaBox,
    HashMap boxSize,
    PdfDictionary resources,
    int rotate) {
    
    // constructors
//    PdfPage(PdfRectangle mediaBox, Rectangle cropBox, PdfIndirectReference resources, PdfNumber rotate) {
//        super(PAGE);
//        this.mediaBox = mediaBox;
//        put(PdfName.MEDIABOX, mediaBox);
//        put(PdfName.RESOURCES, resources);
//        if (rotate != null) {
//            put(PdfName.ROTATE, rotate);
//        }
//        if (cropBox != null)
//            put(PdfName.CROPBOX, new PdfRectangle(cropBox));
//    }
        super(PAGE);
        this.mediaBox = mediaBox;
        put(PdfName.MEDIABOX, mediaBox);
        put(PdfName.RESOURCES, resources);
        if (rotate != 0) {
            put(PdfName.ROTATE, new PdfNumber(rotate));
        }
        for (int k = 0; k <  boxStrings.length; ++k) {
            PdfObject rect = (PdfObject)boxSize.get(boxStrings[k]);
            if (rect != null)
                put(boxNames[k], rect);
        }
}

PdfPage

Parameters:

mediaBox - a value for the MediaBox key

resources - an indirect reference to a PdfResources-object

rotate - a value for the Rotate key

Method from com.lowagie.text.pdf.PdfPage Summary:
add, getMediaBox, isParent, rotateMediaBox

Methods from com.lowagie.text.pdf.PdfDictionary:
contains, get, getAsArray, getAsBoolean, getAsDict, getAsIndirectObject, getAsName, getAsNumber, getAsStream, getAsString, getDirectObject, getKeys, isCatalog, isFont, isOutlineTree, isPage, isPages, merge, mergeDifferent, put, putAll, putEx, remove, size, toPdf, toString

Methods from com.lowagie.text.pdf.PdfObject:
canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, toPdf, toString, type

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from com.lowagie.text.pdf.PdfPage Detail:
void add(PdfIndirectReference contents) { put(PdfName.CONTENTS, contents); } Adds an indirect reference pointing to a `PdfContents`-object.
PdfRectangle getMediaBox() { return mediaBox; } Returns the MediaBox of this Page.
public boolean isParent() { return false; } Checks if this page element is a tree of pages. This method always returns `false`.
PdfRectangle rotateMediaBox() { this.mediaBox = mediaBox.rotate(); put(PdfName.MEDIABOX, this.mediaBox); return this.mediaBox; } Rotates the mediabox, but not the text in it.

Method from com.lowagie.text.pdf.PdfPage Detail:

  void add(PdfIndirectReference contents) {
        put(PdfName.CONTENTS, contents);
}

PdfContents

 PdfRectangle getMediaBox() {
        return mediaBox;
}

Returns the MediaBox of this Page.

 public boolean isParent() {
        return false;
}

This method always returns false.

 PdfRectangle rotateMediaBox() {
        this.mediaBox =  mediaBox.rotate();
        put(PdfName.MEDIABOX, this.mediaBox);
        return this.mediaBox;
}

Rotates the mediabox, but not the text in it.