KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * $Id: LengthRange.java,v 1.7.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.Property;
54
55 /**
56  * a "progression-dimension" quantity
57  * ex. block-progression-dimension, inline-progression-dimension
58  * corresponds to the triplet min-height, height, max-height (or width)
59  */
60 public class LengthRange implements CompoundDatatype {
61
62     private Property minimum;
63     private Property optimum;
64     private Property maximum;
65     private static final int MINSET = 1;
66     private static final int OPTSET = 2;
67     private static final int MAXSET = 4;
68     private int bfSet = 0; // bit field
69 private boolean bChecked = false;
70
71     // From CompoundDatatype
72 public void setComponent(String JavaDoc sCmpnName, Property cmpnValue,
73                              boolean bIsDefault) {
74         if (sCmpnName.equals("minimum"))
75             setMinimum(cmpnValue, bIsDefault);
76         else if (sCmpnName.equals("optimum"))
77             setOptimum(cmpnValue, bIsDefault);
78         else if (sCmpnName.equals("maximum"))
79             setMaximum(cmpnValue, bIsDefault);
80     }
81
82     // From CompoundDatatype
83 public Property getComponent(String JavaDoc sCmpnName) {
84         if (sCmpnName.equals("minimum"))
85             return getMinimum();
86         else if (sCmpnName.equals("optimum"))
87             return getOptimum();
88         else if (sCmpnName.equals("maximum"))
89             return getMaximum();
90         else
91             return null; // SHOULDN'T HAPPEN
92 }
93
94     /**
95      * Set minimum value to min.
96      * @param min A Length value specifying the minimum value for this
97      * LengthRange.
98      * @param bIsDefault If true, this is set as a "default" value
99      * and not a user-specified explicit value.
100      */
101     protected void setMinimum(Property minimum, boolean bIsDefault) {
102         this.minimum = minimum;
103         if (!bIsDefault)
104             bfSet |= MINSET;
105     }
106
107
108     /**
109      * Set maximum value to max if it is >= optimum or optimum isn't set.
110      * @param max A Length value specifying the maximum value for this
111      * @param bIsDefault If true, this is set as a "default" value
112      * and not a user-specified explicit value.
113      */
114     protected void setMaximum(Property max, boolean bIsDefault) {
115         maximum = max;
116         if (!bIsDefault)
117             bfSet |= MAXSET;
118     }
119
120
121     /**
122      * Set the optimum value.
123      * @param opt A Length value specifying the optimum value for this
124      * @param bIsDefault If true, this is set as a "default" value
125      * and not a user-specified explicit value.
126      */
127     protected void setOptimum(Property opt, boolean bIsDefault) {
128         optimum = opt;
129         if (!bIsDefault)
130             bfSet |= OPTSET;
131     }
132
133     // Minimum is prioritaire, if explicit
134 private void checkConsistency() {
135         if (bChecked)
136             return;
137             // Make sure max >= min
138 // Must also control if have any allowed enum values!
139
140             /**
141              * *******************
142              * if (minimum.mvalue() > maximum.mvalue()) {
143              * if ((bfSet&MINSET)!=0) {
144              * // if minimum is explicit, force max to min
145              * if ((bfSet&MAXSET)!=0) {
146              * // Warning: min>max, resetting max to min
147              * MessageHandler.errorln("forcing max to min in LengthRange");
148              * }
149              * maximum = minimum ;
150              * }
151              * else {
152              * minimum = maximum; // minimum was default value
153              * }
154              * }
155              * // Now make sure opt <= max and opt >= min
156              * if (optimum.mvalue() > maximum.mvalue()) {
157              * if ((bfSet&OPTSET)!=0) {
158              * if ((bfSet&MAXSET)!=0) {
159              * // Warning: opt > max, resetting opt to max
160              * MessageHandler.errorln("forcing opt to max in LengthRange");
161              * optimum = maximum ;
162              * }
163              * else {
164              * maximum = optimum; // maximum was default value
165              * }
166              * }
167              * else {
168              * // opt is default and max is explicit or default
169              * optimum = maximum ;
170              * }
171              * }
172              * else if (optimum.mvalue() < minimum.mvalue()) {
173              * if ((bfSet&MINSET)!=0) {
174              * // if minimum is explicit, force opt to min
175              * if ((bfSet&OPTSET)!=0) {
176              * MessageHandler.errorln("forcing opt to min in LengthRange");
177              * }
178              * optimum = minimum ;
179              * }
180              * else {
181              * minimum = optimum; // minimum was default value
182              * }
183              * }
184              * *******$*******
185              */
186         bChecked = true;
187     }
188
189     public Property getMinimum() {
190         checkConsistency();
191         return this.minimum;
192     }
193
194     public Property getMaximum() {
195         checkConsistency();
196         return this.maximum;
197     }
198
199     public Property getOptimum() {
200         checkConsistency();
201         return this.optimum;
202     }
203
204 }
205
Popular Tags