KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > fop > layout > AreaTree


1 /*
2  * $Id: AreaTree.java,v 1.13.2.5 2003/02/25 14:07:01 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.layout;
52
53 // FOP
54 import org.apache.fop.apps.FOPException;
55 import org.apache.fop.apps.StreamRenderer;
56 import org.apache.fop.datatypes.IDReferences;
57 import org.apache.fop.extensions.ExtensionObj;
58 import org.apache.fop.fo.pagination.PageSequence;
59
60 // Java
61 import java.io.IOException JavaDoc;
62 import java.util.ArrayList JavaDoc;
63
64 /*
65  * Modified by Mark Lillywhite, mark-fop@inomial.com. No longer keeps
66    a list of pages in the tree, instead these are passed to the
67    StreamRenderer. No longer keeps it's own list of IDReferences;
68    these are handled by StreamRenderer. In many ways StreamRenderer
69    has taken over from AreaTree and possibly this might be a better
70    place to deal with things in the future..?<P>
71    
72    Any extensions added to the AreaTree while generating a page
73    are given to the Page for the renderer to deal with.
74   */
75
76 public class AreaTree {
77
78     /**
79      * object containing information on available fonts, including
80      * metrics
81      */
82     FontInfo fontInfo;
83
84     /**
85      * List of root extension objects
86      */
87     ArrayList JavaDoc rootExtensions = null;
88
89     private StreamRenderer streamRenderer;
90
91     public AreaTree(StreamRenderer streamRenderer) {
92         this.streamRenderer = streamRenderer;
93     }
94
95     public void setFontInfo(FontInfo fontInfo) {
96         this.fontInfo = fontInfo;
97     }
98
99     public FontInfo getFontInfo() {
100         return this.fontInfo;
101     }
102
103     public void addPage(Page page)
104     throws FOPException {
105         try {
106             page.setExtensions(rootExtensions);
107             rootExtensions = null;
108             streamRenderer.queuePage(page);
109         } catch (IOException JavaDoc e) {
110             throw new FOPException(e);
111         }
112     }
113
114     public IDReferences getIDReferences() {
115         return streamRenderer.getIDReferences();
116     }
117
118     public void addExtension(ExtensionObj obj) {
119         if(rootExtensions ==null) {
120             rootExtensions = new ArrayList JavaDoc();
121         }
122         rootExtensions.add(obj);
123     }
124
125     // Auxillary function for retrieving markers.
126 public ArrayList JavaDoc getDocumentMarkers() {
127         return streamRenderer.getDocumentMarkers();
128     }
129
130     // Auxillary function for retrieving markers.
131 public PageSequence getCurrentPageSequence() {
132         return streamRenderer.getCurrentPageSequence();
133     }
134
135     // Auxillary function for retrieving markers.
136 public ArrayList JavaDoc getCurrentPageSequenceMarkers() {
137         return streamRenderer.getCurrentPageSequenceMarkers();
138     }
139 }
140
Popular Tags