KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > fop > extensions > Destination


1 /*
2  * $Id: Destination.java,v 1.1.2.3 2003/04/11 00:24:37 pietsch 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.extensions;
52
53 import org.apache.fop.apps.FOPException;
54 import org.apache.fop.fo.FObj;
55 import org.apache.fop.fo.PropertyList;
56
57 /**
58  * Provides support for PDF destinations, which allow external
59  * files to link into a particular place within the generated
60  * document.
61  *
62  * @author Stefan Wachter (based on work by Lloyd McKenzie)
63  */
64
65 public class Destination extends ExtensionObj {
66
67     private String JavaDoc internalDestination;
68     private String JavaDoc destinationName;
69
70     public static class Maker extends FObj.Maker {
71         public FObj make(FObj parent, PropertyList propertyList,
72                          String JavaDoc systemId, int line, int column)
73             throws FOPException {
74             return new Destination(parent, propertyList,
75                                    systemId, line, column);
76         }
77     }
78
79     public static FObj.Maker maker() {
80         return new Destination.Maker();
81     }
82
83     public Destination(FObj parent, PropertyList propertyList,
84                         String JavaDoc systemId, int line, int column) {
85         super(parent, propertyList, systemId, line, column);
86         internalDestination = properties.get("internal-destination").getString();
87         if (internalDestination.equals("")) {
88             log.warn("fox:destination requires an internal-destination.");
89         }
90         destinationName = properties.get("destination-name").getString();
91     }
92
93     /**
94      * Gets the name under which the destination may be referenced.
95      */
96     public String JavaDoc getDestinationName() {
97         // if no destination name is set then the internal destination is used as
98 // destination name
99 return !"".equals(destinationName) ? destinationName : internalDestination;
100     }
101
102     /**
103      * Gets the internal destination. The internal destination must be equal
104      * to the value of an id-attribute of some xsl:fo-Element.
105      */
106     public String JavaDoc getInternalDestination() {
107         return internalDestination;
108     }
109
110     public String JavaDoc getName() {
111         return "fox:destination";
112     }
113
114 }
115
Popular Tags