org.w3c.css.values.CssAngle Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of css-validator Show documentation
W3C CSS Validator
The newest version!
//
// $Id: CssAngle.java,v 1.9 2010-01-06 09:27:44 ylafon Exp $
// From Philippe Le Hegaret ([email protected])
//
// (c) COPYRIGHT MIT, ERCIM and Keio, 1997-2010.
// Please first read the full copyright statement in file COPYRIGHT.html
package org.w3c.css.values;

import org.w3c.css.util.ApplContext;
import org.w3c.css.util.InvalidParamException;
import org.w3c.css.util.Util;

import java.util.HashMap;

/**
 * Angle
 * 
 * 
Angle units are used with aural cascading style sheets.
 * 

 * 
These are the legal angle units:
 * 

 * 

 * deg: degrees
 * 
grad: gradians
 * 
rad: radians
 * 
 * 
 * Values in these units may be negative. They should be normalized to the
 * range 0-360deg by the UA. For example, -10deg and 350deg are equivalent.
 *
 * @version $Revision: 1.9 $
 */
public class CssAngle extends CssValue implements CssValueFloat {

    public static final int type = CssTypes.CSS_ANGLE;

    public final int getType() {
        return type;
    }

    Float value;
    String unit;

    static final String deg = "deg";
    static final String rad = "rad";
    static final String grad = "grad";

    private static final HashMap allowed_values;

    static Float defaultValue = new Float(0);

    static {
        allowed_values = new HashMap();
        allowed_values.put(deg, deg);
        allowed_values.put(rad, rad);
        allowed_values.put(grad, grad);
    }

    /**
     * Create a new CssAngle.
     */
    public CssAngle() {
        this(defaultValue);
    }

    /**
     * Create a new CssAngle
     */
    public CssAngle(float v) {
        this(new Float(v));
    }

    /**
     * Create a new CssAngle
     */
    public CssAngle(Float angle) {
        value = angle;
    }

    /**
     * Set the value of this angle.
     *
     * @param s  The string representation of the angle
     * @param ac For errors and warnings reports
     * @throws InvalidParamException The unit is incorrect
     */
    public void set(String s, ApplContext ac) throws InvalidParamException {
        s = s.toLowerCase();
        int length = s.length();
        String unit;
        //float v;
        if (s.indexOf("grad") == -1) {
            unit = s.substring(length - 3, length);
            unit = allowed_values.get(unit);
            if (unit == null) {
                throw new InvalidParamException("unit", unit, ac);
            }
            value = new Float(s.substring(0, length - 3));
        } else {
            unit = grad;
            value = new Float(s.substring(0, length - 4));
        }
        this.unit = unit; // there is no unit by default
    }

    /**
     * Returns the current value
     */
    public Object get() {
        return value;
    }

    public float getValue() {
        return value.floatValue();
    }

    /**
     * Returns the current value
     */
    public String getUnit() {
        return unit;
    }

    /**
     * Returns a string representation of the object.
     */
    public String toString() {

        if (value.floatValue() != 0) {
            return Util.displayFloat(value) + getUnit();
        } else {
            return Util.displayFloat(value);
        }
    }

    /**
     * Compares two values for equality.
     *
     * @param value The other value.
     */
    public boolean equals(Object value) {
        return (value instanceof CssAngle &&
                this.value.equals(((CssAngle) value).value) &&
                unit == ((CssAngle) value).unit);
    }


    private float normalize(float degree) {
        while (degree < 0) {
            degree += 360;
        }
        while (degree > 360) {
            degree -= 360;
        }
        return degree;
    }

    //@@FIXME I should return the remainder for all ...

    public float getDegree() {
        float angle = value.floatValue();
        if (unit == deg) {
            return normalize(angle);
        } else if (unit == rad) {
            return normalize(angle * (180.f / ((float) Math.PI)));
        } else if (unit == grad) {
            return normalize(angle * (9.f / 10.f));
        }

        System.err.println("[ERROR] in org.w3c.css.values.CssAngle");
        System.err.println("[ERROR] Please report (" + unit + ")");
        return (float) 0;
    }

    public boolean isDegree() {
        return unit == deg;
    }

    public boolean isGradian() {
        return unit == grad;
    }

    public boolean isRadian() {
        return unit == rad;
    }


}