KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * $Id: PDFDestination.java,v 1.1.2.2 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 import org.apache.fop.datatypes.IDReferences;
54
55 /**
56  * This represents a single destination object in a PDF. Destinations allow
57  * specific locations within a PDF document to be referenced by other PDF
58  * documents (e.g. to link to a location within a document.)
59  *
60  * @author Stefan Wachter (based on work by Lloyd McKenzie)
61  *
62  */
63 public class PDFDestination {
64
65     /**
66      * References that are used to resolve the destination.
67      */
68     private IDReferences _idReferences;
69
70     /**
71      * the name that is used to reference the destination
72      */
73     private String JavaDoc _destinationName;
74
75     /**
76      * id of the internal destination that is referenced
77      */
78     private String JavaDoc _internalDestination;
79
80     /**
81      * @param idReferences the id nodes container that is used to resolve the
82      * internal destination
83      * @param destinationName the name under which this destination is referenced
84      * @param internalDestination the internal destination that is referenced
85      */
86     public PDFDestination(IDReferences idReferences, String JavaDoc destinationName, String JavaDoc internalDestination) {
87         _idReferences = idReferences;
88         _destinationName = destinationName;
89         _internalDestination = internalDestination;
90     }
91
92     /**
93      * Represent the object in PDF. Outputs a key/value pair in a name tree structure.
94      * The key is the destination name the value is an array addressing the corresponding
95      * page/position.
96      */
97     protected String JavaDoc toPDF() {
98         StringBuffer JavaDoc result = new StringBuffer JavaDoc();
99         String JavaDoc destinationRef = _idReferences.getDestinationRef(_internalDestination);
100         result.append(" (" + _destinationName + ") ").append(destinationRef);
101         return result.toString();
102     }
103
104 }
Popular Tags