nextapp.echo.app.DecimalExtent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of echo3-app Show documentation
Echo Web Framework API
There is a newer version: 3.1.0
/* 
 * This file is part of the Echo Web Application Framework (hereinafter "Echo").
 * Copyright (C) 2002-2009 NextApp, Inc.
 *
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 */

package nextapp.echo.app;

/**
 * A representation of an integer linear distance with units. DecimalExtent
 * objects are immutable once constructed.
 * This object should only be used when an extent requires a fractional (decimal) part, in all other
 * cases the plain Extent object should be used.
 */
public class DecimalExtent extends Extent {

    /**
     * The decimal value.
     */
    private final double decimalValue;
    
    /**
     * Creates a new DecimalExtent with pixel units.
     * 
     * @param decimalValue the value of the extent in pixels
     */
    public DecimalExtent(double decimalValue) {
        this(decimalValue, Extent.PX);
    }
    
    /**
     * Creates a new DecimalExtent.
     * 
     * @param decimalValue the value of the extent
     * @param units the units of the value, one of the following constants:
     *        
     *         PC: Pixels
     *         PERCENT: Percent (of size of containing 
     *          component)
     *         PT: Points
     *         CM: Centimeters
     *         MM: Millimeters
     *         IN: Inches
     *         EM: Ems (height of 'M' character)
     *         EX: Exs (height of 'x' character)
     *         PC: Picas
     *        
     */
    public DecimalExtent(double decimalValue, int units) {
        super((int) Math.round(decimalValue), units);
        this.decimalValue = decimalValue;
    }
    
    /**
     * @see java.lang.Object#equals(java.lang.Object)
     */
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        } else if (o == null) {
            return false;
        } else if (o instanceof DecimalExtent) {
            DecimalExtent that = (DecimalExtent) o;
            return this.decimalValue == that.decimalValue && this.getUnits() == that.getUnits();
        } else if (o instanceof Extent) {
            Extent that = (Extent) o;
            return this.decimalValue == that.getValue() && this.getUnits() == that.getUnits();
        } else {
            return false;
        }
    }    
    
    /**
     * Returns the decimal value of the extent.
     * 
     * @return the decimal value
     */
    public double getDecimalValue() {
        return decimalValue;
    }

    /**
     * @see nextapp.echo.app.Extent#toMm()
     */
    public int toMm() {
        switch (getUnits()) {
        case MM:
            return (int) decimalValue;
        case CM:
            return (int) (decimalValue * 10);
        case IN:
            return (int) (decimalValue * 25.4);
        case PT:
            return (int) ((decimalValue / 72) * 25.4);
        case PC:
            return (int) ((decimalValue / 6) * 25.4);
        }
        throw new IllegalStateException("Cannot convert to mm.");
    }
    
    /**
     * @see nextapp.echo.app.Extent#toPoint()
     */
    public int toPoint() {
        switch (getUnits()) {
        case PT:
            return (int) decimalValue;
        case PC:
            return (int) (decimalValue * 12);
        case IN:
            return (int) (decimalValue * 72);
        case MM:
            return (int) ((decimalValue / 25.4) * 72);
        case CM:
            return (int) ((decimalValue / 2.54) * 72);
        }
        throw new IllegalStateException("Cannot convert to pt.");
    }

    /**
     * Returns a string describing the state of the Extent.  
     * For debugging purposes only, do not rely on formatting.
     * 
     * @see java.lang.Object#toString()
     */
    public String toString() {
        return decimalValue + getUnitsString(getUnits());
    }
}