blob: 7d4bc498083041d5c7bfd74917210ea27e4ae57f (
plain)
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
|
/*
* 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;
// Java
import java.util.ListIterator;
// XML
import org.xml.sax.Attributes;
import org.xml.sax.Locator;
// Avalon
import org.apache.avalon.framework.logger.Logger;
// FOP
import org.apache.fop.apps.FOPException;
import org.apache.fop.util.CharUtilities;
import org.apache.fop.apps.FOUserAgent;
/**
* base class for nodes in the XML tree
*
*/
public abstract class FONode {
/** Parent FO node */
protected FONode parent;
/** Name of the node */
protected String name;
/**
* Main constructor.
* @param parent parent of this node
*/
protected FONode(FONode parent) {
this.parent = parent;
}
/**
* Sets the name of the node.
* @param str the name
*/
public void setName(String str) {
name = str;
}
/**
* Sets the name of the node.
* @param str the name
*/
public void setLocation(Locator locator) {
// do nothing by default
}
/**
* Returns the logger for the node.
* @return the logger
*/
public Logger getLogger() {
return getFOTreeControl().getLogger();
}
/**
* Returns the user agent for the node.
* @return FOUserAgent
*/
public FOUserAgent getUserAgent() {
return getFOTreeControl().getUserAgent();
}
/**
* Do something with the attributes for this element
* @param attlist Collection of attributes passed to us from the parser.
* @throws FOPException for errors or inconsistencies in the attributes
*/
public void handleAttrs(Attributes attlist) throws FOPException {
}
/**
* Returns the name of the object
* @return the name of this object
*/
public String getName() {
return this.name;
}
/**
* Adds characters (does nothing here)
* @param data text
* @param start start position
* @param length length of the text
* @param locator location in fo source file.
*/
protected void addCharacters(char data[], int start, int length,
Locator locator) {
// ignore
}
/**
*
*/
protected void start() {
// do nothing by default
}
/**
*
*/
protected void end() {
// do nothing by default
}
/**
* @param child child node to be added to the children of this node
*/
protected void addChild(FONode child) {
}
/**
* @return the parent node of this node
*/
public FONode getParent() {
return this.parent;
}
/**
* Return an iterator over all the children of this FObj.
* @return A ListIterator.
*/
public ListIterator getChildren() {
return null;
}
/**
* Return an iterator over the object's children starting
* at the pased node.
* @param childNode First node in the iterator
* @return A ListIterator or null if childNode isn't a child of
* this FObj.
*/
public ListIterator getChildren(FONode childNode) {
return null;
}
/**
* @return an iterator for the characters in this node
*/
public CharIterator charIterator() {
return new OneCharIterator(CharUtilities.CODE_EOT);
}
/**
* This is a quick check to see if it is a marker.
* This is needed since there is no other quick way of checking
* for a marker and not adding to the child list.
*
* @return true if this is a marker
*/
protected boolean isMarker() {
return false;
}
/**
* Recursively goes up the FOTree hierarchy until the FONode is found,
* which returns the parent Document.
* @return the Document object that is the parent of this node.
*/
public FOTreeControl getFOTreeControl() {
return parent.getFOTreeControl();
}
/**
* 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.serveFONode(this);
}
}
|
