KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * $Id: PDFGoToRemote.java,v 1.3.2.3 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
56 /**
57  * class representing a /GoToR object.
58  */
59 public class PDFGoToRemote extends PDFAction {
60
61     /**
62      * the file specification
63      */
64     protected PDFFileSpec pdfFileSpec;
65     protected int pageReference = 0;
66     protected String JavaDoc destination = null;
67
68     /**
69      * create an GoToR object.
70      *
71      * @param number the object's number
72      * @param fileSpec the fileSpec associated with the action
73      */
74     public PDFGoToRemote(int number, PDFFileSpec pdfFileSpec) {
75
76         /* generic creation of object */
77         super(number);
78
79         this.pdfFileSpec = pdfFileSpec;
80     }
81
82     /**
83      * create an GoToR object.
84      *
85      * @param number the object's number
86      * @param fileSpec the fileSpec associated with the action
87      * @param page a page reference within the remote document
88      */
89     public PDFGoToRemote(int number, PDFFileSpec pdfFileSpec, int page) {
90
91         /* generic creation of object */
92         super(number);
93
94         this.pdfFileSpec = pdfFileSpec;
95         this.pageReference = page;
96     }
97
98     /**
99      * create an GoToR object.
100      *
101      * @param number the object's number
102      * @param fileSpec the fileSpec associated with the action
103      * @param dest a named destination within the remote document
104      */
105     public PDFGoToRemote(int number, PDFFileSpec pdfFileSpec, String JavaDoc dest) {
106
107         /* generic creation of object */
108         super(number);
109
110         this.pdfFileSpec = pdfFileSpec;
111         this.destination = dest;
112     }
113
114     /**
115      * return the action string which will reference this object
116      *
117      * @return the action String
118      */
119     public String JavaDoc getAction() {
120         return this.referencePDF();
121     }
122
123     /**
124      * represent the object in PDF
125      *
126      * @return the PDF string
127      */
128     public byte[] toPDF() {
129         String JavaDoc p = new String JavaDoc(this.number + " " + this.generation + " obj\n"
130                               + "<<\n/S /GoToR\n" + "/F "
131                               + pdfFileSpec.referencePDF() + "\n");
132         
133         if (destination != null) {
134             p += "/D (" + this.destination + ")";
135         } else {
136             p += "/D [ " + this.pageReference + " /XYZ null null null ]";
137         }
138
139         p += " \n>>\nendobj\n";
140
141         try {
142             return p.getBytes(PDFDocument.ENCODING);
143         } catch (UnsupportedEncodingException JavaDoc ue) {
144             return p.getBytes();
145         }
146     }
147
148
149     /*
150      * example
151      * 28 0 obj
152      * <<
153      * /S /GoToR
154      * /F 29 0 R
155      * /D [ 0 /XYZ -6 797 null ]
156      * >>
157      * endobj
158      */
159 }
160
Popular Tags