KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > fop > datatypes > LengthBase


1 /*
2  * $Id: LengthBase.java,v 1.5.2.1 2003/02/25 10:48:28 jeremias 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.datatypes;
52
53 import org.apache.fop.fo.FObj;
54 import org.apache.fop.fo.PropertyList;
55 import org.apache.fop.messaging.MessageHandler;
56
57 public class LengthBase implements PercentBase {
58     // Standard kinds of percent-based length
59 public static final int CUSTOM_BASE = 0;
60     public static final int FONTSIZE = 1;
61     public static final int INH_FONTSIZE = 2;
62     public static final int CONTAINING_BOX = 3;
63     public static final int CONTAINING_REFAREA = 4;
64
65     /**
66      * FO parent of the FO for which this property is to be calculated.
67      */
68     protected /* final */ FObj parentFO;
69
70     /**
71      * PropertyList for the FO where this property is calculated.
72      */
73     private /* final */ PropertyList propertyList;
74
75     /**
76      * One of the defined types of LengthBase
77      */
78     private /* final */ int iBaseType;
79
80     public LengthBase(FObj parentFO, PropertyList plist, int iBaseType) {
81         this.parentFO = parentFO;
82         this.propertyList = plist;
83         this.iBaseType = iBaseType;
84     }
85
86     /**
87      * Accessor for parentFO object from subclasses which define
88      * custom kinds of LengthBase calculations.
89      */
90     protected FObj getParentFO() {
91         return parentFO;
92     }
93
94     /**
95      * Accessor for propertyList object from subclasses which define
96      * custom kinds of LengthBase calculations.
97      */
98     protected PropertyList getPropertyList() {
99         return propertyList;
100     }
101
102     public int getDimension() {
103         return 1;
104     }
105
106     public double getBaseValue() {
107         return 1.0;
108     }
109
110     public int getBaseLength() {
111         switch (iBaseType) {
112         case FONTSIZE:
113             return propertyList.get("font-size").getLength().mvalue();
114         case INH_FONTSIZE:
115             return propertyList.getInherited("font-size").getLength().mvalue();
116         case CONTAINING_BOX:
117             // depends on property?? inline-progression vs block-progression
118 return parentFO.getContentWidth();
119         case CONTAINING_REFAREA: // example: start-indent, end-indent
120 {
121             FObj fo;
122             for (fo = parentFO; fo != null &&!fo.generatesReferenceAreas();
123                     fo = fo.getParent());
124             return (fo != null ? fo.getContentWidth() : 0);
125         }
126         case CUSTOM_BASE:
127             MessageHandler.errorln("!!! LengthBase.getBaseLength() called on CUSTOM_BASE type !!!");
128             return 0;
129         default:
130             MessageHandler.errorln("Unknown base type for LengthBase.");
131             return 0;
132         }
133     }
134
135 }
136
137
Popular Tags