com.itextpdf.text.pdf.PdfPage Maven / Gradle / Ivy
Show all versions of itextpdf Show documentation
/*
* $Id: 5410f674c28f9265f334f0a432a05e7dbd280834 $
*
* This file is part of the iText (R) project.
* Copyright (c) 1998-2015 iText Group NV
* Authors: Bruno Lowagie, Paulo Soares, et al.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License version 3
* as published by the Free Software Foundation with the addition of the
* following permission added to Section 15 as permitted in Section 7(a):
* FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
* ITEXT GROUP. ITEXT GROUP DISCLAIMS THE WARRANTY OF NON INFRINGEMENT
* OF THIRD PARTY RIGHTS
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Affero General Public License for more details.
* You should have received a copy of the GNU Affero General Public License
* along with this program; if not, see http://www.gnu.org/licenses or write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA, 02110-1301 USA, or download the license from the following URL:
* http://itextpdf.com/terms-of-use/
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU Affero General Public License.
*
* In accordance with Section 7(b) of the GNU Affero General Public License,
* a covered work must retain the producer line in every PDF that is created
* or manipulated using iText.
*
* You can be released from the requirements of the license by purchasing
* a commercial license. Buying such a license is mandatory as soon as you
* develop commercial activities involving the iText software without
* disclosing the source code of your own applications.
* These activities include: offering paid services to customers as an ASP,
* serving PDFs on the fly in a web application, shipping iText with a closed
* source product.
*
* For more information, please contact iText Software Corp. at this
* address: [email protected]
*/
package com.itextpdf.text.pdf;
import java.util.HashMap;
import com.itextpdf.text.DocumentException;
import com.itextpdf.text.error_messages.MessageLocalization;
/**
* 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)
*
* @see PdfPages
*/
public class PdfPage extends PdfDictionary {
private static final String boxStrings[] = {"crop", "trim", "art", "bleed"};
private static final PdfName boxNames[] = {PdfName.CROPBOX, PdfName.TRIMBOX, PdfName.ARTBOX, PdfName.BLEEDBOX};
// membervariables
/** value of the Rotate key for a page in PORTRAIT */
public static final PdfNumber PORTRAIT = new PdfNumber(0);
/** value of the Rotate key for a page in LANDSCAPE */
public static final PdfNumber LANDSCAPE = new PdfNumber(90);
/** value of the Rotate key for a page in INVERTEDPORTRAIT */
public static final PdfNumber INVERTEDPORTRAIT = new PdfNumber(180);
/** value of the Rotate key for a page in SEASCAPE */
public static final PdfNumber SEASCAPE = new PdfNumber(270);
/** value of the MediaBox key */
PdfRectangle mediaBox;
// constructors
/**
* Constructs a PdfPage.
*
* @param mediaBox a value for the MediaBox key
* @param resources an indirect reference to a PdfResources-object
* @param rotate a value for the Rotate key
* @throws DocumentException
*/
PdfPage(PdfRectangle mediaBox, HashMap boxSize, PdfDictionary resources, int rotate) throws DocumentException {
super(PAGE);
this.mediaBox = mediaBox;
if (mediaBox != null && (mediaBox.width() > 14400 || mediaBox.height() > 14400)) {
throw new DocumentException(MessageLocalization.getComposedMessage("the.page.size.must.be.smaller.than.14400.by.14400.its.1.by.2", mediaBox.width(), mediaBox.height()));
}
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 = boxSize.get(boxStrings[k]);
if (rect != null)
put(boxNames[k], rect);
}
}
/**
* Constructs a PdfPage.
*
* @param mediaBox a value for the MediaBox key
* @param resources an indirect reference to a PdfResources-object
* @throws DocumentException
*/
PdfPage(PdfRectangle mediaBox, HashMap boxSize, PdfDictionary resources) throws DocumentException {
this(mediaBox, boxSize, resources, 0);
}
/**
* Checks if this page element is a tree of pages.
*
* This method always returns false.
*
* @return false because this is a single page
*/
public boolean isParent() {
return false;
}
// methods
/**
* Adds an indirect reference pointing to a PdfContents-object.
*
* @param contents an indirect reference to a PdfContents-object
*/
void add(PdfIndirectReference contents) {
put(PdfName.CONTENTS, contents);
}
/**
* Rotates the mediabox, but not the text in it.
*
* @return a PdfRectangle
*/
PdfRectangle rotateMediaBox() {
this.mediaBox = mediaBox.rotate();
put(PdfName.MEDIABOX, this.mediaBox);
return this.mediaBox;
}
/**
* Returns the MediaBox of this Page.
*
* @return a PdfRectangle
*/
PdfRectangle getMediaBox() {
return mediaBox;
}
}