KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * $Id: PDFRoot.java,v 1.10.2.3 2003/02/25 14:29:38 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.*;
56
57 /**
58  * class representing a Root (/Catalog) object
59  */
60 public class PDFRoot extends PDFObject {
61
62     /**
63      * the /Pages object that is root of the Pages hierarchy
64      */
65     protected PDFPages rootPages;
66
67     /**
68      * Root outline object
69      */
70     private PDFOutline _outline;
71
72     /**
73      * Collection of destinations
74      */
75     private Collection _destinations;
76
77     /**
78      * create a Root (/Catalog) object. NOTE: The PDFRoot
79      * object must be created before the PDF document is
80      * generated, but it is not assigned an object ID until
81      * it is about to be written (immediately before the xref
82      * table as part of the trsailer). (mark-fop@inomial.com)
83      *
84      * @param number the object's number
85      */
86     public PDFRoot(int number, PDFPages pages) {
87         super(number);
88         setRootPages(pages);
89     }
90
91     /**
92      * Before the root is written to the document stream,
93      * make sure it's object number is set. Package-private access
94      * only; outsiders should not be fiddling with this stuff.
95      */
96     void setNumber(int number) {
97         this.number = number;
98     }
99
100     /**
101      * add a /Page object to the root /Pages object
102      *
103      * @param page the /Page object to add
104      */
105     public void addPage(PDFPage page) {
106         this.rootPages.addPage(page);
107     }
108
109     /**
110      * set the root /Pages object
111      *
112      * @param pages the /Pages object to set as root
113      */
114     public void setRootPages(PDFPages pages) {
115         this.rootPages = pages;
116     }
117
118     public void setRootOutline(PDFOutline outline) {
119         _outline = outline;
120     }
121
122     public PDFOutline getRootOutline() {
123         return _outline;
124     }
125
126     public Collection getDestinations() {
127         if (_destinations == null) {
128             _destinations = new ArrayList();
129         }
130         return _destinations;
131     }
132  
133
134     /**
135      * represent the object as PDF.
136      *
137      * @throws IllegalStateException if the setNumber() method has
138      * not been called.
139      *
140      * @return the PDF string
141      */
142     public byte[] toPDF()
143     throws IllegalStateException JavaDoc {
144         StringBuffer JavaDoc p = new StringBuffer JavaDoc(this.number + " " + this.generation
145                                           + " obj\n<< /Type /Catalog\n/Pages "
146                                           + this.rootPages.referencePDF()
147                                           + "\n");
148         if (_outline != null) {
149             p.append(" /Outlines " + _outline.referencePDF() + "\n");
150             p.append(" /PageMode /UseOutlines\n");
151
152         }
153         if (_destinations != null) {
154            p.append(" /Names << /Dests << /Names [ ");
155           for (Iterator i = _destinations.iterator(); i.hasNext(); ) {
156               PDFDestination dest = (PDFDestination)i.next();
157               p.append(dest.toPDF());
158            }
159            p.append(" ] >> >>\n");
160         }
161         p.append(" >>\nendobj\n");
162
163         try {
164             return p.toString().getBytes(PDFDocument.ENCODING);
165         } catch (UnsupportedEncodingException JavaDoc ue) {
166             return p.toString().getBytes();
167         }
168     }
169
170 }
171
Popular Tags