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
|
/*
* $Id$
* Copyright (C) 2001 The Apache Software Foundation. All rights reserved.
* For details on use and redistribution please refer to the
* LICENSE file included with these sources.
*/
package org.apache.fop.fo.flow;
// FOP
import org.apache.fop.fo.*;
import org.apache.fop.fo.properties.*;
import org.apache.fop.datatypes.*;
import org.apache.fop.layout.*;
import org.apache.fop.layout.BlockArea;
import org.apache.fop.layout.inline.LeaderArea;
import org.apache.fop.layout.LineArea;
import org.apache.fop.layout.FontState;
import org.apache.fop.apps.FOPException;
import org.apache.fop.messaging.MessageHandler;
/**
* Implements fo:leader; main property of leader leader-pattern.
* The following patterns are treated: rule, space, dots.
* The pattern use-content is ignored, i.e. it still must be implemented.
*/
public class Leader extends FObjMixed {
public static class Maker extends FObj.Maker {
public FObj make(FObj parent,
PropertyList propertyList) throws FOPException {
return new Leader(parent, propertyList);
}
}
public static FObj.Maker maker() {
return new Leader.Maker();
}
public Leader(FObj parent, PropertyList propertyList) {
super(parent, propertyList);
this.name = "fo:leader";
}
public Status layout(Area area) throws FOPException {
BlockArea blockArea;
// restriction in this version
if (!(area instanceof BlockArea)) {
MessageHandler.errorln("WARNING: in this version of Fop fo:leader must be a direct child of fo:block ");
return new Status(Status.OK);
} else {
blockArea = (BlockArea)area;
}
// Common Accessibility Properties
AccessibilityProps mAccProps = propMgr.getAccessibilityProps();
// Common Aural Properties
AuralProps mAurProps = propMgr.getAuralProps();
// Common Border, Padding, and Background Properties
BorderAndPadding bap = propMgr.getBorderAndPadding();
BackgroundProps bProps = propMgr.getBackgroundProps();
// Common Font Properties
//this.fontState = propMgr.getFontState(area.getFontInfo());
// Common Margin Properties-Inline
MarginInlineProps mProps = propMgr.getMarginInlineProps();
// Common Relative Position Properties
RelativePositionProps mRelProps = propMgr.getRelativePositionProps();
// this.properties.get("alignment-adjust");
// this.properties.get("alignment-baseline");
// this.properties.get("baseline-shift");
// this.properties.get("color");
// this.properties.get("dominant-baseline");
// this.properties.get("text-depth");
// this.properties.get("text-altitude");
// this.properties.get("id");
// this.properties.get("leader-alignment");
// this.properties.get("leader-length");
// this.properties.get("leader-pattern");
// this.properties.get("leader-pattern-width");
// this.properties.get("rule-style");
// this.properties.get("rule-thickness");
// this.properties.get("letter-spacing");
// this.properties.get("line-height");
// this.properties.get("line-height-shift-adjustment");
// this.properties.get("text-shadow");
// this.properties.get("visibility");
// this.properties.get("word-spacing");
// this.properties.get("z-index");
// color properties
ColorType c = this.properties.get("color").getColorType();
float red = c.red();
float green = c.green();
float blue = c.blue();
// fo:leader specific properties
// determines the pattern of leader; allowed values: space, rule,dots, use-content
int leaderPattern = this.properties.get("leader-pattern").getEnum();
// length of the leader
int leaderLengthOptimum =
this.properties.get("leader-length.optimum").getLength().mvalue();
int leaderLengthMinimum =
this.properties.get("leader-length.minimum").getLength().mvalue();
int leaderLengthMaximum =
this.properties.get("leader-length.maximum").getLength().mvalue();
// the following properties only apply for leader-pattern = "rule"
int ruleThickness =
this.properties.get("rule-thickness").getLength().mvalue();
int ruleStyle = this.properties.get("rule-style").getEnum();
// if leaderPatternWidth = 0 = default = use-font-metric
int leaderPatternWidth =
this.properties.get("leader-pattern-width").getLength().mvalue();
int leaderAlignment =
this.properties.get("leader-alignment").getEnum();
// initialize id
String id = this.properties.get("id").getString();
blockArea.getIDReferences().initializeID(id, blockArea);
// adds leader to blockarea, there the leaderArea is generated
int succeeded = addLeader(blockArea,
propMgr.getFontState(area.getFontInfo()),
red, green, blue, leaderPattern,
leaderLengthMinimum, leaderLengthOptimum,
leaderLengthMaximum, ruleThickness,
ruleStyle, leaderPatternWidth,
leaderAlignment);
if (succeeded == 1) {
return new Status(Status.OK);
} else {
// not sure that this is the correct Status here
return new Status(Status.AREA_FULL_SOME);
}
}
/*
* //should only be necessary for use-content
* protected void addCharacters(char data[], int start, int length) {
* FOText textNode = new FOText(data,start,length, this);
* children.addElement(textNode);
* }
*/
/**
* adds a leader to current line area of containing block area
* the actual leader area is created in the line area
*
* @return int +1 for success and -1 for none
*/
public int addLeader(BlockArea ba, FontState fontState, float red,
float green, float blue, int leaderPattern,
int leaderLengthMinimum, int leaderLengthOptimum,
int leaderLengthMaximum, int ruleThickness,
int ruleStyle, int leaderPatternWidth,
int leaderAlignment) {
LineArea la = ba.getCurrentLineArea();
// this should start a new page
if (la == null) {
return -1;
}
la.changeFont(fontState);
la.changeColor(red, green, blue);
// check whether leader fits into the (rest of the) line
// using length.optimum to determine where to break the line as defined
// in the xsl:fo spec: "User agents may choose to use the value of 'leader-length.optimum'
// to determine where to break the line" (7.20.4)
// if leader is longer then create a new LineArea and put leader there
if (leaderLengthOptimum <= (la.getRemainingWidth())) {
la.addLeader(leaderPattern, leaderLengthMinimum,
leaderLengthOptimum, leaderLengthMaximum, ruleStyle,
ruleThickness, leaderPatternWidth, leaderAlignment);
} else {
la = ba.createNextLineArea();
if (la == null) {
// not enough room
return -1;
}
la.changeFont(fontState);
la.changeColor(red, green, blue);
// check whether leader fits into LineArea at all, otherwise
// clip it (should honor the clip option of containing area)
if (leaderLengthMinimum <= la.getContentWidth()) {
la.addLeader(leaderPattern, leaderLengthMinimum,
leaderLengthOptimum, leaderLengthMaximum,
ruleStyle, ruleThickness, leaderPatternWidth,
leaderAlignment);
} else {
MessageHandler.errorln("Leader doesn't fit into line, it will be clipped to fit.");
la.addLeader(leaderPattern, la.getRemainingWidth(),
leaderLengthOptimum, leaderLengthMaximum,
ruleStyle, ruleThickness, leaderPatternWidth,
leaderAlignment);
}
}
// this.hasLines = true;
return 1;
}
}
|