org.w3c.dom.css.CSSValue Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2000 World Wide Web Consortium,
 * (Massachusetts Institute of Technology, Institut National de
 * Recherche en Informatique et en Automatique, Keio University). All
 * Rights Reserved. This program is distributed under the W3C's Software
 * Intellectual Property License. This program is distributed in the
 * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 * PURPOSE.
 * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
 */

package org.w3c.dom.css;

import org.w3c.dom.DOMException;

/**
 *  The CSSValue interface represents a simple or a complex 
 * value. A CSSValue object only occurs in a context of a CSS 
 * property. 
 * See also the Document Object Model (DOM) Level 2 Style Specification.
 * @since DOM Level 2
 */
public interface CSSValue {
    // UnitTypes
    /**
     * The value is inherited and the cssText contains "inherit".
     */
    public static final short CSS_INHERIT               = 0;
    /**
     * The value is a primitive value and an instance of the 
     * CSSPrimitiveValue interface can be obtained by using 
     * binding-specific casting methods on this instance of the 
     * CSSValue interface.
     */
    public static final short CSS_PRIMITIVE_VALUE       = 1;
    /**
     * The value is a CSSValue list and an instance of the 
     * CSSValueList interface can be obtained by using 
     * binding-specific casting methods on this instance of the 
     * CSSValue interface.
     */
    public static final short CSS_VALUE_LIST            = 2;
    /**
     * The value is a custom value.
     */
    public static final short CSS_CUSTOM                = 3;

    /**
     *  A string representation of the current value. 
     */
    public String getCssText();
    /**
     *  A string representation of the current value. 
     * @exception DOMException
     *    SYNTAX_ERR: Raised if the specified CSS string value has a syntax 
     *   error (according to the attached property) or is unparsable. 
     *   
INVALID_MODIFICATION_ERR: Raised if the specified CSS string 
     *   value represents a different type of values than the values allowed 
     *   by the CSS property.
     *   
 NO_MODIFICATION_ALLOWED_ERR: Raised if this value is readonly. 
     */
    public void setCssText(String cssText)
                       throws DOMException;

    /**
     *  A code defining the type of the value as defined above. 
     */
    public short getCssValueType();

}