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
|
/*
* 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.fo.pagination;
// java
import java.util.List;
import org.xml.sax.Locator;
import org.apache.fop.apps.FOPException;
import org.apache.fop.fo.FOEventHandler;
import org.apache.fop.fo.FONode;
import org.apache.fop.fo.FObj;
import org.apache.fop.fo.PropertyList;
import org.apache.fop.fo.ValidationException;
import org.apache.fop.fo.pagination.bookmarks.BookmarkTree;
import org.apache.fop.fo.extensions.destination.Destination;
/**
* The fo:root formatting object. Contains page masters, page-sequences.
*/
public class Root extends FObj {
// The value of properties relevant for fo:root.
private int mediaUsage;
// End of property values
private LayoutMasterSet layoutMasterSet;
private Declarations declarations;
private BookmarkTree bookmarkTree = null;
private List destinationList;
private List pageSequences;
// temporary until above list populated
private boolean pageSequenceFound = false;
/**
* Keeps count of page number from over PageSequence instances
*/
private int endingPageNumberOfPreviousSequence = 0;
private int totalPagesGenerated = 0;
/**
* FOEventHandler object for this FO Tree
*/
private FOEventHandler foEventHandler = null;
/**
* @see org.apache.fop.fo.FONode#FONode(FONode)
*/
public Root(FONode parent) {
super(parent);
pageSequences = new java.util.ArrayList();
if (parent != null) {
//throw new FOPException("root must be root element");
}
}
/**
* @see org.apache.fop.fo.FObj#bind(PropertyList)
*/
public void bind(PropertyList pList) throws FOPException {
mediaUsage = pList.get(PR_MEDIA_USAGE).getEnum();
}
/**
* Signal end of this xml element.
*/
protected void endOfNode() throws FOPException {
if (!pageSequenceFound || layoutMasterSet == null) {
missingChildElementError("(layout-master-set, declarations?, " +
"bookmark-tree?, page-sequence+)");
}
}
/**
* @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String)
XSL 1.0 Spec: (layout-master-set,declarations?,page-sequence+)
FOP: (layout-master-set, declarations?, fox:bookmarks?, page-sequence+)
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
throws ValidationException {
if (FO_URI.equals(nsURI)) {
if (localName.equals("layout-master-set")) {
if (layoutMasterSet != null) {
tooManyNodesError(loc, "fo:layout-master-set");
}
} else if (localName.equals("declarations")) {
if (layoutMasterSet == null) {
nodesOutOfOrderError(loc, "fo:layout-master-set", "fo:declarations");
} else if (declarations != null) {
tooManyNodesError(loc, "fo:declarations");
} else if (bookmarkTree != null) {
nodesOutOfOrderError(loc, "fo:declarations", "fo:bookmark-tree");
} else if (pageSequenceFound) {
nodesOutOfOrderError(loc, "fo:declarations", "fo:page-sequence");
}
} else if (localName.equals("bookmark-tree")) {
if (layoutMasterSet == null) {
nodesOutOfOrderError(loc, "fo:layout-master-set", "fo:bookmark-tree");
} else if (bookmarkTree != null) {
tooManyNodesError(loc, "fo:bookmark-tree");
} else if (pageSequenceFound) {
nodesOutOfOrderError(loc, "fo:bookmark-tree", "fo:page-sequence");
}
} else if (localName.equals("page-sequence")) {
if (layoutMasterSet == null) {
nodesOutOfOrderError(loc, "fo:layout-master-set", "fo:page-sequence");
} else {
pageSequenceFound = true;
}
} else {
invalidChildError(loc, nsURI, localName);
}
} else {
invalidChildError(loc, nsURI, localName);
}
}
/**
* Sets the FOEventHandler object that this Root is attached to
* @param foEventHandler the FOEventHandler object
*/
public void setFOEventHandler(FOEventHandler foEventHandler) {
this.foEventHandler = foEventHandler;
}
/**
* This method overrides the FONode version. The FONode version calls the
* method by the same name for the parent object. Since Root is at the top
* of the tree, it returns the actual FOEventHandler object. Thus, any FONode
* can use this chain to find which FOEventHandler it is being built for.
* @return the FOEventHandler implementation that this Root is attached to
*/
public FOEventHandler getFOEventHandler() {
return foEventHandler;
}
/**
* Gets the last page number generated by the previous page-sequence
* @return the last page number, 0 if no page sequences yet generated
*/
public int getEndingPageNumberOfPreviousSequence() {
return endingPageNumberOfPreviousSequence;
}
/**
* Returns the total number of pages generated by FOP
* (May not equal endingPageNumberOfPreviousSequence due to
* initial-page-number property on fo:page-sequences.)
* @return the last page number, 0 if no page sequences yet generated
*/
public int getTotalPagesGenerated() {
return totalPagesGenerated;
}
/**
* Notify additional pages generated to increase the totalPagesGenerated counter
* @param lastPageNumber the last page number generated by the sequence
* @param additionalPages the total pages generated by the sequence (for statistics)
* @throws IllegalArgumentException for negative additional page counts
*/
public void notifyPageSequenceFinished(int lastPageNumber, int additionalPages) {
if (additionalPages >= 0) {
totalPagesGenerated += additionalPages;
endingPageNumberOfPreviousSequence = lastPageNumber;
} else {
throw new IllegalArgumentException(
"Number of additional pages must be zero or greater.");
}
}
/**
* Returns the number of PageSequence instances.
* @return the number of PageSequence instances
*/
public int getPageSequenceCount() {
return pageSequences.size();
}
/**
* Some properties, such as 'force-page-count', require a
* page-sequence to know about some properties of the next.
* @param current the current PageSequence
* @return succeeding PageSequence; null if none
*/
public PageSequence getSucceedingPageSequence(PageSequence current) {
int currentIndex = pageSequences.indexOf(current);
if (currentIndex == -1) {
return null;
}
if (currentIndex < (pageSequences.size() - 1)) {
return (PageSequence)pageSequences.get(currentIndex + 1);
} else {
return null;
}
}
/**
* Returns the associated LayoutMasterSet.
* @return the LayoutMasterSet instance
*/
public LayoutMasterSet getLayoutMasterSet() {
return this.layoutMasterSet;
}
/**
* Sets the associated LayoutMasterSet.
* @param layoutMasterSet the LayoutMasterSet to use
*/
public void setLayoutMasterSet(LayoutMasterSet layoutMasterSet) {
this.layoutMasterSet = layoutMasterSet;
}
/**
* Returns the associated Declarations.
* @return the Declarations instance
*/
public Declarations getDeclarations() {
return this.declarations;
}
/**
* Sets the associated Declarations.
* @param declarations the Declarations to use
*/
public void setDeclarations(Declarations declarations) {
this.declarations = declarations;
}
/**
* Set the BookmarkTree object for this FO
* @param bookmarkTree the BookmarkTree object
*/
public void setBookmarkTree(BookmarkTree bookmarkTree) {
this.bookmarkTree = bookmarkTree;
}
/**
* Add a Destination object to this FO
* @param destination the Destination object to add
*/
public void addDestination(Destination destination) {
if (destinationList == null) {
destinationList = new java.util.ArrayList();
}
destinationList.add(destination);
}
/**
* Public accessor for the list of Destination objects for this FO
* @return the Destination object
*/
public List getDestinationList() {
return destinationList;
}
/**
* Public accessor for the BookmarkTree object for this FO
* @return the BookmarkTree object
*/
public BookmarkTree getBookmarkTree() {
return bookmarkTree;
}
/**
* @see org.apache.fop.fo.FONode#getRoot()
*/
public Root getRoot() {
return this;
}
/** @see org.apache.fop.fo.FONode#getLocalName() */
public String getLocalName() {
return "root";
}
/**
* @see org.apache.fop.fo.FObj#getNameId()
*/
public int getNameId() {
return FO_ROOT;
}
}
|