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
|
/*-- $Id$ --
============================================================================
The Apache Software License, Version 1.1
============================================================================
Copyright (C) 1999 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.pagination;
// FOP
import org.apache.fop.fo.*;
import org.apache.fop.messaging.MessageHandler;
import org.apache.fop.fo.properties.*;
import org.apache.fop.fo.flow.Flow;
import org.apache.fop.fo.flow.StaticContent;
import org.apache.fop.layout.Area;
import org.apache.fop.layout.AreaContainer;
import org.apache.fop.layout.AreaTree;
import org.apache.fop.layout.Page;
import org.apache.fop.layout.PageMaster;
import org.apache.fop.layout.PageMasterFactory;
import org.apache.fop.apps.FOPException;
// Java
import java.util.Hashtable;
import java.util.Vector;
public class PageSequence extends FObj
{
public static class Maker extends FObj.Maker
{
public FObj make(FObj parent, PropertyList propertyList)
throws FOPException {
return new PageSequence(parent, propertyList);
}
}
public static FObj.Maker maker() {
return new PageSequence.Maker();
}
static final int EXPLICIT = 0;
static final int AUTO = 1;
static final int AUTO_EVEN = 2;
static final int AUTO_ODD = 3;
protected Root root;
protected SequenceSpecification sequenceSpecification;
protected Flow flow;
protected StaticContent staticBefore;
protected StaticContent staticAfter;
protected LayoutMasterSet layoutMasterSet;
protected Page currentPage;
protected int currentPageNumber = 0;
protected static int runningPageNumberCounter = 0; //keeps count of page number from previous PageSequence
protected int pageNumberType; // specifies page numbering type (auto|auto-even|auto-odd|explicit)
protected boolean thisIsFirstPage; // used to determine whether to calculate auto, auto-even, auto-odd
protected PageSequence(FObj parent, PropertyList propertyList)
throws FOPException {
super(parent, propertyList);
this.name = "fo:page-sequence";
if ( parent.getName().equals("fo:root") )
{
this.runningPageNumberCounter=0; //else not initialized correctly
this.root = (Root) parent;
this.root.addPageSequence(this);
}
else
{
throw
new FOPException("page-sequence must be child of root, not "
+ parent.getName());
}
layoutMasterSet = root.getLayoutMasterSet();
thisIsFirstPage=true; // we are now on the first page of the page sequence
InitialPageNumber ipn = (InitialPageNumber) this.properties.get("initial-page-number");
String ipnValue=ipn.getString();
if ( ipnValue.equals("auto") )
{
pageNumberType=AUTO;
}
else if ( ipnValue.equals("auto-even") )
{
pageNumberType=AUTO_EVEN;
}
else if ( ipnValue.equals("auto-odd") )
{
pageNumberType=AUTO_ODD;
}
else
{
pageNumberType=EXPLICIT;
try
{
int pageStart = new Integer(ipnValue).intValue();
this.currentPageNumber = (pageStart > 0) ? pageStart - 1 : 0;
}
catch ( NumberFormatException nfe )
{
throw new FOPException("\""+ipnValue+"\" is not a valid value for initial-page-number");
}
}
}
protected Page makePage(AreaTree areaTree) throws FOPException {
PageMaster pageMaster;
// layout this page sequence
// while there is still stuff in the flow, ask the
// sequence-specification for a new page
if ( this.sequenceSpecification == null )
{
throw new FOPException("page-sequence is missing an"
+ " sequence-specification");
}
PageMasterFactory pmf =
this.sequenceSpecification.getFirstPageMasterFactory();
pageMaster = pmf.getNextPageMaster();
while ( pageMaster == null )
{
/* move on to next sequence specifier */
pmf = pmf.getNext();
if ( pmf == null )
{
throw new FOPException("out of sequence specifiers"
+ " (FOP will eventually allow this)");
}
pageMaster = pmf.getNextPageMaster();
}
return pageMaster.makePage(areaTree);
}
public void format(AreaTree areaTree) throws FOPException {
Status status = new Status(Status.OK);
do
{
currentPage = makePage(areaTree);
if ( thisIsFirstPage )
{
if ( pageNumberType==AUTO )
{
this.currentPageNumber=this.runningPageNumberCounter;
}
else if ( pageNumberType==AUTO_ODD )
{
this.currentPageNumber=this.runningPageNumberCounter;
if ( this.currentPageNumber % 2== 1 )
{
this.currentPageNumber++;
}
}
else if ( pageNumberType==AUTO_EVEN )
{
this.currentPageNumber=this.runningPageNumberCounter;
if ( this.currentPageNumber % 2 == 0 )
{
this.currentPageNumber++;
}
}
thisIsFirstPage=false;
}
currentPage.setNumber(++this.currentPageNumber);
this.runningPageNumberCounter=this.currentPageNumber;
MessageHandler.log(" [" + currentPageNumber);
if ( (this.staticBefore != null) &&
(currentPage.getBefore() != null) )
{
AreaContainer beforeArea = currentPage.getBefore();
beforeArea.setIDReferences(areaTree.getIDReferences());
this.staticBefore.layout(beforeArea);
}
if ( (this.staticAfter != null) &&
(currentPage.getAfter() != null) )
{
AreaContainer afterArea = currentPage.getAfter();
afterArea.setIDReferences(areaTree.getIDReferences());
this.staticAfter.layout(afterArea);
}
if ( (status.getCode() == Status.FORCE_PAGE_BREAK_EVEN) &&
((currentPageNumber % 2) == 1) )
{
}
else if ( (status.getCode() == Status.FORCE_PAGE_BREAK_ODD) &&
((currentPageNumber % 2) == 0) )
{
}
else
{
AreaContainer bodyArea = currentPage.getBody();
bodyArea.setIDReferences(areaTree.getIDReferences());
status = this.flow.layout(bodyArea);
}
MessageHandler.log("]");
areaTree.addPage(currentPage);
} while ( status.isIncomplete() );
MessageHandler.errorln("");
}
public void setFlow(Flow flow) {
this.flow = flow;
}
protected void setSequenceSpecification(SequenceSpecification sequenceSpecification) {
this.sequenceSpecification = sequenceSpecification;
sequenceSpecification.setLayoutMasterSet(this.layoutMasterSet);
}
public void setStaticContent(String name, StaticContent staticContent) {
if ( name.equals("xsl-before") )
{
this.staticBefore = staticContent;
}
else if ( name.equals("xsl-after") )
{
this.staticAfter = staticContent;
}
else
{
MessageHandler.errorln("WARNING: this version of FOP only supports "
+ "static-content in region-before and region-after");
}
}
}
|
