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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" >
<html>
<head>
<META http-equiv= "Content-Type" content= "text/html; charset=ISO-8859-1" >
<title>Property classes overview</title>
<link type="text/css" href="../../../page.css" rel="stylesheet">
<script type="text/javascript">
<!--
topdoc=window.top.document;
topwin=window.top;
// -->
</script>
</head>
<body marginheight= "0" marginwidth= "0" topmargin= "0" leftmargin= "0" text= "#000000" bgcolor= "#FFFFFF" >
<div class= "content" >
<h1>Property classes overview</h1>
<p>
<font size= "-2" >by Peter B. West</font>
</p>
<ul class= "minitoc" >
<li>
<a href = "#N10014" >Properties: packages</a>
<ul class= "minitoc" >
<li>
<a href = "#N10019" >org.apache.fop.fo</a>
</li>
<li>
<a href = "#N100AC" >org.apache.fop.fo.properties</a>
</li>
<li>
<a href = "#N100EE" >org.apache.fop.fo.expr</a>
</li>
<li>
<a href = "#N10134" >org.apache.fop.datatypes</a>
</li>
<li>
<a href = "#N101A2"
>org.apache.fop.datatypes.indirect</a>
</li>
</ul>
</li>
</ul>
<a name= "N10014" ></a> <h3>Properties: packages</h3> <a name=
"N10019" ></a> <h4>org.apache.fop.fo</h4>
<dl>
<dt>
<a href = "javascript:topwin.displayCode(
'PropNames.html#PropNamesClass'
)" ><em>PropNames</em></a>
</dt>
<dd>
This class maintains an array of <a href=
"javascript:topwin.displayCode(
'PropNames.html#propertyNames' )" >property names</a>,
synchronized to a complete set of property name <a href =
"javascript:topwin.displayCode( 'PropNames.html#NO_PROPERTY'
)" >constants</a> for indexing property-based arrays. It
includes methods to <a href =
"javascript:topwin.displayCode(
'PropNames.html#getPropertyName' )" >convert an index to a
name</a> and to <a href = "javascript:topwin.displayCode(
'PropNames.html#getPropertyIndex' )" >convert a property
name to an index</a>.
</dd>
<dt>
<a href = "PropertyConsts-class.html" ><em>PropertyConsts</em></a>
</dt>
<dd>
A singleton instance of <span class= "codefrag"
>PropertyConsts</span> is created by the static initializer
of the <a href = "javascript:topwin.displayCode(
'PropertyConsts.html#pconsts' )" >pconsts</a> field.
Working from the property indices defined in PropNames, the
methods in this class collect and supply the values of
fields defined in property objects into arrays.<br> The
heart of this class in the method <a href =
"javascript:topwin.displayCode(
'PropertyConsts.html#setupProperty' )" >setupProperty</a>,
which constructs the property name from the index,
instantiates a singleton of the appropriate class, and
extracts static fields by reflection from that instance into
the arrays of field values.
</dd>
<dt>
<a href = "javascript:topwin.displayCode(
'PropertySets.html#PropertySetsClass' )" ><em>PropertySets</em></a>
</dt>
<dd>
This class provides a number of <span class= "codefrag"
>ROBitSet</span>s representing many of the sets of
properties defined in <em>Section 7</em> of the
specification. Note that the <a
href="javascript:topwin.displayCode(
'PropertySets.html#borderProps' )"><em>Border</em></a>, <a
href="javascript:topwin.displayCode(
'PropertySets.html#paddingProps' )"><em>Padding</em></a> and
<a href="javascript:topwin.displayCode(
'PropertySets.html#backgroundProps'
)"><em>Background</em></a> sets are defined separately.
</dd>
<dt>
<a href = "javascript:topwin.displayCode(
'../FOPropertySets.html#FOPropertySetsClass' )"
><em>FOPropertySets</em></a>
</dt>
<dd>
This class provides a number of <span class= "codefrag"
>ROBitSet</span>s representing sets of properties which are
applicable in particular subtrees of the FO tree. These
sets are provided so that other properties can be ignored
during processing of the subtrees.
</dd>
<dt>
<a href = "javascript:topwin.displayCode(
'ShorthandPropSets.html#ShorthandPropSetsClass' )"
><em>ShorthandPropSets</em></a>
</dt>
<dd>
This class contains arrays of <a href =
"javascript:topwin.displayCode(
'ShorthandPropSets.html#shorthands' )" >shorthand property
indices</a> and <a href = "javascript:topwin.displayCode(
'ShorthandPropSets.html#compounds' )" >compound property
indices</a>, and <span class= "codefrag" >ROBitSet</span>s
representing the expansion sets of these shorthands and
compounds. Various methods useful in the expansion of these
properties are also included.
</dd>
<dt>
<a href = "javascript:topwin.displayCode(
'FOAttributes.html#FOAttributesClass' )"
><em>FOAttributes</em></a>
</dt>
<dd>
This class manages the attribute set that is associated with
a SAX <span class= "codefrag" >startElement</span> event.
<em>fo:</em> namespace attributes are entered into a <a href
= "javascript:topwin.displayCode(
'FOAttributes.html#foAttrMap' )"><span class= "codefrag"
>HashMap</span></a>, indexed by the <em>fo:</em> property
index. As other namespaces are encountered, the values are
entered into namespace-specific <a href =
"javascript:topwin.displayCode(
'FOAttributes.html#nSpaceAttrMaps' )"><span class=
"codefrag" >HashMap</span>s</a>, indexed by the <em>local
name</em> of the attribute.
</dd>
</dl>
<a name= "N100AC" ></a><a name= "property-classes" ></a>
<h4>org.apache.fop.fo.properties</h4>
<dl>
<dt>
<a href="javascript:topwin.displayCode(
'Property.html#PropertyClass' )" ><em>Property</em></a>
</dt>
<dd>
The base class for all individual property classes.
There are 320 properties in all.
</dd>
<dt>
<em>ColumnNumber</em>
</dt>
<dd>
The actual property class with the lowest index
number, followed in the index order by properties required
for further processing, e.g. FontSize.
</dd>
<dt>
<em>....</em>
</dt>
<dd>....</dd>
<dt>
<em>Background</em>
</dt>
<dd>
First in index order of the remainining shorthand
properties, followed in index order by all other remaining
shorthands.
</dd>
<dt>
<em>....</em>
</dt>
<dd>....</dd>
<dt>
<em>AbsolutePosition</em>
</dt>
<dd>
First in index order of the remaining properties. Within
this ordering, compound properties precede their expansion
properties, and corresponding relative properties precede
corresponding absolute properties.
</dd>
<dt>
<em>....</em>
</dt>
<dd>....</dd>
<dt>
<em>ZIndex</em>
</dt>
<dd>
The property class with the highest index
number.
</dd>
</dl>
<a name= "N100EE" ></a>
<h4>org.apache.fop.fo.expr</h4>
<dl>
<dt>
<a href = "javascript:topwin.displayCode(
'PropertyTokenizer.html#PropertyTokenizerClass' )"
><em>PropertyTokenizer</em></a>
</dt>
<dd>
The tokenizer for the property expression parser. Defines a
set of <a href = "javascript:topwin.displayCode(
'PropertyTokenizer.html#EOF' )" >token constants</a> and
returns these with associated token values.
</dd>
<dt>
<a href = "javascript:topwin.displayCode(
'PropertyParser.html#PropertyParserClass' )"
><em>PropertyParser</em></a>
</dt>
<dd>
This extends <span class= "codefrag"
>PropertyTokenizer</span>. It parses property
expressions on the basis of the tokens passed to it by its
superclass, generating <span class= "codefrag"
>PropertyValue</span>s, including <span class= "codefrag"
>PropertyValueList</span>s.
</dd>
<dt>
<em>PropertyException</em>
</dt>
<dd>
The basic class for all property-related exceptions.
It extends <span class= "codefrag" >FOPException</span>. It
is housed in this package by historical accident.
</dd>
<dt>
<em>DataTypeNotImplementedException</em>
<br>
<em>FunctionNotImplementedException</em>
<br>
<em>PropertyNotImplementedException</em>
</dt>
<dd>
A set of particular exceptions extending <span class=
"codefrag" >PropertyException</span>. Also in this package
by accident.
</dd>
</dl>
<a name= "N10134" ></a>
<h4>org.apache.fop.datatypes</h4>
<dl>
<dt>
<a href = "javascript:topwin.displayCode(
'PropertyValue.html#PropertyValueInterface' )"
><em>PropertyValue</em></a>
</dt>
<dd>
An <em>interface</em> which all <span class= "codefrag"
>PropertyValue</span> classes must implement. In addition
to a few methods, <span class= "codefrag"
>PropertyValue</span> defines the set of <a href =
"javascript:topwin.displayCode( 'PropertyValue.html#NO_TYPE'
)" >constants</a> which the <span class= "codefrag"
>getType()</span> method may return; i.e. the valid set of
<span class= "codefrag" >PropertyValue</span> types.
</dd>
<dt>
<a href = "javascript:topwin.displayCode(
'AbstractPropertyValue.html#AbstractPropertyValueClass' )"
><em>AbstractPropertyValue</em></a>
</dt>
<dd>
An abstract implementation of the <span class= "codefrag"
>PropertyValue</span> interface. Most actual property value
classes extend <span class= "codefrag"
>AbstractPropertyValue</span>.
</dd>
<dt>
<a href = "javascript:topwin.displayCode(
'PropertyValueList.html#PropertyValueListClass' )"
><em>PropertyValueList</em></a>
</dt>
<dd>
This class extends <span class= "codefrag"
>LinkedList</span> and implements <span class= "codefrag"
>PropertyValue</span>. It is used whenever the process of
resolving a property expression yields a list of <span
class= "codefrag" >PropertyValue</span> elements; notably
during the processing of shorthands and "compound"
properties.
</dd>
<dt>
<em>StringType</em>
</dt>
<dd>
A basic type extending <span class= "codefrag"
>AbstractPropertyValue</span>. Extended by <span class=
"codefrag" >NCName</span>.
</dd>
<dt>
<em>NCName</em>
</dt>
<dd>
Extends <span class= "codefrag" >StringType</span> to represent
NCName strings.
</dd>
<dt>
<em>EnumType</em>
</dt>
<dd>
Extends <span class= "codefrag"
>AbstractPropertyValue</span> to represented enumerated
types.
</dd>
<dt>
<em>Other types</em>
</dt>
<dd>
All other types extend one of the above classes.
</dd>
</dl>
<a name= "N101A2" ></a>
<h4>org.apache.fop.datatypes.indirect</h4>
<dl>
<dt>
<em>IndirectValue</em>
</dt>
<dd>
The base type for all indirect value types; extends
<span class= "codefrag" >AbstractPropertyValue</span>.
</dd>
</dl>
<p>
<strong>Previous:</strong> <a href = "introduction.html"
>Introduction</a>
</p>
<p>
<strong>Next:</strong> <a href= "PropertyConsts-class.html"
>The PropertyConsts class</a>
</p>
</div>
<table summary= "footer" cellspacing= "0" cellpadding= "0" width= "100%" height= "20" border= "0" >
<tr>
<td colspan= "2" height= "1" bgcolor= "#4C6C8F" ><img
height= "1" width= "1" alt= "" src=
"../../skin/images/spacer.gif" ><a href =
"../../skin/images/label.gif" ></a><a href =
"../../skin/images/page.gif" ></a><a href =
"../../skin/images/chapter.gif" ></a><a href =
"../../skin/images/chapter_open.gif" ></a><a href =
"../../skin/images/current.gif" ></a><a href =
"../..//favicon.ico" ></a></td>
</tr>
<tr>
<td colspan= "2" bgcolor= "#CFDCED" class= "copyright"
align= "center" ><font size= "2" face= "Arial, Helvetica,
Sans-Serif" >Copyright © 1999-2002 The Apache
Software Foundation. All rights reserved.<script type=
"text/javascript" language= "JavaScript" ><!--
document.write(" - "+"Last Published: " +
document.lastModified); // --></script></font></td>
</tr>
<tr>
<td align= "left" bgcolor= "#CFDCED" class= "logos"
></td><td align= "right" bgcolor= "#CFDCED" class= "logos"
></td>
</tr>
</table>
</body>
</html>
|
