Module org.w3c.css.om
Package org.w3c.css.om

Interface CSSStyleDeclaration

All Superinterfaces:
CSSStyleDeclaration
All Known Implementing Classes:
CSSOMComputedStyle, CSSOMStoredStyleDeclaration, CSSOMStyleDeclaration, CSSOMSVGComputedStyle, CSSOMSVGStyleDeclaration, SVGStylableElement.OverrideStyleDeclaration, SVGStylableElement.StyleDeclaration
public interface CSSStyleDeclaration extends CSSStyleDeclaration
CSS style declaration.

  • Method Summary

    Modifier and Type
    Method
    Description
    default CSSStyleValue
    getCSSStyleValue(String propertyName)
    Gets the object representation of the value of a CSS property if it has been explicitly set for this declaration block.
    String
    getCssText()
    A parsable serialization of the declaration.
    int
    getLength()
    The number of properties in this declaration.
    CSSRule
    getParentRule()
    Retrieves the CSS rule that contains this declaration block.
    default CSSValue
    getPropertyCSSValue(String propertyName)
    Gives the legacy object representation of the value of a CSS property if it has been explicitly set within this declaration block.
    String
    getPropertyPriority(String propertyName)
    Get the priority that was set to the given property in this declaration.
    String
    getPropertyValue(String propertyName)
    Gets the text value of a CSS property if it has been explicitly set within this declaration block.
    String
    item(int index)
    The name of the property at index index in this declaration.
    String
    removeProperty(String propertyName)
    Remove the given property from this declaration.
    void
    setCssText(String cssText)
    Parse the given text, and set the contents of this declaration according to it.
    void
    setProperty(String propertyName, String value, String priority)
    Set the value of a property in this declaration, with the given priority.

  • Method Details

    • getCssText

      String getCssText()
      A parsable serialization of the declaration.
      Specified by:
      getCssText in interface CSSStyleDeclaration
      Returns:
      the textual representation of the declaration.

    • setCssText

      void setCssText(String cssText) throws DOMException
      Parse the given text, and set the contents of this declaration according to it.
      Specified by:
      setCssText in interface CSSStyleDeclaration
      Parameters:
      cssText - the serialized style declaration.
      Throws:
      DOMException

    • removeProperty

      String removeProperty(String propertyName) throws DOMException
      Remove the given property from this declaration.
      Specified by:
      removeProperty in interface CSSStyleDeclaration
      Parameters:
      propertyName - the name of the property to remove.
      Returns:
      the value of the removed property, or the empty string if that property was not explicitly set in this declaration.
      Throws:
      DOMException

    • getPropertyPriority

      String getPropertyPriority(String propertyName)
      Get the priority that was set to the given property in this declaration.
      Specified by:
      getPropertyPriority in interface CSSStyleDeclaration
      Parameters:
      propertyName - the name of the property.
      Returns:
      the priority string, or the empty string if no priority was set.

    • setProperty

      void setProperty(String propertyName, String value, String priority) throws DOMException
      Set the value of a property in this declaration, with the given priority.
      Specified by:
      setProperty in interface CSSStyleDeclaration
      Parameters:
      propertyName - the name of the property.
      value - the property value.
      priority - the priority.
      Throws:
      DOMException

    • getLength

      int getLength()
      The number of properties in this declaration.
      Specified by:
      getLength in interface CSSStyleDeclaration
      Returns:
      the number of properties in this declaration.

    • item

      String item(int index)
      The name of the property at index index in this declaration.
      Specified by:
      item in interface CSSStyleDeclaration
      Parameters:
      index - the index.
      Returns:
      the name of the property at the given index, or null if the index is less than zero, or greater or equal to the length of this declaration.

    • getPropertyCSSValue

      default CSSValue getPropertyCSSValue(String propertyName)
      Gives the legacy 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.

      Specified by:
      getPropertyCSSValue in interface CSSStyleDeclaration
      Parameters:
      propertyName - The name of the CSS property.
      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, or the implementation does not support legacy object values.

    • getCSSStyleValue

      default CSSStyleValue getCSSStyleValue(String propertyName)
      Gets the object representation of the value of a CSS property if it has been explicitly set for this declaration block.

      If the declaration was created by a factory with the IEVALUES flag enabled, the compatibility values shall appear in the cssText serializations, but its value won't be returned by this method unless no other valid value was previously specified for the property.

      Parameters:
      propertyName - The name of the CSS property.
      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, is a shorthand or this implementation does not support it.

    • getPropertyValue

      String getPropertyValue(String propertyName)
      Gets the text value of a CSS property if it has been explicitly set within this declaration block.

      If the declaration was created by a factory with the IEVALUES flag enabled, the compatibility values shall appear in the cssText serializations, but its value won't be returned by this method unless no other valid value was previously specified for the property.

      Specified by:
      getPropertyValue in interface CSSStyleDeclaration
      Parameters:
      propertyName - The name of the CSS property.
      Returns:
      the value of the property if it has been explicitly set for this declaration block, or the empty string if the property has not been set or is a shorthand that could not be serialized.

    • getParentRule

      CSSRule getParentRule()
      Retrieves the CSS rule that contains this declaration block.
      Specified by:
      getParentRule in interface CSSStyleDeclaration
      Returns:
      the CSS rule that contains this declaration block or null if this CSSStyleDeclaration is not attached to a CSSRule.