KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > fop > pdf > PDFPages


1 /*
2  * $Id: PDFPages.java,v 1.12.2.4 2003/02/25 14:29:37 jeremias Exp $
3  * ============================================================================
4  * The Apache Software License, Version 1.1
5  * ============================================================================
6  *
7  * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without modifica-
10  * tion, are permitted provided that the following conditions are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright notice,
13  * this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright notice,
16  * this list of conditions and the following disclaimer in the documentation
17  * and/or other materials provided with the distribution.
18  *
19  * 3. The end-user documentation included with the redistribution, if any, must
20  * include the following acknowledgment: "This product includes software
21  * developed by the Apache Software Foundation (http://www.apache.org/)."
22  * Alternately, this acknowledgment may appear in the software itself, if
23  * and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. The names "FOP" and "Apache Software Foundation" must not be used to
26  * endorse or promote products derived from this software without prior
27  * written permission. For written permission, please contact
28  * apache@apache.org.
29  *
30  * 5. Products derived from this software may not be called "Apache", nor may
31  * "Apache" appear in their name, without prior written permission of the
32  * Apache Software Foundation.
33  *
34  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
35  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
36  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
37  * APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
38  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
39  * DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
40  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
41  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
42  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
43  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44  * ============================================================================
45  *
46  * This software consists of voluntary contributions made by many individuals
47  * on behalf of the Apache Software Foundation and was originally created by
48  * James Tauber <jtauber@jtauber.com>. For more information on the Apache
49  * Software Foundation, please see <http://www.apache.org/>.
50  */
51 package org.apache.fop.pdf;
52
53 // Java
54 import java.io.UnsupportedEncodingException JavaDoc;
55 import java.util.ArrayList JavaDoc;
56
57 /**
58  * class representing a /Pages object.
59  *
60  * A /Pages object is an ordered collection of pages (/Page objects)
61  * (Actually, /Pages can contain further /Pages as well but this
62  * implementation doesn't allow this)
63  */
64 public class PDFPages extends PDFObject {
65
66     /**
67      * the /Page objects
68      */
69     protected ArrayList JavaDoc kids = new ArrayList JavaDoc();
70
71     /**
72      * the number of /Page objects
73      */
74     protected int count = 0;
75
76     // private PDFPages parent;
77
78     /**
79      * create a /Pages object. NOTE: The PDFPages
80      * object must be created before the PDF document is
81      * generated, but it is not written to the stream immediately.
82      * It must aslo be allocated an object ID (so that the kids
83      * can refer to the parent) so that the XRef table needs to
84      * be updated before this object is written.
85      *
86      * @param number the object's number
87      */
88     public PDFPages(int number) {
89         super(number);
90     }
91
92     /**
93      * add a /Page object.
94      *
95      * @param page the PDFPage to add.
96      */
97     public void addPage(PDFPage page) {
98         this.kids.add(page.referencePDF());
99         page.setParent(this);
100         this.incrementCount();
101     }
102
103     /**
104      * get the count of /Page objects
105      *
106      * @return the number of pages
107      */
108     public int getCount() {
109         return this.count;
110     }
111
112     /**
113      * increment the count of /Page objects
114      */
115     public void incrementCount() {
116         this.count++;
117         // MessageHandler.logln("Incrementing count to " + this.getCount());
118 }
119
120     /**
121      * represent the object in PDF
122      *
123      * @return the PDF string
124      */
125     public byte[] toPDF() {
126         StringBuffer JavaDoc p = new StringBuffer JavaDoc(this.number + " " + this.generation
127                                           + " obj\n<< /Type /Pages\n/Count "
128                                           + this.getCount() + "\n/Kids [");
129         for (int i = 0; i < kids.size(); i++) {
130             p = p.append(kids.get(i) + " ");
131         }
132         p = p.append("] >>\nendobj\n");
133
134         try {
135             return p.toString().getBytes(PDFDocument.ENCODING);
136         } catch (UnsupportedEncodingException JavaDoc ue) {
137             return p.toString().getBytes();
138         }
139     }
140
141 }
142
Popular Tags