fop/src/java/org/apache/fop/datatypes/Length.java

/*
 * $Id: Length.java,v 1.17 2003/03/05 20:38:23 jeremias Exp $
 * ============================================================================
 *                    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
 * APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
 * DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (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;

/**
 * A length quantity in XSL
 */
public class Length {

    /** Holds the length in millipoints. */
    protected int millipoints = 0;
    /** Indicates if the value has been computed, or not. */
    protected boolean bIsComputed = false;

    /**
     * Returns the length in 1/1000ths of a point (millipoints)
     * @return the length in millipoints
     */
    public int getValue() {
        if (!bIsComputed) {
            computeValue();
        }
        return millipoints;
    }

    /**
     * Computes the value.
     */
    protected void computeValue() {
    }


    /**
     * Sets the computed value.
     * @param millipoints the length in millipoints
     */
    protected void setComputedValue(int millipoints) {
        setComputedValue(millipoints, true);
    }

    /**
     * Sets the computed value.
     * @param millipoints the length in millipoints
     * @param bSetComputed True if the isComputed flag should be set.
     */
    protected void setComputedValue(int millipoints, boolean bSetComputed) {
        this.millipoints = millipoints;
        this.bIsComputed = bSetComputed;
    }

    /**
     * Indicates if the length has the "auto" value.
     * @return True if the length is set to "auto"
     */
    public boolean isAuto() {
        return false;
    }

    /**
     * Indicates if the length has been computed.
     * @return True if the length has been computed
     */
    public boolean isComputed() {
        return this.bIsComputed;
    }

    /**
     * Return the number of table units which are included in this
     * length specification.
     * This will always be 0 unless the property specification used
     * the proportional-column-width() function (only only table
     * column FOs).
     * <p>If this value is not 0, the actual value of the Length cannot
     * be known without looking at all of the columns in the table to
     * determine the value of a "table-unit".
     * @return The number of table units which are included in this
     * length specification.
     */
    public double getTableUnits() {
        return 0.0;
    }

    public void resolveTableUnit(double dTableUnit) {
    }

    public Numeric asNumeric() {
        return null;
    }

    /**
     * @see java.lang.Object#toString()
     */
    public String toString() {
        String s = millipoints + "mpt";
        return s;
    }

}