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
|
/*
* 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.flow;
// Java
import java.util.List;
// XML
import org.xml.sax.Attributes;
import org.xml.sax.Locator;
import org.xml.sax.SAXParseException;
// FOP
import org.apache.fop.fo.FONode;
import org.apache.fop.fo.FObj;
/**
* Class modelling the fo:footnote object.
*/
public class Footnote extends FObj {
private Inline inlineFO = null;
private FootnoteBody footnoteBody;
/**
* @param parent FONode that is the parent of this object
*/
public Footnote(FONode parent) {
super(parent);
}
/**
* @see org.apache.fop.fo.FObj#addProperties
*/
protected void addProperties(Attributes attlist) throws SAXParseException {
super.addProperties(attlist);
getFOEventHandler().startFootnote(this);
}
/**
* @see org.apache.fop.fo.FONode#validateChildNode(Locator, String, String)
* XSL Content Model: (inline,footnote-body)
* @todo: implement additional constraint: An fo:footnote is not permitted
* to have an fo:float, fo:footnote, or fo:marker as a descendant.
* @todo: implement additional constraint: An an fo:footnote is not
* permitted to have as a descendant an fo:block-container that
* generates an absolutely positioned area.
*/
protected void validateChildNode(Locator loc, String nsURI, String localName)
throws SAXParseException {
if (nsURI == FO_URI && localName.equals("inline")) {
if (inlineFO != null) {
tooManyNodesError(loc, "fo:inline");
}
} else if (nsURI == FO_URI && localName.equals("footnote-body")) {
if (inlineFO == null) {
nodesOutOfOrderError(loc, "fo:inline", "fo:footnote-body");
} else if (footnoteBody != null) {
tooManyNodesError(loc, "fo:footnote-body");
}
} else {
invalidChildError(loc, nsURI, localName);
}
}
/**
* Make sure content model satisfied, if so then tell the
* FOEventHandler that we are at the end of the flow.
* @see org.apache.fop.fo.FONode#endOfNode
*/
protected void endOfNode() throws SAXParseException {
super.endOfNode();
if (inlineFO == null || footnoteBody == null) {
missingChildElementError("(inline,footnote-body)");
}
getFOEventHandler().endFootnote(this);
}
/**
* @see org.apache.fop.fo.FONode#addChildNode(FONode)
*/
public void addChildNode(FONode child) {
if (((FObj)child).getNameId() == FO_INLINE) {
inlineFO = (Inline) child;
} else if (((FObj)child).getNameId() == FO_FOOTNOTE_BODY) {
footnoteBody = (FootnoteBody) child;
}
}
/**
* Public accessor for inline FO
* @return the Inline object stored as inline FO
*/
public Inline getInlineFO() {
return inlineFO;
}
/**
* @see org.apache.fop.fo.FONode#addLayoutManager(List)
*/
public void addLayoutManager(List list) {
if (getInlineFO() == null) {
getLogger().error("inline required in footnote");
return;
}
getInlineFO().addLayoutManager(list);
}
/**
* @see org.apache.fop.fo.FObj#getName()
*/
public String getName() {
return "fo:footnote";
}
/**
* @see org.apache.fop.fo.FObj#getNameId()
*/
public int getNameId() {
return FO_FOOTNOTE;
}
}
|