KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * $Id: PDFAnnotList.java,v 1.3.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 an object which is a list of annotations.
59  *
60  * This PDF object is a list of references to /Annot objects. So far we
61  * are dealing only with links.
62  */
63 public class PDFAnnotList extends PDFObject {
64
65     /**
66      * the /Annot objects
67      */
68     protected ArrayList JavaDoc links = new ArrayList JavaDoc();
69
70     /**
71      * the number of /Annot objects
72      */
73     protected int count = 0;
74
75     /**
76      * create a /Annots object.
77      *
78      * @param number the object's number
79      */
80     public PDFAnnotList(int number) {
81
82         /* generic creation of object */
83         super(number);
84     }
85
86     /**
87      * add an /Annot object of /Subtype /Link.
88      *
89      * @param link the PDFLink to add.
90      */
91     public void addLink(PDFLink link) {
92         this.links.add(link);
93         this.count++;
94     }
95
96     /**
97      * get the count of /Annot objects
98      *
99      * @return the number of links
100      */
101     public int getCount() {
102         return this.count;
103     }
104
105     /**
106      * represent the object in PDF
107      *
108      * @return the PDF string
109      */
110     public byte[] toPDF() {
111         StringBuffer JavaDoc p = new StringBuffer JavaDoc(this.number + " " + this.generation
112                                           + " obj\n[\n");
113         for (int i = 0; i < this.count; i++) {
114             p = p.append(((PDFObject)links.get(i)).referencePDF()
115                          + "\n");
116         }
117         p = p.append("]\nendobj\n");
118
119         try {
120             return p.toString().getBytes(PDFDocument.ENCODING);
121         } catch (UnsupportedEncodingException JavaDoc ue) {
122             return p.toString().getBytes();
123         }
124     }
125
126     /*
127      * example
128      * 20 0 obj
129      * [
130      * 19 0 R
131      * ]
132      * endobj
133      */
134 }
135
Popular Tags