org.w3c.dom.css
Interface CSSStyleDeclaration


public interface CSSStyleDeclaration

The CSSStyleDeclaration interface represents a single CSS declaration block. This interface may be used to determine the style properties currently set in a block or to set style properties explicitly within the block.

While an implementation may not recognize all CSS properties within a CSS declaration block, it is expected to provide access to all specified properties in the style sheet through the CSSStyleDeclaration interface. Furthermore, implementations that support a specific level of CSS should correctly handle CSS shorthand properties for that level. For a further discussion of shorthand properties, see the CSS2Properties interface.

This interface is also used to provide a read-only access to the computed values of an element. See also the ViewCSS interface. The CSS Object Model doesn't provide an access to the specified or actual values of the CSS cascade.

See also the Document Object Model (DOM) Level 2 Style Specification.

Since:
DOM Level 2

Method Summary
 String sample code for java.lang.String definition code for java.lang.String getCssText sample code for org.w3c.dom.css.CSSStyleDeclaration.getCssText() definition code for org.w3c.dom.css.CSSStyleDeclaration.getCssText() ()
          The parsable textual representation of the declaration block (excluding the surrounding curly braces).
 int getLength sample code for org.w3c.dom.css.CSSStyleDeclaration.getLength() definition code for org.w3c.dom.css.CSSStyleDeclaration.getLength() ()
          The number of properties that have been explicitly set in this declaration block.
 CSSRule sample code for org.w3c.dom.css.CSSRule definition code for org.w3c.dom.css.CSSRule getParentRule sample code for org.w3c.dom.css.CSSStyleDeclaration.getParentRule() definition code for org.w3c.dom.css.CSSStyleDeclaration.getParentRule() ()
          The CSS rule that contains this declaration block or null if this CSSStyleDeclaration is not attached to a CSSRule.
 CSSValue sample code for org.w3c.dom.css.CSSValue definition code for org.w3c.dom.css.CSSValue getPropertyCSSValue sample code for org.w3c.dom.css.CSSStyleDeclaration.getPropertyCSSValue(java.lang.String) definition code for org.w3c.dom.css.CSSStyleDeclaration.getPropertyCSSValue(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  propertyName)
          Used to retrieve the object representation of the value of a CSS property if it has been explicitly set within this declaration block.
 String sample code for java.lang.String definition code for java.lang.String getPropertyPriority sample code for org.w3c.dom.css.CSSStyleDeclaration.getPropertyPriority(java.lang.String) definition code for org.w3c.dom.css.CSSStyleDeclaration.getPropertyPriority(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  propertyName)
          Used to retrieve the priority of a CSS property (e.g.
 String sample code for java.lang.String definition code for java.lang.String getPropertyValue sample code for org.w3c.dom.css.CSSStyleDeclaration.getPropertyValue(java.lang.String) definition code for org.w3c.dom.css.CSSStyleDeclaration.getPropertyValue(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  propertyName)
          Used to retrieve the value of a CSS property if it has been explicitly set within this declaration block.
 String sample code for java.lang.String definition code for java.lang.String item sample code for org.w3c.dom.css.CSSStyleDeclaration.item(int) definition code for org.w3c.dom.css.CSSStyleDeclaration.item(int) (int index)
          Used to retrieve the properties that have been explicitly set in this declaration block.
 String sample code for java.lang.String definition code for java.lang.String removeProperty sample code for org.w3c.dom.css.CSSStyleDeclaration.removeProperty(java.lang.String) definition code for org.w3c.dom.css.CSSStyleDeclaration.removeProperty(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  propertyName)
          Used to remove a CSS property if it has been explicitly set within this declaration block.
 void setCssText sample code for org.w3c.dom.css.CSSStyleDeclaration.setCssText(java.lang.String) definition code for org.w3c.dom.css.CSSStyleDeclaration.setCssText(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  cssText)
           
 void setProperty sample code for org.w3c.dom.css.CSSStyleDeclaration.setProperty(java.lang.String, java.lang.String, java.lang.String) definition code for org.w3c.dom.css.CSSStyleDeclaration.setProperty(java.lang.String, java.lang.String, java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  propertyName, String sample code for java.lang.String definition code for java.lang.String  value, String sample code for java.lang.String definition code for java.lang.String  priority)
          Used to set a property value and priority within this declaration block.
 

Method Detail

getCssText sample code for org.w3c.dom.css.CSSStyleDeclaration.getCssText() definition code for org.w3c.dom.css.CSSStyleDeclaration.getCssText()

String sample code for java.lang.String definition code for java.lang.String  getCssText()
The parsable textual representation of the declaration block (excluding the surrounding curly braces). Setting this attribute will result in the parsing of the new value and resetting of all the properties in the declaration block including the removal or addition of properties.

Throws:
DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.DOMException - SYNTAX_ERR: Raised if the specified CSS string value has a syntax error and is unparsable.
NO_MODIFICATION_ALLOWED_ERR: Raised if this declaration is readonly or a property is readonly.

setCssText sample code for org.w3c.dom.css.CSSStyleDeclaration.setCssText(java.lang.String) definition code for org.w3c.dom.css.CSSStyleDeclaration.setCssText(java.lang.String)

void setCssText(String sample code for java.lang.String definition code for java.lang.String  cssText)
                throws DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.DOMException 
Throws:
DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.DOMException

getPropertyValue sample code for org.w3c.dom.css.CSSStyleDeclaration.getPropertyValue(java.lang.String) definition code for org.w3c.dom.css.CSSStyleDeclaration.getPropertyValue(java.lang.String)

String sample code for java.lang.String definition code for java.lang.String  getPropertyValue(String sample code for java.lang.String definition code for java.lang.String  propertyName)
Used to retrieve the value of a CSS property if it has been explicitly set within this declaration block.

Parameters:
propertyName - The name of the CSS property. See the CSS property index.
Returns:
Returns the value of the property if it has been explicitly set for this declaration block. Returns the empty string if the property has not been set.

getPropertyCSSValue sample code for org.w3c.dom.css.CSSStyleDeclaration.getPropertyCSSValue(java.lang.String) definition code for org.w3c.dom.css.CSSStyleDeclaration.getPropertyCSSValue(java.lang.String)

CSSValue sample code for org.w3c.dom.css.CSSValue definition code for org.w3c.dom.css.CSSValue  getPropertyCSSValue(String sample code for java.lang.String definition code for java.lang.String  propertyName)
Used to retrieve the object representation of the value of a CSS property if it has been explicitly set within this declaration block. This method returns null if the property is a shorthand property. Shorthand property values can only be accessed and modified as strings, using the getPropertyValue and setProperty methods.

Parameters:
propertyName - The name of the CSS property. See the CSS property index.
Returns:
Returns the value of the property if it has been explicitly set for this declaration block. Returns null if the property has not been set.

removeProperty sample code for org.w3c.dom.css.CSSStyleDeclaration.removeProperty(java.lang.String) definition code for org.w3c.dom.css.CSSStyleDeclaration.removeProperty(java.lang.String)

String sample code for java.lang.String definition code for java.lang.String  removeProperty(String sample code for java.lang.String definition code for java.lang.String  propertyName)
                      throws DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.DOMException 
Used to remove a CSS property if it has been explicitly set within this declaration block.

Parameters:
propertyName - The name of the CSS property. See the CSS property index.
Returns:
Returns the value of the property if it has been explicitly set for this declaration block. Returns the empty string if the property has not been set or the property name does not correspond to a known CSS property.
Throws:
DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this declaration is readonly or the property is readonly.

getPropertyPriority sample code for org.w3c.dom.css.CSSStyleDeclaration.getPropertyPriority(java.lang.String) definition code for org.w3c.dom.css.CSSStyleDeclaration.getPropertyPriority(java.lang.String)

String sample code for java.lang.String definition code for java.lang.String  getPropertyPriority(String sample code for java.lang.String definition code for java.lang.String  propertyName)
Used to retrieve the priority of a CSS property (e.g. the "important" qualifier) if the property has been explicitly set in this declaration block.

Parameters:
propertyName - The name of the CSS property. See the CSS property index.
Returns:
A string representing the priority (e.g. "important") if one exists. The empty string if none exists.

setProperty sample code for org.w3c.dom.css.CSSStyleDeclaration.setProperty(java.lang.String, java.lang.String, java.lang.String) definition code for org.w3c.dom.css.CSSStyleDeclaration.setProperty(java.lang.String, java.lang.String, java.lang.String)

void setProperty(String sample code for java.lang.String definition code for java.lang.String  propertyName,
                 String sample code for java.lang.String definition code for java.lang.String  value,
                 String sample code for java.lang.String definition code for java.lang.String  priority)
                 throws DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.DOMException 
Used to set a property value and priority within this declaration block.

Parameters:
propertyName - The name of the CSS property. See the CSS property index.
value - The new value of the property.
priority - The new priority of the property (e.g. "important").
Throws:
DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.DOMException - SYNTAX_ERR: Raised if the specified value has a syntax error and is unparsable.
NO_MODIFICATION_ALLOWED_ERR: Raised if this declaration is readonly or the property is readonly.

getLength sample code for org.w3c.dom.css.CSSStyleDeclaration.getLength() definition code for org.w3c.dom.css.CSSStyleDeclaration.getLength()

int getLength()
The number of properties that have been explicitly set in this declaration block. The range of valid indices is 0 to length-1 inclusive.


item sample code for org.w3c.dom.css.CSSStyleDeclaration.item(int) definition code for org.w3c.dom.css.CSSStyleDeclaration.item(int)

String sample code for java.lang.String definition code for java.lang.String  item(int index)
Used to retrieve the properties that have been explicitly set in this declaration block. The order of the properties retrieved using this method does not have to be the order in which they were set. This method can be used to iterate over all properties in this declaration block.

Parameters:
index - Index of the property name to retrieve.
Returns:
The name of the property at this ordinal position. The empty string if no property exists at this position.

getParentRule sample code for org.w3c.dom.css.CSSStyleDeclaration.getParentRule() definition code for org.w3c.dom.css.CSSStyleDeclaration.getParentRule()

CSSRule sample code for org.w3c.dom.css.CSSRule definition code for org.w3c.dom.css.CSSRule  getParentRule()
The CSS rule that contains this declaration block or null if this CSSStyleDeclaration is not attached to a CSSRule.