1 /*
2 * $Id: PdfPage.java 3373 2008-05-12 16:21:24Z xlv $
3 *
4 * Copyright 1999, 2000, 2001, 2002 Bruno Lowagie
5 *
6 * The contents of this file are subject to the Mozilla Public License Version 1.1
7 * (the "License"); you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at http://www.mozilla.org/MPL/
9 *
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the License.
13 *
14 * The Original Code is 'iText, a free JAVA-PDF library'.
15 *
16 * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
17 * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
18 * All Rights Reserved.
19 * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
20 * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
21 *
22 * Contributor(s): all the names of the contributors are added in the source code
23 * where applicable.
24 *
25 * Alternatively, the contents of this file may be used under the terms of the
26 * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
27 * provisions of LGPL are applicable instead of those above. If you wish to
28 * allow use of your version of this file only under the terms of the LGPL
29 * License and not to allow others to use your version of this file under
30 * the MPL, indicate your decision by deleting the provisions above and
31 * replace them with the notice and other provisions required by the LGPL.
32 * If you do not delete the provisions above, a recipient may use your version
33 * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
34 *
35 * This library is free software; you can redistribute it and/or modify it
36 * under the terms of the MPL as stated above or under the terms of the GNU
37 * Library General Public License as published by the Free Software Foundation;
38 * either version 2 of the License, or any later version.
39 *
40 * This library is distributed in the hope that it will be useful, but WITHOUT
41 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
42 * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
43 * details.
44 *
45 * If you didn't download this code from the following link, you should check if
46 * you aren't using an obsolete version:
47 * http://www.lowagie.com/iText/
48 */
49
50 package com.lowagie.text.pdf;
51 import java.util.HashMap;
52 /**
53 * <CODE>PdfPage</CODE> is the PDF Page-object.
54 * <P>
55 * A Page object is a dictionary whose keys describe a single page containing text,
56 * graphics, and images. A Page object is a leaf of the Pages tree.<BR>
57 * This object is described in the 'Portable Document Format Reference Manual version 1.3'
58 * section 6.4 (page 73-81)
59 *
60 * @see PdfPages
61 */
62
63 public class PdfPage extends PdfDictionary {
64
65 private static final String boxStrings[] = {"crop", "trim", "art", "bleed"};
66 private static final PdfName boxNames[] = {PdfName.CROPBOX, PdfName.TRIMBOX, PdfName.ARTBOX, PdfName.BLEEDBOX};
67 // membervariables
68
69 /** value of the <B>Rotate</B> key for a page in PORTRAIT */
70 public static final PdfNumber PORTRAIT = new PdfNumber(0);
71
72 /** value of the <B>Rotate</B> key for a page in LANDSCAPE */
73 public static final PdfNumber LANDSCAPE = new PdfNumber(90);
74
75 /** value of the <B>Rotate</B> key for a page in INVERTEDPORTRAIT */
76 public static final PdfNumber INVERTEDPORTRAIT = new PdfNumber(180);
77
78 /** value of the <B>Rotate</B> key for a page in SEASCAPE */
79 public static final PdfNumber SEASCAPE = new PdfNumber(270);
80
81 /** value of the <B>MediaBox</B> key */
82 PdfRectangle mediaBox;
83
84 // constructors
85
86 /**
87 * Constructs a <CODE>PdfPage</CODE>.
88 *
89 * @param mediaBox a value for the <B>MediaBox</B> key
90 * @param resources an indirect reference to a <CODE>PdfResources</CODE>-object
91 * @param rotate a value for the <B>Rotate</B> key
92 */
93
94 // PdfPage(PdfRectangle mediaBox, Rectangle cropBox, PdfIndirectReference resources, PdfNumber rotate) {
95 // super(PAGE);
96 // this.mediaBox = mediaBox;
97 // put(PdfName.MEDIABOX, mediaBox);
98 // put(PdfName.RESOURCES, resources);
99 // if (rotate != null) {
100 // put(PdfName.ROTATE, rotate);
101 // }
102 // if (cropBox != null)
103 // put(PdfName.CROPBOX, new PdfRectangle(cropBox));
104 // }
105
106 /**
107 * Constructs a <CODE>PdfPage</CODE>.
108 *
109 * @param mediaBox a value for the <B>MediaBox</B> key
110 * @param resources an indirect reference to a <CODE>PdfResources</CODE>-object
111 * @param rotate a value for the <B>Rotate</B> key
112 */
113
114 PdfPage(PdfRectangle mediaBox, HashMap boxSize, PdfDictionary resources, int rotate) {
115 super(PAGE);
116 this.mediaBox = mediaBox;
117 put(PdfName.MEDIABOX, mediaBox);
118 put(PdfName.RESOURCES, resources);
119 if (rotate != 0) {
120 put(PdfName.ROTATE, new PdfNumber(rotate));
121 }
122 for (int k = 0; k < boxStrings.length; ++k) {
123 PdfObject rect = (PdfObject)boxSize.get(boxStrings[k]);
124 if (rect != null)
125 put(boxNames[k], rect);
126 }
127 }
128
129 /**
130 * Constructs a <CODE>PdfPage</CODE>.
131 *
132 * @param mediaBox a value for the <B>MediaBox</B> key
133 * @param resources an indirect reference to a <CODE>PdfResources</CODE>-object
134 */
135
136 // PdfPage(PdfRectangle mediaBox, Rectangle cropBox, PdfIndirectReference resources) {
137 // this(mediaBox, cropBox, resources, null);
138 // }
139
140 /**
141 * Constructs a <CODE>PdfPage</CODE>.
142 *
143 * @param mediaBox a value for the <B>MediaBox</B> key
144 * @param resources an indirect reference to a <CODE>PdfResources</CODE>-object
145 */
146
147 PdfPage(PdfRectangle mediaBox, HashMap boxSize, PdfDictionary resources) {
148 this(mediaBox, boxSize, resources, 0);
149 }
150
151 /**
152 * Checks if this page element is a tree of pages.
153 * <P>
154 * This method always returns <CODE>false</CODE>.
155 *
156 * @return <CODE>false</CODE> because this is a single page
157 */
158
159 public boolean isParent() {
160 return false;
161 }
162
163 // methods
164
165 /**
166 * Adds an indirect reference pointing to a <CODE>PdfContents</CODE>-object.
167 *
168 * @param contents an indirect reference to a <CODE>PdfContents</CODE>-object
169 */
170
171 void add(PdfIndirectReference contents) {
172 put(PdfName.CONTENTS, contents);
173 }
174
175 /**
176 * Rotates the mediabox, but not the text in it.
177 *
178 * @return a <CODE>PdfRectangle</CODE>
179 */
180
181 PdfRectangle rotateMediaBox() {
182 this.mediaBox = mediaBox.rotate();
183 put(PdfName.MEDIABOX, this.mediaBox);
184 return this.mediaBox;
185 }
186
187 /**
188 * Returns the MediaBox of this Page.
189 *
190 * @return a <CODE>PdfRectangle</CODE>
191 */
192
193 PdfRectangle getMediaBox() {
194 return mediaBox;
195 }
196 }