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
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
|
/*
* $Id: PropertyList.java,v 1.20 2003/03/05 21:48:01 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.fo;
import java.util.HashMap;
import org.apache.fop.fo.properties.WritingMode;
import org.apache.fop.apps.FOPException;
/**
* Class containing the collection of properties for a given FObj.
*/
public class PropertyList extends HashMap {
// writing-mode values
private byte[] wmtable = null;
// absolute directions and dimensions
/** constant for direction "left" */
public static final int LEFT = 0;
/** constant for direction "right" */
public static final int RIGHT = 1;
/** constant for direction "top" */
public static final int TOP = 2;
/** constant for direction "bottom" */
public static final int BOTTOM = 3;
/** constant for dimension "height" */
public static final int HEIGHT = 4;
/** constant for dimension "width" */
public static final int WIDTH = 5;
// directions relative to writing-mode
/** constant for direction "start" */
public static final int START = 0;
/** constant for direction "end" */
public static final int END = 1;
/** constant for direction "before" */
public static final int BEFORE = 2;
/** constant for direction "after" */
public static final int AFTER = 3;
/** constant for dimension "block-progression-dimension" */
public static final int BLOCKPROGDIM = 4;
/** constant for dimension "inline-progression-dimension" */
public static final int INLINEPROGDIM = 5;
private static final String[] ABS_NAMES = new String[] {
"left", "right", "top", "bottom", "height", "width"
};
private static final String[] REL_NAMES = new String[] {
"start", "end", "before", "after", "block-progression-dimension",
"inline-progression-dimension"
};
private static final HashMap WRITING_MODE_TABLES = new HashMap(4);
{
WRITING_MODE_TABLES.put(new Integer(WritingMode.LR_TB), /* lr-tb */
new byte[] {
START, END, BEFORE, AFTER, BLOCKPROGDIM, INLINEPROGDIM
});
WRITING_MODE_TABLES.put(new Integer(WritingMode.RL_TB), /* rl-tb */
new byte[] {
END, START, BEFORE, AFTER, BLOCKPROGDIM, INLINEPROGDIM
});
WRITING_MODE_TABLES.put(new Integer(WritingMode.TB_RL), /* tb-rl */
new byte[] {
AFTER, BEFORE, START, END, INLINEPROGDIM, BLOCKPROGDIM
});
}
private PropertyListBuilder builder;
private PropertyList parentPropertyList = null;
private String namespace = "";
private String element = "";
private FObj fobj = null;
/**
* Basic constructor.
* @param parentPropertyList the PropertyList belongin to the new objects
* parent
* @param space name of namespace
* @param el name of element
*/
public PropertyList(PropertyList parentPropertyList, String space,
String el) {
this.parentPropertyList = parentPropertyList;
this.namespace = space;
this.element = el;
}
/**
* @param fobj the FObj object to which this propertyList should be attached
*/
public void setFObj(FObj fobj) {
this.fobj = fobj;
}
/**
* @return the FObj object to which this propertyList is attached
*/
public FObj getFObj() {
return this.fobj;
}
/**
* @return the FObj object attached to the parentPropetyList
*/
public FObj getParentFObj() {
if (parentPropertyList != null) {
return parentPropertyList.getFObj();
} else {
return null;
}
}
/**
* Return the value explicitly specified on this FO.
* @param propertyName The name of the property whose value is desired.
* It may be a compound name, such as space-before.optimum.
* @return The value if the property is explicitly set or set by
* a shorthand property, otherwise null.
*/
public Property getExplicitOrShorthand(String propertyName) {
/* Handle request for one part of a compound property */
int sepchar = propertyName.indexOf('.');
String baseName;
if (sepchar > -1) {
baseName = propertyName.substring(0, sepchar);
} else {
baseName = propertyName;
}
Property p = getExplicitBaseProp(baseName);
if (p == null) {
p = builder.getShorthand(this, namespace, element, baseName);
}
if (p != null && sepchar > -1) {
return builder.getSubpropValue(namespace, element, baseName, p,
propertyName.substring(sepchar
+ 1));
}
return p;
}
/**
* Return the value explicitly specified on this FO.
* @param propertyName The name of the property whose value is desired.
* It may be a compound name, such as space-before.optimum.
* @return The value if the property is explicitly set, otherwise null.
*/
public Property getExplicit(String propertyName) {
/* Handle request for one part of a compound property */
int sepchar = propertyName.indexOf('.');
if (sepchar > -1) {
String baseName = propertyName.substring(0, sepchar);
Property p = getExplicitBaseProp(baseName);
if (p != null) {
return this.builder.getSubpropValue(namespace, element,
baseName, p,
propertyName.substring(sepchar
+ 1));
} else {
return null;
}
}
return (Property)super.get(propertyName);
}
/**
* Return the value explicitly specified on this FO.
* @param propertyName The name of the base property whose value is desired.
* @return The value if the property is explicitly set, otherwise null.
*/
public Property getExplicitBaseProp(String propertyName) {
return (Property)super.get(propertyName);
}
/**
* Return the value of this property inherited by this FO.
* Implements the inherited-property-value function.
* The property must be inheritable!
* @param propertyName The name of the property whose value is desired.
* @return The inherited value, otherwise null.
*/
public Property getInherited(String propertyName) {
if (builder != null) {
if (parentPropertyList != null
&& builder.isInherited(namespace, element,
propertyName)) {
return parentPropertyList.get(propertyName);
} else {
// return the "initial" value
try {
return builder.makeProperty(this, namespace, element,
propertyName);
} catch (org.apache.fop.apps.FOPException e) {
//log.error("Exception in getInherited(): property="
// + propertyName + " : " + e);
}
}
}
return null; // No builder or exception in makeProperty!
}
/*
* If the property is a relative property with a corresponding absolute
* value specified, the absolute value is used. This is also true of
* the inheritance priority (I think...)
* If the property is an "absolute" property and it isn't specified, then
* we try to compute it from the corresponding relative property: this
* happends in computeProperty.
*/
private Property findProperty(String propertyName, boolean bTryInherit) {
Property p = null;
if (builder.isCorrespondingForced(this, namespace, element,
propertyName)) {
p = builder.computeProperty(this, namespace, element,
propertyName);
} else {
p = getExplicitBaseProp(propertyName);
if (p == null) {
p = this.builder.computeProperty(this, namespace, element,
propertyName);
}
if (p == null) { // check for shorthand specification
p = builder.getShorthand(this, namespace, element,
propertyName);
}
if (p == null
&& bTryInherit) { // else inherit (if has parent and is inheritable)
if (this.parentPropertyList != null
&& builder.isInherited(namespace, element,
propertyName)) {
p = parentPropertyList.findProperty(propertyName, true);
}
}
}
return p;
}
/**
* Return the property on the current FlowObject if it is specified, or if a
* corresponding property is specified. If neither is specified, it returns null.
* @param propertyName name of property
* @return the Property corresponding to that name
*/
public Property getSpecified(String propertyName) {
return get(propertyName, false, false);
}
/**
* Return the property on the current FlowObject. If it isn't set explicitly,
* this will try to compute it based on other properties, or if it is
* inheritable, to return the inherited value. If all else fails, it returns
* the default value.
* @param propertyName property name
* @return the Property corresponding to that name
*/
public Property get(String propertyName) {
return get(propertyName, true, true);
}
/**
* Return the property on the current FlowObject. Depending on the passed flags,
* this will try to compute it based on other properties, or if it is
* inheritable, to return the inherited value. If all else fails, it returns
* the default value.
*/
private Property get(String propertyName, boolean bTryInherit,
boolean bTryDefault) {
if (builder == null) {
//log.error("OH OH, builder has not been set");
}
/* Handle request for one part of a compound property */
int sepchar = propertyName.indexOf('.');
String subpropName = null;
if (sepchar > -1) {
subpropName = propertyName.substring(sepchar + 1);
propertyName = propertyName.substring(0, sepchar);
}
Property p = findProperty(propertyName, bTryInherit);
if (p == null && bTryDefault) { // default value for this FO!
try {
p = this.builder.makeProperty(this, namespace, element,
propertyName);
} catch (FOPException e) {
// don't know what to do here
}
}
// if value is inherit then get computed value from
// parent
if (p != null && "inherit".equals(p.getSpecifiedValue())) {
if (this.parentPropertyList != null) {
p = parentPropertyList.get(propertyName, true, false);
}
}
if (subpropName != null && p != null) {
return this.builder.getSubpropValue(namespace, element,
propertyName, p, subpropName);
} else {
return p;
}
}
/**
*
* @param builder the PropertyListBuilder to attache to this object
*/
public void setBuilder(PropertyListBuilder builder) {
this.builder = builder;
}
/**
* @return the namespace of this element
*/
public String getNameSpace() {
return namespace;
}
/**
* @return element name for this
*/
public String getElement() {
return element;
}
/**
* Return the "nearest" specified value for the given property.
* Implements the from-nearest-specified-value function.
* @param propertyName The name of the property whose value is desired.
* @return The computed value if the property is explicitly set on some
* ancestor of the current FO, else the initial value.
*/
public Property getNearestSpecified(String propertyName) {
Property p = null;
for (PropertyList plist = this; p == null && plist != null;
plist = plist.parentPropertyList) {
p = plist.getExplicit(propertyName);
}
if (p == null) {
// If no explicit setting found, return initial (default) value.
try {
p = this.builder.makeProperty(this, namespace, element,
propertyName);
} catch (FOPException e) {
//log.error("Exception in getNearestSpecified(): property="
// + propertyName + " : " + e);
}
}
return p;
}
/**
* Return the value of this property on the parent of this FO.
* Implements the from-parent function.
* @param propertyName The name of the property whose value is desired.
* @return The computed value on the parent or the initial value if this
* FO is the root or is in a different namespace from its parent.
*/
public Property getFromParent(String propertyName) {
if (parentPropertyList != null) {
return parentPropertyList.get(propertyName);
} else if (builder != null) {
// return the "initial" value
try {
return builder.makeProperty(this, namespace, element,
propertyName);
} catch (org.apache.fop.apps.FOPException e) {
//log.error("Exception in getFromParent(): property="
// + propertyName + " : " + e);
}
}
return null; // No builder or exception in makeProperty!
}
/**
* Uses the stored writingMode.
* @param absdir an absolute direction (top, bottom, left, right)
* @return the corresponding writing model relative direction name
* for the flow object.
*/
public String wmAbsToRel(int absdir) {
if (wmtable != null) {
return REL_NAMES[wmtable[absdir]];
} else {
return "";
}
}
/**
* Uses the stored writingMode.
* @param reldir a writing mode relative direction (start, end, before, after)
* @return the corresponding absolute direction name for the flow object.
*/
public String wmRelToAbs(int reldir) {
if (wmtable != null) {
for (int i = 0; i < wmtable.length; i++) {
if (wmtable[i] == reldir) {
return ABS_NAMES[i];
}
}
}
return "";
}
/**
* Set the writing mode traits for the FO with this property list.
* @param writingMode the writing-mode property to be set for this object
*/
public void setWritingMode(int writingMode) {
this.wmtable = (byte[])WRITING_MODE_TABLES.get(new Integer(writingMode));
}
}
|