KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * $Id: Outline.java,v 1.4.2.6 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.*;
55
56 import java.util.*;
57
58 /**
59  * Class representing an outline entry (an /OUT object in a PDF file, but
60  * referred to as a "Bookmark" from within Adobe Acrobat).
61  */

62 public class Outline extends ExtensionObj {
63     private Label _label;
64     private ArrayList _outlines = new ArrayList();
65
66     private String JavaDoc _internalDestination;
67     private String JavaDoc _externalDestination;
68
69     /**
70      * The parent outline object if it exists
71      */

72     private Outline _parentOutline;
73
74     /**
75      * an opaque renderer context object, e.g. PDFOutline for PDFRenderer
76      */

77     private Object JavaDoc _rendererObject;
78
79
80     public static class Maker extends FObj.Maker {
81         public FObj make(FObj parent, PropertyList propertyList,
82                          String JavaDoc systemId, int line, int column)
83             throws FOPException {
84             return new Outline(parent, propertyList, systemId, line, column);
85         }
86
87     }
88
89     public static FObj.Maker maker() {
90         return new Outline.Maker();
91     }
92
93     public Outline(FObj parent, PropertyList propertyList,
94                    String JavaDoc systemId, int line, int column) {
95         super(parent, propertyList, systemId, line, column);
96
97         _internalDestination =
98             this.properties.get("internal-destination").getString();
99         _externalDestination =
100             this.properties.get("external-destination").getString();
101         if (_externalDestination != null &&!_externalDestination.equals("")) {
102             log.warn("fox:outline external-destination not supported currently.");
103         }
104
105         if (_internalDestination == null || _internalDestination.equals("")) {
106             log.warn("fox:outline requires an internal-destination.");
107         }
108
109         for (FONode node = getParent(); node != null;
110                 node = node.getParent()) {
111             if (node instanceof Outline) {
112                 _parentOutline = (Outline)node;
113                 break;
114             }
115         }
116
117     }
118
119     protected void addChild(FONode obj) {
120         if (obj instanceof Label) {
121             _label = (Label)obj;
122         } else if (obj instanceof Outline) {
123             _outlines.add(obj);
124         }
125         super.addChild(obj);
126     }
127
128
129     public void setRendererObject(Object JavaDoc o) {
130         _rendererObject = o;
131     }
132
133     public Object JavaDoc getRendererObject() {
134         return _rendererObject;
135     }
136
137     public Outline getParentOutline() {
138         return _parentOutline;
139     }
140
141     public Label getLabel() {
142         return _label == null ? new Label(this, this.properties,
143                                           systemId, line, column)
144             : _label;
145     }
146
147     public ArrayList getOutlines() {
148         return _outlines;
149     }
150
151     public String JavaDoc getInternalDestination() {
152         return _internalDestination;
153     }
154
155     public String JavaDoc getName() {
156         return "fop:outline";
157     }
158
159
160 }
161
162
Popular Tags