KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * $Id: RegionStart.java,v 1.3.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.*;
55 import org.apache.fop.layout.RegionArea;
56 import org.apache.fop.layout.BorderAndPadding;
57 import org.apache.fop.layout.BackgroundProps;
58 import org.apache.fop.apps.FOPException;
59
60 /**
61  * Class modeling the fo:region-start object.
62  *
63  * @see <a HREF="@XSLFO-STD@#fo_region-start"
64        target="_xslfostd">@XSLFO-STDID@
65  * &para;6.4.16</a>
66  */

67 public class RegionStart extends Region {
68
69     public static class Maker extends FObj.Maker {
70         public FObj make(FObj parent, PropertyList propertyList,
71                         String JavaDoc systemId, int line, int column)
72             throws FOPException {
73             return new RegionStart(parent, propertyList,
74                                    systemId, line, column);
75         }
76
77     }
78
79     public static FObj.Maker maker() {
80         return new RegionStart.Maker();
81     }
82
83     public static final String JavaDoc REGION_CLASS = "start";
84
85
86     protected RegionStart(FObj parent, PropertyList propertyList,
87                           String JavaDoc systemId, int line, int column)
88         throws FOPException {
89         super(parent, propertyList, systemId, line, column);
90     }
91
92     public String JavaDoc getName() {
93         return "fo:region-start";
94     }
95
96     RegionArea makeRegionArea(int allocationRectangleXPosition,
97                               int allocationRectangleYPosition,
98                               int allocationRectangleWidth,
99                               int allocationRectangleHeight,
100                               boolean beforePrecedence,
101                               boolean afterPrecedence, int beforeExtent,
102                               int afterExtent) {
103         int extent = this.properties.get("extent").getLength().mvalue();
104
105         int startY = allocationRectangleYPosition;
106         int startH = allocationRectangleHeight;
107         if (beforePrecedence) {
108             startY -= beforeExtent;
109             startH -= beforeExtent;
110         }
111         if (afterPrecedence)
112             startH -= afterExtent;
113         RegionArea area = new RegionArea(allocationRectangleXPosition,
114                 startY, extent, startH);
115         area.setBackground(propMgr.getBackgroundProps());
116         return area;
117     }
118
119     RegionArea makeRegionArea(int allocationRectangleXPosition,
120                               int allocationRectangleYPosition,
121                               int allocationRectangleWidth,
122                               int allocationRectangleHeight) {
123
124         // Common Border, Padding, and Background Properties
125
BorderAndPadding bap = propMgr.getBorderAndPadding();
126         BackgroundProps bProps = propMgr.getBackgroundProps();
127
128         // this.properties.get("clip");
129
// this.properties.get("display-align");
130
int extent = this.properties.get("extent").getLength().mvalue();
131         // this.properties.get("overflow");
132
// this.properties.get("region-name");
133
// this.properties.get("reference-orientation");
134
// this.properties.get("writing-mode");
135

136         return makeRegionArea(allocationRectangleXPosition,
137                               allocationRectangleYPosition,
138                               allocationRectangleWidth, extent, false, false,
139                               0, 0);
140     }
141
142     protected String JavaDoc getDefaultRegionName() {
143         return "xsl-region-start";
144     }
145
146     public String JavaDoc getRegionClass() {
147         return REGION_CLASS;
148     }
149
150     public int getExtent() {
151         return properties.get("extent").getLength().mvalue();
152     }
153 }
154
Popular Tags