//
// $Id$
// From Philippe Le Hegaret (Philippe.Le_Hegaret@sophia.inria.fr)
//
// (c) COPYRIGHT MIT and INRIA, 1997.
// Please first read the full copyright statement in file COPYRIGHT.html

package org.w3c.css.properties.atsc;

import org.w3c.css.parser.CssSelectors;
import org.w3c.css.parser.CssStyle;
import org.w3c.css.properties.css.CssProperty;
import org.w3c.css.util.ApplContext;
import org.w3c.css.util.InvalidParamException;
import org.w3c.css.values.CssExpression;
import org.w3c.css.values.CssLength;
import org.w3c.css.values.CssOperator;
import org.w3c.css.values.CssValue;

/**
 * <H4>
 * &nbsp;&nbsp; 'border-bottom'
 * </H4>
 * <p/>
 * <EM>Value:</EM> &lt;border-bottom-width&gt; || &lt;border-style&gt; ||
 * &lt;color&gt;<BR>
 * <EM>Initial:</EM> not defined for shorthand properties<BR>
 * <EM>Applies to:</EM> all elements<BR>
 * <EM>Inherited:</EM> no<BR>
 * <EM>Percentage values:</EM> N/A<BR>
 * <p/>
 * This is a shorthand property for setting the width, style and color of an
 * element's bottom border.
 * <PRE>
 * H1 { border-bottom: thick solid red }
 * </PRE>
 * <p/>
 * The above rule will set the width, style and color of the border below the
 * H1 element. Omitted values will be set to their initial values:
 * <PRE>
 * H1 { border-bottom: thick solid }
 * </PRE>
 * <p/>
 * Since the color value is omitted in the example above, the border color will
 * be the same as the 'color' value of the element itself.
 * <p/>
 * Note that while the 'border-style' property accepts up to four values, this
 * property only accepts one style value.
 *
 * @version $Revision$
 */
public class CssBorderBottomATSC extends CssProperty implements CssOperator {

    CssBorderBottomWidthATSC width;
    CssBorderBottomStyleATSC style;
    CssBorderBottomColorATSC color;

    /**
     * Create a new CssBorderFaceATSC
     */
    public CssBorderBottomATSC() {
    }

    /**
     * Create a new CssBorderFace
     *
     * @param expression The expression for this property
     * @throws InvalidParamException The expression is incorrect
     */
    public CssBorderBottomATSC(ApplContext ac, CssExpression expression,
                               boolean check) throws InvalidParamException {

        CssValue val = null;
        char op = SPACE;
        boolean find = true;

        if (check && expression.getCount() > 3) {
            throw new InvalidParamException("unrecognize", ac);
        }

        boolean manyValues = (expression.getCount() > 1);

        setByUser();

        while (find) {
            find = false;
            val = expression.getValue();
            op = expression.getOperator();
            if (val == null)
                break;

            // if there are many values, we can't have inherit as one of them
            if (manyValues && val.equals(inherit)) {
                throw new InvalidParamException("unrecognize", null, null, ac);
            }

            if (op != SPACE)
                throw new InvalidParamException("operator",
                        Character.toString(op), ac);
            if (width == null) {
                try {
                    width = new CssBorderBottomWidthATSC(ac, expression);
                    find = true;
                } catch (InvalidParamException e) {
                    // nothing to do, style will test this value
                }
            }
            if (!find && style == null) {
                try {
                    style = new CssBorderBottomStyleATSC(ac, expression);
                    find = true;
                } catch (InvalidParamException e) {
                    // nothing to do, color will test this value
                }
            }
            if (!find && color == null) {
                // throws an exception if the value is not valid
                color = new CssBorderBottomColorATSC(ac, expression);
                find = true;
            }
        }
    }

    public CssBorderBottomATSC(ApplContext ac, CssExpression expression)
            throws InvalidParamException {
        this(ac, expression, false);
    }

    /**
     * Returns the value of this property
     */
    public Object get() {
        return width;
    }

    /**
     * Returns the color property
     */
    public CssValue getColor() {
        if (color != null) {
            return color.getColor();
        } else {
            return null;
        }
    }

    /**
     * Returns the width property
     */
    public CssValue getWidth() {
        if (width != null) {
            return width.getValue();
        } else {
            return null;
        }
    }

    /**
     * Returns the style property
     */
    public String getStyle() {
        if (style != null) {
            return style.getStyle();
        } else {
            return null;
        }
    }

    /**
     * Returns a string representation of the object.
     */
    public String toString() {
        String ret = "";
        if (width != null) {
            ret += width;
        }
        if (style != null) {
            if (!ret.equals("")) {
                ret += " ";
            }
            ret += style;
        }
        if (color != null) {
            if (!ret.equals("")) {
                ret += " ";
            }
            ret += color;
        }
        return ret;
    }

    /**
     * Returns the name of this property
     */
    public String getPropertyName() {
        return "border-bottom";
    }

    /**
     * Set this property to be important.
     * Overrides this method for a macro
     */
    public void setImportant() {
        if (width != null) {
            width.setImportant();
        }
        if (style != null) {
            style.setImportant();
        }
        if (color != null) {
            color.setImportant();
        }
    }

    /**
     * Returns true if this property is important.
     * Overrides this method for a macro
     */
    public boolean getImportant() {
        return ((width == null || width.getImportant()) &&
                (style == null || style.getImportant()) &&
                (color == null || color.getImportant()));
    }

    /**
     * Set the context.
     * Overrides this method for a macro
     *
     * @see org.w3c.css.css.CssCascadingOrder#order
     * @see org.w3c.css.css.StyleSheetParser#handleRule
     */
    public void setSelectors(CssSelectors selector) {
        super.setSelectors(selector);
        if (width != null) {
            width.setSelectors(selector);
        }
        if (style != null) {
            style.setSelectors(selector);
        }
        if (color != null) {
            color.setSelectors(selector);
        }
    }

    /**
     * Add this property to the CssStyle
     *
     * @param style The CssStyle
     */
    public void addToStyle(ApplContext ac, CssStyle style) {
        if (width != null) {
            width.addToStyle(ac, style);
        }
        if (this.style != null) {
            this.style.addToStyle(ac, style);
        }
        if (color != null) {
            color.addToStyle(ac, style);
        }
    }

    /**
     * Get this property in the style.
     *
     * @param style   The style where the property is
     * @param resolve if true, resolve the style to find this property
     */
    public CssProperty getPropertyInStyle(CssStyle style, boolean resolve) {
        if (resolve) {
            return ((ATSCStyle) style).getBorderRightATSC();
        } else {
            return ((ATSCStyle) style).cssBorderATSC.getRight();
        }
    }

    /**
     * Update the source file and the line.
     * Overrides this method for a macro
     *
     * @param line   The line number where this property is defined
     * @param source The source file where this property is defined
     */
    public void setInfo(int line, String source) {
        super.setInfo(line, source);
        if (width != null) {
            width.setInfo(line, source);
        }
        if (style != null) {
            style.setInfo(line, source);
        }
        if (color != null) {
            color.setInfo(line, source);
        }
    }

    /**
     * Compares two properties for equality.
     *
     * @param value The other property.
     */
    public boolean equals(CssProperty property) {
        if (property instanceof CssBorderBottomATSC) {
            CssBorderBottomATSC bottom = (CssBorderBottomATSC) property;
            return (width.equals(bottom.width) && style.equals(bottom.style)
                    && color.equals(bottom.color));
        } else {
            return false;
        }
    }

    void check() {
        if ((style != null)
                && (style.face.value == 0)) {
            if (width != null) {
                width.face.value = new CssLength();
            }
        }
    }
}