KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > fop > fo > pagination > RegionBody


1 /*
2  * $Id: RegionBody.java,v 1.11.2.6 2003/04/11 00:24:41 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.pagination;
52
53 // FOP
54 import org.apache.fop.fo.FObj;
55 import org.apache.fop.fo.PropertyList;
56 import org.apache.fop.fo.properties.Overflow;
57 import org.apache.fop.apps.FOPException;
58 import org.apache.fop.layout.RegionArea;
59 import org.apache.fop.layout.BodyRegionArea;
60 import org.apache.fop.layout.BorderAndPadding;
61 import org.apache.fop.layout.BackgroundProps;
62 import org.apache.fop.layout.MarginProps;
63
64 /**
65  * Class modeling the fo:region-body object.
66  *
67  * @see <a HREF="@XSLFO-STD@#fo_region-body"
68        target="_xslfostd">@XSLFO-STDID@
69  * &para;6.4.13</a>
70  */
71 public class RegionBody extends Region {
72
73
74     public static class Maker extends FObj.Maker {
75         public FObj make(FObj parent, PropertyList propertyList,
76                         String JavaDoc systemId, int line, int column)
77             throws FOPException {
78             return new RegionBody(parent, propertyList, systemId, line, column);
79         }
80
81     }
82
83     public static FObj.Maker maker() {
84         return new RegionBody.Maker();
85     }
86
87     public static final String JavaDoc REGION_CLASS = "body";
88
89     protected RegionBody(FObj parent, PropertyList propertyList,
90                         String JavaDoc systemId, int line, int column)
91         throws FOPException {
92         super(parent, propertyList, systemId, line, column);
93     }
94
95     public String JavaDoc getName() {
96         return "fo:region-body";
97     }
98
99     RegionArea makeRegionArea(int allocationRectangleXPosition,
100                               int allocationRectangleYPosition,
101                               int allocationRectangleWidth,
102                               int allocationRectangleHeight) {
103
104         // Common Border, Padding, and Background Properties
105 BorderAndPadding bap = propMgr.getBorderAndPadding();
106         BackgroundProps bProps = propMgr.getBackgroundProps();
107
108         // Common Margin Properties-Block
109 MarginProps mProps = propMgr.getMarginProps();
110
111         // this.properties.get("clip");
112 // this.properties.get("display-align");
113 // this.properties.get("region-name");
114 // this.properties.get("reference-orientation");
115 // this.properties.get("writing-mode");
116
117         BodyRegionArea body = new BodyRegionArea(allocationRectangleXPosition
118                                                  + mProps.marginLeft,
119                                                  allocationRectangleYPosition
120                                                  - mProps.marginTop,
121                                                  allocationRectangleWidth
122                                                  - mProps.marginLeft
123                                                  - mProps.marginRight,
124                                                  allocationRectangleHeight
125                                                  - mProps.marginTop
126                                                  - mProps.marginBottom);
127
128         body.setBackground(propMgr.getBackgroundProps());
129
130         int overflow = this.properties.get("overflow").getEnum();
131         String JavaDoc columnCountAsString =
132             this.properties.get("column-count").getString();
133         int columnCount = 1;
134         try {
135             if( columnCountAsString.charAt(0) >= '0' && columnCountAsString.charAt(0)<= '9') {
136                 columnCount = Integer.parseInt(columnCountAsString);
137             } else {
138                 log.error("Bad value on region body 'column-count'");
139             }
140         } catch (NumberFormatException JavaDoc nfe) {
141             log.error("Bad value on region body 'column-count'");
142             columnCount = 1;
143         }
144         if ((columnCount > 1) && (overflow == Overflow.SCROLL)) {
145             // recover by setting 'column-count' to 1. This is allowed but
146 // not required by the spec.
147 log.error("Setting 'column-count' to 1 because "
148                                    + "'overflow' is set to 'scroll'");
149             columnCount = 1;
150         }
151         body.setColumnCount(columnCount);
152
153         int columnGap =
154             this.properties.get("column-gap").getLength().mvalue();
155         body.setColumnGap(columnGap);
156
157         return body;
158     }
159
160     protected String JavaDoc getDefaultRegionName() {
161         return "xsl-region-body";
162     }
163
164     public String JavaDoc getRegionClass() {
165         return REGION_CLASS;
166     }
167
168 }
169
Popular Tags