aboutsummaryrefslogtreecommitdiffstats
path: root/src/org/apache/fop/fo/FONode.java
blob: 04b60601e3c63414890a487fbcab3d3e71343621 (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
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
/*-- $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;



// FOP

import org.apache.fop.apps.FOPException;

import org.apache.fop.layout.Area;



// Java

import java.util.Vector;



/**

 * base class for nodes in the formatting object tree

 */

abstract public class FONode {



    protected FObj parent;

    protected Vector children = new Vector();



    /** value of marker before layout begins */

    public final static int START = -1000;



    /** value of marker after break-after */

    public final static int BREAK_AFTER = -1001;



    /** 

     * where the layout was up to.

     *  for FObjs it is the child number

     *  for FOText it is the character number

     */

    protected int marker = START;



    protected boolean isInLabel = false;

    protected boolean isInListBody = false;

    protected boolean isInTableCell = false;



    protected int bodyIndent;

    protected int distanceBetweenStarts;

    protected int labelSeparation;



    protected int forcedStartOffset = 0;

    protected int forcedWidth = 0;



    protected FONode(FObj parent) {

	this.parent = parent;

    }



    public void setIsInLabel() {

	this.isInLabel = true;

    }



    public void setIsInListBody() {

	this.isInListBody = true;

    }



    public void setIsInTableCell() {

	this.isInTableCell = true;

    }



    public void setDistanceBetweenStarts(int distance) {

	this.distanceBetweenStarts = distance;

    }



    public void setLabelSeparation(int separation) {

	this.labelSeparation = separation;

    }



    public void setBodyIndent(int indent) {

	this.bodyIndent = indent;

    }



    public void forceStartOffset(int offset) {

	this.forcedStartOffset = offset;

    }



    public void forceWidth(int width) {

	this.forcedWidth = width;

    }



    public void resetMarker() {

	this.marker = START;

	int numChildren = this.children.size();

	for (int i = 0; i < numChildren; i++) {

	    ((FONode) children.elementAt(i)).resetMarker();

	}

    }



    protected void addChild(FONode child) {

	children.addElement(child);

    }



    public FObj getParent() {

	return this.parent;

    }



    /* status */

    /* layout was fully completed */

    public final static int OK = 1;

    /* none of the formatting object could be laid out because the

       containing area was full (end of page) */

    public final static int AREA_FULL_NONE = 2;

    /* some of the formatting object could not be laid out because the

       containing area was full (end of page) */

    public final static int AREA_FULL_SOME = 3;

    /* force page break */

    public final static int FORCE_PAGE_BREAK = 4;

    public final static int FORCE_PAGE_BREAK_EVEN = 5;

    public final static int FORCE_PAGE_BREAK_ODD = 6;



    abstract public int layout(Area area)

	throws FOPException;

}