001/*
002 * Copyright (c) 2000 World Wide Web Consortium,
003 * (Massachusetts Institute of Technology, Institut National de
004 * Recherche en Informatique et en Automatique, Keio University). All
005 * Rights Reserved. This program is distributed under the W3C's Software
006 * Intellectual Property License. This program is distributed in the
007 * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
008 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
009 * PURPOSE.
010 * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
011 */
012
013package org.w3c.dom.css;
014
015import org.w3c.dom.DOMException;
016
017/**
018 *  The <code>CSSStyleDeclaration</code> interface represents a single CSS
019 * declaration block. This interface may be used to determine the style
020 * properties currently set in a block or to set style properties explicitly
021 * within the block.
022 * <p> While an implementation may not recognize all CSS properties within a
023 * CSS declaration block, it is expected to provide access to all specified
024 * properties in the style sheet through the <code>CSSStyleDeclaration</code>
025 *  interface. Furthermore, implementations that support a specific level of
026 * CSS should correctly handle CSS shorthand properties for that level. For
027 * a further discussion of shorthand properties, see the
028 * <code>CSS2Properties</code> interface.
029 * <p> This interface is also used to provide a read-only access to the
030 * computed values of an element. See also the <code>ViewCSS</code>
031 * interface.  The CSS Object Model doesn't provide an access to the
032 * specified or actual values of the CSS cascade.
033 * <p>See also the <a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Style-20001113'>Document Object Model (DOM) Level 2 Style Specification</a>.
034 * @since DOM Level 2
035 */
036public interface CSSStyleDeclaration {
037    /**
038     *  The parsable textual representation of the declaration block
039     * (excluding the surrounding curly braces). Setting this attribute will
040     * result in the parsing of the new value and resetting of all the
041     * properties in the declaration block including the removal or addition
042     * of properties.
043     */
044    public String getCssText();
045    /**
046     *  The parsable textual representation of the declaration block
047     * (excluding the surrounding curly braces). Setting this attribute will
048     * result in the parsing of the new value and resetting of all the
049     * properties in the declaration block including the removal or addition
050     * of properties.
051     * @exception DOMException
052     *   SYNTAX_ERR: Raised if the specified CSS string value has a syntax
053     *   error and is unparsable.
054     *   <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this declaration is
055     *   readonly or a property is readonly.
056     */
057    public void setCssText(String cssText)
058                       throws DOMException;
059
060    /**
061     *  Used to retrieve the value of a CSS property if it has been explicitly
062     * set within this declaration block.
063     * @param propertyName  The name of the CSS property. See the CSS
064     *   property index.
065     * @return  Returns the value of the property if it has been explicitly
066     *   set for this declaration block. Returns the empty string if the
067     *   property has not been set.
068     */
069    public String getPropertyValue(String propertyName);
070
071    /**
072     *  Used to retrieve the object representation of the value of a CSS
073     * property if it has been explicitly set within this declaration block.
074     * This method returns <code>null</code> if the property is a shorthand
075     * property. Shorthand property values can only be accessed and modified
076     * as strings, using the <code>getPropertyValue</code> and
077     * <code>setProperty</code> methods.
078     * @param propertyName  The name of the CSS property. See the CSS
079     *   property index.
080     * @return  Returns the value of the property if it has been explicitly
081     *   set for this declaration block. Returns <code>null</code> if the
082     *   property has not been set.
083     */
084    public CSSValue getPropertyCSSValue(String propertyName);
085
086    /**
087     *  Used to remove a CSS property if it has been explicitly set within
088     * this declaration block.
089     * @param propertyName  The name of the CSS property. See the CSS
090     *   property index.
091     * @return  Returns the value of the property if it has been explicitly
092     *   set for this declaration block. Returns the empty string if the
093     *   property has not been set or the property name does not correspond
094     *   to a known CSS property.
095     * @exception DOMException
096     *   NO_MODIFICATION_ALLOWED_ERR: Raised if this declaration is readonly
097     *   or the property is readonly.
098     */
099    public String removeProperty(String propertyName)
100                                 throws DOMException;
101
102    /**
103     *  Used to retrieve the priority of a CSS property (e.g. the
104     * <code>"important"</code> qualifier) if the priority has been
105     * explicitly set in this declaration block.
106     * @param propertyName  The name of the CSS property. See the CSS
107     *   property index.
108     * @return  A string representing the priority (e.g.
109     *   <code>"important"</code>) if the property has been explicitly set
110     *   in this declaration block and has a priority specified. The empty
111     *   string otherwise.
112     */
113    public String getPropertyPriority(String propertyName);
114
115    /**
116     *  Used to set a property value and priority within this declaration
117     * block. <code>setProperty</code> permits to modify a property or add a
118     * new one in the declaration block. Any call to this method may modify
119     * the order of properties in the <code>item</code> method.
120     * @param propertyName  The name of the CSS property. See the CSS
121     *   property index.
122     * @param value  The new value of the property.
123     * @param priority  The new priority of the property (e.g.
124     *   <code>"important"</code>) or the empty string if none.
125     * @exception DOMException
126     *   SYNTAX_ERR: Raised if the specified value has a syntax error and is
127     *   unparsable.
128     *   <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this declaration is
129     *   readonly or the property is readonly.
130     */
131    public void setProperty(String propertyName,
132                            String value,
133                            String priority)
134                            throws DOMException;
135
136    /**
137     *  The number of properties that have been explicitly set in this
138     * declaration block. The range of valid indices is 0 to length-1
139     * inclusive.
140     */
141    public int getLength();
142
143    /**
144     *  Used to retrieve the properties that have been explicitly set in this
145     * declaration block. The order of the properties retrieved using this
146     * method does not have to be the order in which they were set. This
147     * method can be used to iterate over all properties in this declaration
148     * block.
149     * @param index  Index of the property name to retrieve.
150     * @return  The name of the property at this ordinal position. The empty
151     *   string if no property exists at this position.
152     */
153    public String item(int index);
154
155    /**
156     *  The CSS rule that contains this declaration block or <code>null</code>
157     * if this <code>CSSStyleDeclaration</code> is not attached to a
158     * <code>CSSRule</code>.
159     */
160    public CSSRule getParentRule();
161
162}