Renderer


1   /*
2    * $Id: Renderer.java,v 1.19.2.7 2003/03/02 16:55:17 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.render;
52  
53  // FOP
54  import org.apache.fop.svg.SVGArea;
55  import org.apache.fop.image.ImageArea;
56  import org.apache.fop.apps.FOPException;
57  import org.apache.fop.layout.*;
58  import org.apache.fop.layout.inline.*;
59  import org.apache.fop.datatypes.IDReferences;
60  
61  // Avalon
62  import org.apache.avalon.framework.logger.Logger;
63  
64  // Java
65  import java.io.OutputStream  ;
66  import java.io.IOException  ;
67  
68  /**
69   * interface implement by all renderers.
70   *
71   * a Renderer implementation takes areas/spaces and produces output in
72   * some format.
73   */
74  public interface Renderer {
75  
76      /**
77       * Set the logger
78       */
79      void setLogger(Logger logger);
80  
81      /**
82       * set up the given FontInfo
83       */
84      void setupFontInfo(FontInfo fontInfo) throws FOPException;
85  
86      /**
87       * set up renderer options
88       */
89      void setOptions(java.util.Map   options);
90  
91      /**
92       * set the producer of the rendering
93       */
94      void setProducer(String   producer);
95  
96      /**
97       * render the given area tree to the given stream
98       */
99      //void render(AreaTree areaTree, OutputStream stream) throws IOException, FOPException;
100     void render(Page page, OutputStream   stream)
101         throws IOException  , FOPException;
102 
103     /**
104      * render the given area container
105      */
106     void renderAreaContainer(AreaContainer area);
107 
108     /**
109      * render the given area container
110      */
111     void renderBodyAreaContainer(BodyAreaContainer area);
112 
113     /**
114      * render the given region area container
115      */
116     void renderRegionAreaContainer(AreaContainer area);
117 
118     /**
119      * render the given span area
120      */
121     void renderSpanArea(SpanArea area);
122 
123     /**
124      * render the given block area
125      */
126     void renderBlockArea(BlockArea area);
127 
128     /**
129      * render the given display space
130      */
131     void renderDisplaySpace(DisplaySpace space);
132 
133     /**
134      * render the given SVG area
135      */
136     void renderSVGArea(SVGArea area);
137 
138     /**
139      * render a foreign object area
140      */
141     void renderForeignObjectArea(ForeignObjectArea area);
142 
143     /**
144      * render the given image area
145      */
146     void renderImageArea(ImageArea area);
147 
148     /**
149      * render the given inline area
150      */
151     void renderWordArea(WordArea area);
152 
153     /**
154      * render the given inline space
155      */
156     void renderInlineSpace(InlineSpace space);
157 
158     /**
159      * render the given line area
160      */
161     void renderLineArea(LineArea area);
162 
163     /**
164      * render the given page
165      */
166     void renderPage(Page page);
167 
168     /**
169      * render the given leader area
170      */
171     void renderLeaderArea(LeaderArea area);
172 
173     void startRenderer(OutputStream   outputStream)
174         throws IOException  ;
175 
176     void stopRenderer(OutputStream   outputStream)
177         throws IOException  ;
178 
179     IDReferences getIDReferences();
180 }
181
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags