KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * $Id: StaticContent.java,v 1.18.2.8 2003/04/11 00:24:39 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.fo.pagination.*;
56 import org.apache.fop.layout.Area;
57 import org.apache.fop.apps.FOPException;
58
59 public class StaticContent extends AbstractFlow {
60
61     public static class Maker extends FObj.Maker {
62         public FObj make(FObj parent, PropertyList propertyList,
63                          String JavaDoc systemId, int line, int column)
64             throws FOPException {
65             return new StaticContent(parent, propertyList,
66                                      systemId, line, column);
67         }
68     }
69
70     public static FObj.Maker maker() {
71         return new StaticContent.Maker();
72     }
73
74     protected StaticContent(FObj parent, PropertyList propertyList,
75                             String JavaDoc systemId, int line, int column)
76         throws FOPException {
77         super(parent, propertyList, systemId, line, column);
78         setFlowName(getProperty("flow-name").getString());
79         pageSequence.addStaticContent(this);
80     }
81
82     public String JavaDoc getName() {
83         return "fo:static-content";
84     }
85
86     public int layout(Area area, Region region) throws FOPException {
87
88         int numChildren = this.children.size();
89         // Set area absolute height so that link rectangles will be drawn correctly in xsl-before and xsl-after
90
String JavaDoc regionClass = "none";
91         if (region != null) {
92             regionClass = region.getRegionClass();
93         } else {
94             if (getFlowName().equals("xsl-region-before")) {
95                 regionClass = RegionBefore.REGION_CLASS;
96             } else if (getFlowName().equals("xsl-region-after")) {
97                 regionClass = RegionAfter.REGION_CLASS;
98             } else if (getFlowName().equals("xsl-region-start")) {
99                 regionClass = RegionStart.REGION_CLASS;
100             } else if (getFlowName().equals("xsl-region-end")) {
101                 regionClass = RegionEnd.REGION_CLASS;
102             }
103
104         }
105
106         if (area instanceof org.apache.fop.layout.AreaContainer)
107             ((org.apache.fop.layout.AreaContainer)area).setAreaName(regionClass);
108
109         area.setAbsoluteHeight(0); // Ytop relative to self!
110

111         setContentWidth(area.getContentWidth());
112
113         for (int i = 0; i < numChildren; i++) {
114             FObj fo = (FObj)children.get(i);
115
116             int status;
117             if (Status.isIncomplete((status = fo.layout(area)))) {
118                 // in fact all should be laid out and clip, error etc depending on 'overflow'
119
log.warn("Some static content could not fit in the area.");
120                 this.marker = i;
121                 if ((i != 0) && (status == Status.AREA_FULL_NONE)) {
122                     status = Status.AREA_FULL_SOME;
123                 }
124                 return (status);
125             }
126         }
127         resetMarker();
128         return Status.OK;
129     }
130
131     // flowname checking is more stringient for static content currently
132
protected void setFlowName(String JavaDoc name) throws FOPException {
133         if (name == null || name.equals("")) {
134             throw new FOPException("A 'flow-name' is required for "
135                                    + getName() + ".", systemId, line, column);
136         } else {
137             _flowName = name;
138         }
139
140     }
141
142 }
143
Popular Tags