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
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/* $Id$ */
package org.apache.fop.render.intermediate;
import java.awt.Color;
import java.awt.Dimension;
import java.awt.Paint;
import java.awt.Point;
import java.awt.Rectangle;
import java.awt.geom.AffineTransform;
import org.w3c.dom.Document;
import org.apache.fop.traits.BorderProps;
import org.apache.fop.traits.RuleStyle;
/**
* Interface used to paint whole documents layouted by Apache FOP.
* <p>
* Call sequence:
* <p>
* <pre>
* startDocument()
* startDocumentHeader()
* [handleExtension()]*
* endDocumentHeader()
* [
* startPageSequence()
* [
* startPage()
* startPageHeader()
* [handleExtension()]*
* endPageHeader()
* startPageContent()
* (#pageContent)+
* endPageContent()
* startPageTrailer()
* (addTarget())*
* endPageTrailer()
* endPage()
* ]*
* endPageSequence()
* ]*
* startDocumentTrailer()
* [handleExtension()]*
* endDocumentTrailer()
* endDocument()
*
* #box:
* startBox()
* (#pageContent)+
* endBox()
*
* #pageContent:
* (
* setFont() |
* drawText() |
* drawRect() |
* drawImage() |
* TODO etc. etc. |
* handleExtensionObject()
* )
* </pre>
*/
public interface IFPainter {
/**
* Starts a new viewport, establishing a new coordinate system. A viewport has a size and
* can optionally be clipped. Corresponds to SVG's svg element.
* @param transform the transformation matrix establishing the new coordinate system
* @param size the size of the viewport
* @param clipRect the clipping rectangle (may be null)
* @throws IFException if an error occurs while handling this element
*/
void startViewport(AffineTransform transform, Dimension size, Rectangle clipRect)
throws IFException;
/**
* Starts a new viewport, establishing a new coordinate system. A viewport has a size and
* can optionally be clipped. Corresponds to SVG's svg element.
* @param transforms a series of transformation matrices establishing the new coordinate system
* @param size the size of the viewport
* @param clipRect the clipping rectangle (may be null)
* @throws IFException if an error occurs while handling this element
*/
void startViewport(AffineTransform[] transforms, Dimension size, Rectangle clipRect)
throws IFException;
//For transform, Batik's org.apache.batik.parser.TransformListHandler/Parser can be used
/**
* Ends the current viewport and restores the previous coordinate system.
* @throws IFException if an error occurs while handling this element
*/
void endViewport() throws IFException;
/**
* Starts a new group of graphical elements. Corresponds to SVG's g element.
* @param transforms a series of transformation matrices establishing the new coordinate system
* @throws IFException if an error occurs while handling this element
*/
void startGroup(AffineTransform[] transforms) throws IFException;
/**
* Starts a new group of graphical elements. Corresponds to SVG's g element.
* @param transform the transformation matrix establishing the new coordinate system
* @throws IFException if an error occurs while handling this element
*/
void startGroup(AffineTransform transform) throws IFException;
/**
* Ends the current group and restores the previous coordinate system.
* @throws IFException if an error occurs while handling this element
*/
void endGroup() throws IFException;
/**
* Updates the current font.
* @param family the font family (or null if there's no change)
* @param style the font style (or null if there's no change)
* @param weight the font weight (or null if there's no change)
* @param variant the font variant (or null if there's no change)
* @param size the font size (or null if there's no change)
* @param color the text color (or null if there's no change)
* @throws IFException if an error occurs while handling this event
*/
void setFont(String family, String style, Integer weight, String variant, Integer size,
Color color) throws IFException;
/**
* Draws text. The initial coordinates (x and y) point to the starting point at the normal
* baseline of the font. The parameters letterSpacing, wordSpacing and the array dx are
* optional and can be used to influence character positioning (for example, for kerning).
* @param x X-coordinate of the starting point of the text
* @param y Y-coordinate of the starting point of the text
* @param letterSpacing additional spacing between characters (may be 0)
* @param wordSpacing additional spacing between words (may be 0)
* @param dx an array of adjustment values for each character in X-direction (may be null)
* @param text the text
* @throws IFException if an error occurs while handling this event
*/
void drawText(int x, int y, int letterSpacing, int wordSpacing,
int[] dx, String text) throws IFException;
/**
* Restricts the current clipping region with the given rectangle.
* @param rect the rectangle's coordinates and extent
* @throws IFException if an error occurs while handling this event
*/
void clipRect(Rectangle rect) throws IFException;
//TODO clipRect() shall be considered temporary until verified with SVG and PCL
/**
* Fills a rectangular area.
* @param rect the rectangle's coordinates and extent
* @param fill the fill paint
* @throws IFException if an error occurs while handling this event
*/
void fillRect(Rectangle rect, Paint fill) throws IFException;
/**
* Draws a border rectangle. The border segments are specified through {@code BorderProps}
* instances.
* @param rect the rectangle's coordinates and extent
* @param before the border segment on the before-side (top)
* @param after the border segment on the after-side (bottom)
* @param start the border segment on the start-side (left)
* @param end the border segment on the end-side (right)
* @throws IFException if an error occurs while handling this event
*/
void drawBorderRect(Rectangle rect,
BorderProps before, BorderProps after,
BorderProps start, BorderProps end) throws IFException;
/**
* Draws a line. NOTE: Currently, only horizontal lines are implemented!
* @param start the start point of the line
* @param end the end point of the line
* @param width the line width
* @param color the line color
* @param style the line style (using the Constants.EN_* constants for the rule-style property)
* @throws IFException if an error occurs while handling this event
*/
void drawLine(Point start, Point end, int width, Color color, RuleStyle style)
throws IFException;
/**
* Draws an image identified by a URI inside a given rectangle. This is the equivalent to
* an fo:external-graphic in XSL-FO.
* @param uri the image's URI
* @param rect the rectangle in which the image shall be painted
* @throws IFException if an error occurs while handling this event
*/
void drawImage(String uri, Rectangle rect) throws IFException;
/**
* Draws an image (represented by a DOM document) inside a given rectangle. This is the
* equivalent to an fo:instream-foreign-object in XSL-FO.
* @param doc the DOM document containing the foreign object
* @param rect the rectangle in which the image shall be painted
* @throws IFException if an error occurs while handling this event
*/
void drawImage(Document doc, Rectangle rect) throws IFException;
//Note: For now, all foreign objects are handled as DOM documents. At the moment, all known
//implementations use a DOM anyway, so optimizing this to work with SAX wouldn't result in
//any performance benefits. The IFRenderer itself has a DOM anyway. Only the IFParser could
//potentially profit if there's an image handler that can efficiently deal with the foreign
//object without building a DOM.
//etc. etc.
}
|
