KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * $Id: PDFGoTo.java,v 1.6.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 /GoTo object.
58  *
59  */

60 public class PDFGoTo extends PDFAction {
61
62     /**
63      * the pageReference
64      */

65     protected String JavaDoc pageReference;
66     protected String JavaDoc destination = null;
67     protected float xPosition = 0, yPosition = 0;
68
69     /**
70      * create a /GoTo object.
71      *
72      * @param number the object's number
73      * @param pageReference the pageReference represented by this object
74      */

75     public PDFGoTo(int number, String JavaDoc pageReference) {
76
77         /* generic creation of object */
78         super(number);
79
80         this.pageReference = pageReference;
81     }
82
83
84     /**
85      * Sets page reference after object has been created
86      *
87      * @param pageReference
88      * the new page reference to use
89      */

90     public void setPageReference(String JavaDoc pageReference) {
91         this.pageReference = pageReference;
92     }
93
94     public String JavaDoc getPageReference() {
95       return pageReference;
96     }
97
98     /**
99      * Sets the Y position to jump to
100      *
101      * @param yPosition y position
102      */

103     public void setYPosition(int yPosition) {
104         this.yPosition = (yPosition / 1000f);
105     }
106
107     public void setDestination(String JavaDoc dest) {
108         destination = dest;
109     }
110
111     /**
112      * Sets the x Position to jump to
113      *
114      * @param xPosition x position
115      */

116     public void setXPosition(int xPosition) {
117         this.xPosition = (xPosition / 1000f);
118     }
119
120     public String JavaDoc getAction() {
121         return referencePDF();
122     }
123
124
125     /**
126      * represent the object in PDF
127      *
128      * @return the PDF string
129      */

130     public byte[] toPDF() {
131         if(destination == null) {
132             destination = "/D ["
133                               + this.pageReference + " /XYZ " + xPosition
134                               + " " + yPosition + " null]\n";
135         } else {
136             destination = "/D ["
137                               + this.pageReference + " " + destination + "]\n";
138         }
139         String JavaDoc p = new String JavaDoc(this.number + " " + this.generation
140                               + " obj\n<<\n/S /GoTo\n" + destination
141                               + ">>\nendobj\n");
142                               
143         try {
144             return p.getBytes(PDFDocument.ENCODING);
145         } catch (UnsupportedEncodingException JavaDoc ue) {
146             return p.getBytes();
147         }
148     }
149
150     /*
151      * example
152      * 29 0 obj
153      * <<
154      * /S /GoTo
155      * /D [23 0 R /FitH 600]
156      * >>
157      * endobj
158      */

159 }
160
Popular Tags