1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
|
/*
* $Id: Renderer.java,v 1.31 2003/03/07 09:46:33 jeremias Exp $
* ============================================================================
* The Apache Software License, Version 1.1
* ============================================================================
*
* Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modifica-
* tion, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 3. The end-user documentation included with the redistribution, if any, must
* include the following acknowledgment: "This product includes software
* developed by the Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself, if
* and wherever such third-party acknowledgments normally appear.
*
* 4. The names "FOP" and "Apache Software Foundation" must not be used to
* endorse or promote products derived from this software without prior
* written permission. For written permission, please contact
* apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache", nor may
* "Apache" appear in their name, without prior written permission of the
* Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
* DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* ============================================================================
*
* This software consists of voluntary contributions made by many individuals
* on behalf of the Apache Software Foundation and was originally created by
* James Tauber <jtauber@jtauber.com>. For more information on the Apache
* Software Foundation, please see <http://www.apache.org/>.
*/
package org.apache.fop.render;
// Java
import java.io.OutputStream;
import java.io.IOException;
import java.util.Map;
// FOP
import org.apache.fop.apps.FOPException;
import org.apache.fop.area.PageViewport;
import org.apache.fop.area.Title;
import org.apache.fop.area.TreeExt;
import org.apache.fop.area.inline.Container;
import org.apache.fop.area.inline.InlineParent;
import org.apache.fop.area.inline.Leader;
import org.apache.fop.area.inline.Space;
import org.apache.fop.area.inline.Viewport;
import org.apache.fop.area.inline.Word;
import org.apache.fop.control.Document;
import org.apache.fop.fo.FOUserAgent;
/**
* Interface implemented by all renderers. This interface is used to control
* the rendering of pages and to let block and inline level areas call the
* appropriate method to render themselves. <p>
*
* A Renderer implementation takes areas/spaces and produces output in some
* format.</p> <p>
*
* Typically, most renderers are subclassed from FOP's abstract implementations
* ({@link AbstractRenderer}, {@link PrintRenderer}) which already handle a lot
* of things letting you concentrate on the details of the output format.
*/
public interface Renderer {
/**
* Role constant for Avalon.
*/
String ROLE = Renderer.class.getName();
/**
* Initiates the rendering phase.
* This must only be called once for a rendering. If
* stopRenderer is called then this may be called again
* for a new document rendering.
*
* @param outputStream The OutputStream to use for output
* @exception IOException If an I/O error occurs
*/
void startRenderer(OutputStream outputStream)
throws IOException;
/**
* Signals the end of the rendering phase.
* The renderer should reset to an initial state and dispose of
* any resources for the completed rendering.
*
* @exception IOException If an I/O error occurs
*/
void stopRenderer()
throws IOException;
/**
* Set the User Agent.
*
* @param agent The User Agent
*/
void setUserAgent(FOUserAgent agent);
/**
* Set up the given FontInfo.
*
* @param fontInfo The fonts
*/
void setupFontInfo(Document fontInfo);
/**
* Set up renderer options.
*
* @param options The Configuration for the renderer
*/
void setOptions(Map options);
/**
* Set the producer of the rendering. If this method isn't called the
* renderer uses a default. Note: Not all renderers support this feature.
*
* @param producer The name of the producer (normally "FOP") to be
* embedded in the generated file.
*/
void setProducer(String producer);
/**
* Set the creator of the document to be rendered. If this method
* isn't called the renderer uses a default.
* Note: Not all renderers support this feature.
*
* @param creator The name of the document creator
*/
void setCreator(String creator);
/**
* Reports if out of order rendering is supported. <p>
*
* Normally, all pages of a document are rendered in their natural order
* (page 1, page 2, page 3 etc.). Some output formats (such as PDF) allow
* pages to be output in random order. This is helpful to reduce resource
* strain on the system because a page that cannot be fully resolved
* doesn't block subsequent pages that are already fully resolved. </p>
*
* @return True if this renderer supports out of order rendering.
*/
boolean supportsOutOfOrder();
/**
* Tells the renderer to render an extension element.
*
* @param ext The extension element to be rendered
*/
void renderExtension(TreeExt ext);
/**
* This is called if the renderer supports out of order rendering. The
* renderer should prepare the page so that a page further on in the set of
* pages can be rendered. The body of the page should not be rendered. The
* page will be rendered at a later time by the call to {@link
* #renderPage(PageViewport)}.
*
* @param page The page viewport to use
*/
void preparePage(PageViewport page);
/**
* Tells the renderer that a new page sequence starts.
*
* @param seqTitle The title of the page sequence
*/
void startPageSequence(Title seqTitle);
/**
* Tells the renderer to render a particular page. A renderer typically
* reponds by packing up the current page and writing it immediately to the
* output device.
*
* @param page The page to be rendered
* @exception IOException if an I/O error occurs
* @exception FOPException if a FOP interal error occurs.
*/
void renderPage(PageViewport page)
throws IOException, FOPException;
/**
* Tells the renderer to render an inline viewport. It sets up clipping as
* necessary.
*
* @param viewport The viewport area
*/
void renderViewport(Viewport viewport);
/**
* Tells the renderer to render an inline container.
*
* @param cont The inline container area
*/
void renderContainer(Container cont);
/**
* Tells the renderer to render an inline word.
*
* @param area The word area
*/
void renderWord(Word area);
/**
* Tells the renderer to render an inline parent area.
*
* @param ip The inline parent area
*/
void renderInlineParent(InlineParent ip);
/**
* Tells the renderer to render an inline character.
*
* @param ch The inline character
*/
void renderCharacter(
org.apache.fop.area.inline.Character ch);
/**
* Tells the renderer to render an inline space.
*
* @param space The inline space
*/
void renderInlineSpace(Space space);
/**
* Tells the renderer to render an inline leader area.
*
* @param area The inline leader area.
*/
void renderLeader(Leader area);
}
|
