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:
013: package org.w3c.dom.css;
014:
015: import 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: */
036: public 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: * @exception DOMException
044: * SYNTAX_ERR: Raised if the specified CSS string value has a syntax
045: * error and is unparsable.
046: * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this declaration is
047: * readonly or a property is readonly.
048: */
049: public String getCssText();
050:
051: /**
052: * The parsable textual representation of the declaration block
053: * (excluding the surrounding curly braces). Setting this attribute will
054: * result in the parsing of the new value and resetting of all the
055: * properties in the declaration block including the removal or addition
056: * of properties.
057: * @exception DOMException
058: * SYNTAX_ERR: Raised if the specified CSS string value has a syntax
059: * error and is unparsable.
060: * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this declaration is
061: * readonly or a property is readonly.
062: */
063: public void setCssText(String cssText) throws DOMException;
064:
065: /**
066: * Used to retrieve the value of a CSS property if it has been explicitly
067: * set within this declaration block.
068: * @param propertyName The name of the CSS property. See the CSS
069: * property index.
070: * @return Returns the value of the property if it has been explicitly
071: * set for this declaration block. Returns the empty string if the
072: * property has not been set.
073: */
074: public String getPropertyValue(String propertyName);
075:
076: /**
077: * Used to retrieve the object representation of the value of a CSS
078: * property if it has been explicitly set within this declaration block.
079: * This method returns <code>null</code> if the property is a shorthand
080: * property. Shorthand property values can only be accessed and modified
081: * as strings, using the <code>getPropertyValue</code> and
082: * <code>setProperty</code> methods.
083: * @param propertyName The name of the CSS property. See the CSS
084: * property index.
085: * @return Returns the value of the property if it has been explicitly
086: * set for this declaration block. Returns <code>null</code> if the
087: * property has not been set.
088: */
089: public CSSValue getPropertyCSSValue(String propertyName);
090:
091: /**
092: * Used to remove a CSS property if it has been explicitly set within
093: * this declaration block.
094: * @param propertyName The name of the CSS property. See the CSS
095: * property index.
096: * @return Returns the value of the property if it has been explicitly
097: * set for this declaration block. Returns the empty string if the
098: * property has not been set or the property name does not correspond
099: * to a known CSS property.
100: * @exception DOMException
101: * NO_MODIFICATION_ALLOWED_ERR: Raised if this declaration is readonly
102: * or the property is readonly.
103: */
104: public String removeProperty(String propertyName)
105: throws DOMException;
106:
107: /**
108: * Used to retrieve the priority of a CSS property (e.g. the
109: * <code>"important"</code> qualifier) if the property has been
110: * explicitly set in this declaration block.
111: * @param propertyName The name of the CSS property. See the CSS
112: * property index.
113: * @return A string representing the priority (e.g.
114: * <code>"important"</code>) if one exists. The empty string if none
115: * exists.
116: */
117: public String getPropertyPriority(String propertyName);
118:
119: /**
120: * Used to set a property value and priority within this declaration
121: * block.
122: * @param propertyName The name of the CSS property. See the CSS
123: * property index.
124: * @param value The new value of the property.
125: * @param priority The new priority of the property (e.g.
126: * <code>"important"</code>).
127: * @exception DOMException
128: * SYNTAX_ERR: Raised if the specified value has a syntax error and is
129: * unparsable.
130: * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this declaration is
131: * readonly or the property is readonly.
132: */
133: public void setProperty(String propertyName, String value,
134: String priority) 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: }
|