* ============================================================================
* The Apache Software License, Version 1.1
* ============================================================================
- *
+ *
* Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
- *
+ *
* Redistribution and use in source and binary forms, with or without modifica-
* tion, are permitted provided that the following conditions are met:
- *
+ *
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
- *
+ *
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
- *
+ *
* 3. The end-user documentation included with the redistribution, if any, must
* include the following acknowledgment: "This product includes software
* developed by the Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself, if
* and wherever such third-party acknowledgments normally appear.
- *
+ *
* 4. The names "FOP" and "Apache Software Foundation" must not be used to
* endorse or promote products derived from this software without prior
* written permission. For written permission, please contact
* apache@apache.org.
- *
+ *
* 5. Products derived from this software may not be called "Apache", nor may
* "Apache" appear in their name, without prior written permission of the
* Apache Software Foundation.
- *
+ *
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* ============================================================================
- *
+ *
* This software consists of voluntary contributions made by many individuals
* on behalf of the Apache Software Foundation and was originally created by
* James Tauber <jtauber@jtauber.com>. For more information on the Apache
* Software Foundation, please see <http://www.apache.org/>.
- */
+ */
package org.apache.fop.datatypes;
/**
public int ipd;
public int bpd;
-
+ /**
+ * Constructor
+ * @param ipd length (in millipoints ??) of the inline-progression-direction
+ * @param bpd length (in millipoints ??) of the block-progression-direction
+ */
public FODimension(int ipd, int bpd) {
this.ipd = ipd;
this.bpd = bpd;
* ============================================================================
* The Apache Software License, Version 1.1
* ============================================================================
- *
+ *
* Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
- *
+ *
* Redistribution and use in source and binary forms, with or without modifica-
* tion, are permitted provided that the following conditions are met:
- *
+ *
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
- *
+ *
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
- *
+ *
* 3. The end-user documentation included with the redistribution, if any, must
* include the following acknowledgment: "This product includes software
* developed by the Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself, if
* and wherever such third-party acknowledgments normally appear.
- *
+ *
* 4. The names "FOP" and "Apache Software Foundation" must not be used to
* endorse or promote products derived from this software without prior
* written permission. For written permission, please contact
* apache@apache.org.
- *
+ *
* 5. Products derived from this software may not be called "Apache", nor may
* "Apache" appear in their name, without prior written permission of the
* Apache Software Foundation.
- *
+ *
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* ============================================================================
- *
+ *
* This software consists of voluntary contributions made by many individuals
* on behalf of the Apache Software Foundation and was originally created by
* James Tauber <jtauber@jtauber.com>. For more information on the Apache
* Software Foundation, please see <http://www.apache.org/>.
- */
+ */
package org.apache.fop.datatypes;
import org.apache.fop.fo.expr.Numeric;
public class FixedLength extends Length {
/**
- * Set the length given a number of relative units and the current
- * font size in base units.
+ * Set the length given
+ * @param numRelUnits the number of relative units
+ * @param iCurFontSize the current font size in base units.
*/
public FixedLength(double numRelUnits, int iCurFontSize) {
setComputedValue((int)(numRelUnits * (double)iCurFontSize));
/**
* Set the length given a number of units and a unit name.
+ * @param numUnits quantity of input units
+ * @param units input unit specifier (in, cm, etc.)
*/
public FixedLength(double numUnits, String units) {
convert(numUnits, units);
}
/**
- * set the length as a number of base units
+ * @param baseUnits the length as a number of base units (millipoints)
*/
public FixedLength(int baseUnits) {
setComputedValue(baseUnits);
/**
* Convert the given length to a dimensionless integer representing
* a whole number of base units (milli-points).
+ * @param dvalue quantity of input units
+ * @param unit input unit specifier (in, cm, etc.)
*/
protected void convert(double dvalue, String unit) {
setComputedValue((int)(dvalue * 1000));
}
+ /**
+ * @return Numeric equivalent of this
+ */
public Numeric asNumeric() {
return new Numeric(this);
}
private Property withinColumn;
private Property withinPage;
+ /**
+ * Constructor
+ */
public Keep() {
}
- // From CompoundDatatype
+
+ /**
+ * From CompoundDatatype
+ * @param sCmpnName name of compound property to set
+ * @param cmpnValue property containing value to be set
+ * @param bIsDefault not used (??)
+ */
public void setComponent(String sCmpnName, Property cmpnValue,
boolean bIsDefault) {
if (sCmpnName.equals("within-line")) {
}
}
- // From CompoundDatatype
+ /**
+ * From CompoundDatatype
+ * @param sCmpnName compound property name
+ * @return property corresponding to compound property string
+ */
public Property getComponent(String sCmpnName) {
if (sCmpnName.equals("within-line")) {
return getWithinLine();
}
}
+ /**
+ * @param withinLine withinLine property to set
+ * @param bIsDefault not used (??)
+ */
public void setWithinLine(Property withinLine, boolean bIsDefault) {
this.withinLine = withinLine;
}
+ /**
+ * @param withinColumn withinColumn property to set
+ * @param bIsDefault not used (??)
+ */
protected void setWithinColumn(Property withinColumn,
boolean bIsDefault) {
this.withinColumn = withinColumn;
}
+ /**
+ * @param withinPage withinPage property to set
+ * @param bIsDefault not used (??)
+ */
public void setWithinPage(Property withinPage, boolean bIsDefault) {
this.withinPage = withinPage;
}
+ /**
+ * @return the withinLine property
+ */
public Property getWithinLine() {
return this.withinLine;
}
+ /**
+ * @return the withinColumn property
+ */
public Property getWithinColumn() {
return this.withinColumn;
}
+ /**
+ * @return the withinPage property
+ */
public Property getWithinPage() {
return this.withinPage;
}
/**
* Not sure what to do here. There isn't really a meaningful single value.
+ * @return String representation
*/
public String toString() {
return "Keep";
projects / xmlgraphics-fop.git / commitdiff