From 1672403dc3ec2a8efbd5998b236ecf63c3ad9e30 Mon Sep 17 00:00:00 2001 From: William Victor Mote Date: Sun, 13 Jul 2003 00:59:45 +0000 Subject: [PATCH] style changes only git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@196688 13f79535-47bb-0310-9956-ffa450edef68 --- .../org/apache/fop/datatypes/FODimension.java | 26 +++++++------ .../org/apache/fop/datatypes/FixedLength.java | 34 +++++++++------- src/java/org/apache/fop/datatypes/Keep.java | 39 ++++++++++++++++++- 3 files changed, 73 insertions(+), 26 deletions(-) diff --git a/src/java/org/apache/fop/datatypes/FODimension.java b/src/java/org/apache/fop/datatypes/FODimension.java index 2a839a3b7..e8d8d3a55 100644 --- a/src/java/org/apache/fop/datatypes/FODimension.java +++ b/src/java/org/apache/fop/datatypes/FODimension.java @@ -3,34 +3,34 @@ * ============================================================================ * 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 @@ -42,12 +42,12 @@ * (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 . For more information on the Apache * Software Foundation, please see . - */ + */ package org.apache.fop.datatypes; /** @@ -60,7 +60,11 @@ public class FODimension { 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; diff --git a/src/java/org/apache/fop/datatypes/FixedLength.java b/src/java/org/apache/fop/datatypes/FixedLength.java index b6b246949..445bc4e93 100644 --- a/src/java/org/apache/fop/datatypes/FixedLength.java +++ b/src/java/org/apache/fop/datatypes/FixedLength.java @@ -3,34 +3,34 @@ * ============================================================================ * 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 @@ -42,12 +42,12 @@ * (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 . For more information on the Apache * Software Foundation, please see . - */ + */ package org.apache.fop.datatypes; import org.apache.fop.fo.expr.Numeric; @@ -58,8 +58,9 @@ 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)); @@ -67,13 +68,15 @@ public class FixedLength extends Length { /** * 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); @@ -82,6 +85,8 @@ public class FixedLength extends Length { /** * 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) { @@ -112,6 +117,9 @@ public class FixedLength extends Length { setComputedValue((int)(dvalue * 1000)); } + /** + * @return Numeric equivalent of this + */ public Numeric asNumeric() { return new Numeric(this); } diff --git a/src/java/org/apache/fop/datatypes/Keep.java b/src/java/org/apache/fop/datatypes/Keep.java index 996708b88..1d9628356 100644 --- a/src/java/org/apache/fop/datatypes/Keep.java +++ b/src/java/org/apache/fop/datatypes/Keep.java @@ -60,10 +60,19 @@ public class Keep implements CompoundDatatype { 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")) { @@ -75,7 +84,11 @@ public class Keep implements CompoundDatatype { } } - // 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(); @@ -88,33 +101,55 @@ public class Keep implements CompoundDatatype { } } + /** + * @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"; -- 2.39.5