KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > fop > fo > flow > Footnote


1 /*
2  * $Id: Footnote.java,v 1.6.2.7 2003/04/11 00:24:38 pietsch Exp $
3  * ============================================================================
4  * The Apache Software License, Version 1.1
5  * ============================================================================
6  *
7  * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without modifica-
10  * tion, are permitted provided that the following conditions are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright notice,
13  * this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright notice,
16  * this list of conditions and the following disclaimer in the documentation
17  * and/or other materials provided with the distribution.
18  *
19  * 3. The end-user documentation included with the redistribution, if any, must
20  * include the following acknowledgment: "This product includes software
21  * developed by the Apache Software Foundation (http://www.apache.org/)."
22  * Alternately, this acknowledgment may appear in the software itself, if
23  * and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. The names "FOP" and "Apache Software Foundation" must not be used to
26  * endorse or promote products derived from this software without prior
27  * written permission. For written permission, please contact
28  * apache@apache.org.
29  *
30  * 5. Products derived from this software may not be called "Apache", nor may
31  * "Apache" appear in their name, without prior written permission of the
32  * Apache Software Foundation.
33  *
34  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
35  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
36  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
37  * APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
38  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
39  * DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
40  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
41  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
42  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
43  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44  * ============================================================================
45  *
46  * This software consists of voluntary contributions made by many individuals
47  * on behalf of the Apache Software Foundation and was originally created by
48  * James Tauber <jtauber@jtauber.com>. For more information on the Apache
49  * Software Foundation, please see <http://www.apache.org/>.
50  */

51 package org.apache.fop.fo.flow;
52
53 // FOP
54
import org.apache.fop.fo.*;
55 import org.apache.fop.layout.*;
56 import org.apache.fop.apps.FOPException;
57
58 // Java
59
import java.util.ArrayList JavaDoc;
60
61 public class Footnote extends FObj {
62
63     public static class Maker extends FObj.Maker {
64         public FObj make(FObj parent, PropertyList propertyList,
65                          String JavaDoc systemId, int line, int column)
66             throws FOPException {
67             return new Footnote(parent, propertyList, systemId, line, column);
68         }
69
70     }
71
72     public static FObj.Maker maker() {
73         return new Footnote.Maker();
74     }
75
76     public Footnote(FObj parent, PropertyList propertyList,
77                     String JavaDoc systemId, int line, int column) throws FOPException {
78         super(parent, propertyList, systemId, line, column);
79     }
80
81     public String JavaDoc getName() {
82         return "fo:footnote";
83     }
84
85     public int layout(Area area) throws FOPException {
86         FONode inline = null;
87         FONode fbody = null;
88         if (this.marker == START) {
89             this.marker = 0;
90         }
91         int numChildren = this.children.size();
92         for (int i = this.marker; i < numChildren; i++) {
93             FONode fo = (FONode)children.get(i);
94             if (fo instanceof Inline) {
95                 inline = fo;
96                 int status = fo.layout(area);
97                 if (Status.isIncomplete(status)) {
98                     return status;
99                 }
100             } else if (inline != null && fo instanceof FootnoteBody) {
101                 // add footnote to current page or next if it can't fit
102
fbody = fo;
103                 if (area instanceof BlockArea) {
104                     ((BlockArea)area).addFootnote((FootnoteBody)fbody);
105                 } else {
106                     Page page = area.getPage();
107                     layoutFootnote(page, (FootnoteBody)fbody, area);
108                 }
109             }
110         }
111         if (fbody == null) {
112             log.error("no footnote-body in footnote");
113         }
114         if (area instanceof BlockArea) {}
115         return Status.OK;
116     }
117
118     public static boolean layoutFootnote(Page p, FootnoteBody fb, Area area) {
119         try {
120             BodyAreaContainer bac = p.getBody();
121             AreaContainer footArea = bac.getFootnoteReferenceArea();
122             footArea.setIDReferences(bac.getIDReferences());
123             int basePos = footArea.getCurrentYPosition()
124                           - footArea.getHeight();
125             int oldHeight = footArea.getHeight();
126             if (area != null) {
127                 footArea.setMaxHeight(area.getMaxHeight() - area.getHeight()
128                                       + footArea.getHeight());
129             } else {
130                 footArea.setMaxHeight(bac.getMaxHeight()
131                                       + footArea.getHeight());
132             }
133             if (!footArea.hasChildren()) {
134                 StaticContent separator = bac.getPage().getPageSequence()
135                     .getStaticContent("xsl-footnote-separator");
136                 if (separator!=null) {
137                     footArea.setIDReferences(bac.getIDReferences());
138                     separator.layout(footArea, null);
139                     int diff = footArea.getHeight() - oldHeight;
140                     if (area != null) {
141                         area.setMaxHeight(area.getMaxHeight() - diff);
142                     }
143                     if (bac.getFootnoteState() == 0) {
144                         Area ar = bac.getMainReferenceArea();
145                         decreaseMaxHeight(ar, diff);
146                         footArea.setYPosition(basePos + footArea.getHeight());
147                     }
148                      basePos = footArea.getCurrentYPosition()
149                                - footArea.getHeight();
150                      oldHeight = footArea.getHeight();
151                 }
152             }
153             int status = fb.layout(footArea);
154             if (Status.isIncomplete(status)) {
155                 // add as a pending footnote
156
return false;
157             } else {
158                 if (area != null) {
159                     area.setMaxHeight(area.getMaxHeight()
160                                       - footArea.getHeight() + oldHeight);
161                 }
162                 // bac.setMaxHeight(bac.getMaxHeight() - footArea.getHeight() + oldHeight);
163
if (bac.getFootnoteState() == 0) {
164                     Area ar = bac.getMainReferenceArea();
165                     decreaseMaxHeight(ar, footArea.getHeight() - oldHeight);
166                     footArea.setYPosition(basePos + footArea.getHeight());
167                 }
168             }
169         } catch (FOPException fope) {
170             return false;
171         }
172         return true;
173     }
174
175     protected static void decreaseMaxHeight(Area ar, int change) {
176         ar.setMaxHeight(ar.getMaxHeight() - change);
177         ArrayList JavaDoc children = ar.getChildren();
178         for (int i = 0; i < children.size(); i++) {
179             Object JavaDoc obj = children.get(i);
180             if (obj instanceof Area) {
181                 Area childArea = (Area)obj;
182                 decreaseMaxHeight(childArea, change);
183             }
184         }
185     }
186
187 }
188
Popular Tags