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
|
/*
* Copyright 1999-2004 The Apache Software Foundation.
*
* Licensed 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.ArrayList;
// XML
import org.xml.sax.Attributes;
import org.xml.sax.Locator;
// FOP
import org.apache.fop.fo.FONode;
import org.apache.fop.fo.FObj;
import org.apache.fop.fo.FOTreeVisitor;
import org.apache.fop.apps.FOPException;
/**
* Class modelling the fo:flow object. See Sec. 6.4.18 in the XSL-FO Standard.
*/
public class Flow extends FObj {
/**
* PageSequence container
*/
private PageSequence pageSequence;
/**
* ArrayList to store snapshot
*/
private ArrayList markerSnapshot;
/**
* flow-name attribute
*/
private String flowName;
/**
* Content-width of current column area during layout
*/
private int contentWidth;
/**
* @param parent FONode that is the parent of this object
*/
public Flow(FONode parent) {
super(parent);
}
/**
* @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String)
* XSL/FOP Content Model: (%block;)+
*/
protected void validateChildNode(Locator loc, String nsURI, String localName) {
if (!isBlockItem(nsURI, localName)) {
invalidChildError(loc, nsURI, localName);
}
}
/**
* Make sure content model satisfied, if so then tell the
* StructureRenderer that we are at the end of the flow.
* @see org.apache.fop.fo.FONode#end
*/
protected void end() {
if (children == null) {
missingChildElementError("(%block;)+");
}
getFOInputHandler().endFlow(this);
}
/**
* @see org.apache.fop.fo.FObj#addProperties
*/
protected void addProperties(Attributes attlist) throws FOPException {
super.addProperties(attlist);
if (parent.getName().equals("fo:page-sequence")) {
this.pageSequence = (PageSequence) parent;
} else {
throw new FOPException("flow must be child of "
+ "page-sequence, not " + parent.getName());
}
// according to communication from Paul Grosso (XSL-List,
// 001228, Number 406), confusion in spec section 6.4.5 about
// multiplicity of fo:flow in XSL 1.0 is cleared up - one (1)
// fo:flow per fo:page-sequence only.
/* if (pageSequence.isFlowSet()) {
if (this.name.equals("fo:flow")) {
throw new FOPException("Only a single fo:flow permitted"
+ " per fo:page-sequence");
} else {
throw new FOPException(this.name
+ " not allowed after fo:flow");
}
}
*/
setFlowName(getProperty(PR_FLOW_NAME).getString());
// Now done in addChild of page-sequence
//pageSequence.addFlow(this);
getFOInputHandler().startFlow(this);
}
/**
* @param name the name of the flow to set
* @throws FOPException for an empty name
*/
protected void setFlowName(String name) throws FOPException {
if (name == null || name.equals("")) {
throw new FOPException("A 'flow-name' is required for "
+ getName());
} else {
flowName = name;
}
}
/**
* @return the name of this flow
*/
public String getFlowName() {
return flowName;
}
/**
* @param contentWidth content width of this flow, in millipoints (??)
*/
protected void setContentWidth(int contentWidth) {
this.contentWidth = contentWidth;
}
/**
* @return the content width of this flow (really of the region
* in which it is flowing), in millipoints (??).
*/
public int getContentWidth() {
return this.contentWidth;
}
/**
* @return true (Flow can generate reference areas)
*/
public boolean generatesReferenceAreas() {
return true;
}
/**
* This is a hook for an FOTreeVisitor subclass to be able to access
* this object.
* @param fotv the FOTreeVisitor subclass that can access this object.
* @see org.apache.fop.fo.FOTreeVisitor
*/
public void acceptVisitor(FOTreeVisitor fotv) {
fotv.serveFlow(this);
}
public String getName() {
return "fo:flow";
}
}
|
