Module io.sf.carte.css4j
Package io.sf.carte.doc.style.css.property

Class IdentifierValue

java.lang.Object
io.sf.carte.doc.style.css.property.StyleValue
io.sf.carte.doc.style.css.property.PrimitiveValue
io.sf.carte.doc.style.css.property.TypedValue
io.sf.carte.doc.style.css.property.IdentifierValue
All Implemented Interfaces:
CSSPrimitiveValue, CSSTypedValue, CSSValue, Serializable, Cloneable
public class IdentifierValue extends TypedValue
Identifier value.
See Also:

  • Constructor Details

    • IdentifierValue

      public IdentifierValue()

    • IdentifierValue

      public IdentifierValue(String plainIdentifier)
      Fast path constructor.

      The provided identifier cannot have characters that should be escaped.

      Parameters:
      plainIdentifier - the identifier.

    • IdentifierValue

      protected IdentifierValue(IdentifierValue copied)

  • Method Details

    • setCssText

      public void setCssText(String cssText) throws DOMException
      Description copied from class: StyleValue
      Attempts to change this value to match the supplied css text.

      In css4j, it is not recommended to set property values using this method.

      Specified by:
      setCssText in interface CSSValue
      Overrides:
      setCssText in class StyleValue
      Parameters:
      cssText - the text value.
      Throws:
      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 read-only.

    • getMinifiedCssText

      public String getMinifiedCssText(String propertyName)
      Description copied from interface: CSSValue
      Gives a minified version of the css text of the property.

      It may be customized for the given property name.

      Specified by:
      getMinifiedCssText in interface CSSValue
      Overrides:
      getMinifiedCssText in class StyleValue
      Parameters:
      propertyName - the property name.
      Returns:
      the minified css text.

    • getStringValue

      public String getStringValue()
      Description copied from interface: CSSTypedValue
      If this value represents a string value, get it.

      This method is useful for values like strings, identifiers, URIs, element references, etc. For functions, it returns the function name.

      Specified by:
      getStringValue in interface CSSTypedValue
      Overrides:
      getStringValue in class TypedValue
      Returns:
      the string value.

    • setStringValue

      public void setStringValue(CSSValue.Type stringType, String stringValue) throws DOMException
      Description copied from interface: CSSTypedValue
      If this value is a string, identifier, URI, unicode wildcard or element reference, set its value.

      The string value has to be supplied unescaped and unquoted. If it is a unicode wildcard, it must not have the preceding U+.

      Specified by:
      setStringValue in interface CSSTypedValue
      Overrides:
      setStringValue in class TypedValue
      Parameters:
      stringType - the type of value.
      stringValue - the string value.
      Throws:
      DOMException - INVALID_ACCESS_ERR if the requested type of value is different to this one, or this value does not accept strings.
      NO_MODIFICATION_ALLOWED_ERR if this value is unmodifiable.

    • toRGBColor

      public RGBAColor toRGBColor() throws DOMException
      Description copied from interface: CSSTypedValue
      If this value represents a color, get it or transform to a RGB color.

      If the color does not map into the sRGB gamut, it is clamped.

      Specified by:
      toRGBColor in interface CSSTypedValue
      Overrides:
      toRGBColor in class TypedValue
      Returns:
      the RGBA color.
      Throws:
      DOMException - INVALID_ACCESS_ERR: if this value can't return a RGB color value (either is not a COLOR or not a typed value).
      NOT_SUPPORTED_ERR: if the conversion needs device color space information to be performed accurately.

    • writeCssText

      public void writeCssText(SimpleWriter wri) throws IOException
      Description copied from interface: CSSValue
      Serialize this value to a SimpleWriter.
      Specified by:
      writeCssText in interface CSSValue
      Parameters:
      wri - the SimpleWriter.
      Throws:
      IOException - if an error happened while writing.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class PrimitiveValue

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class PrimitiveValue

    • clone

      public IdentifierValue clone()
      Description copied from class: TypedValue
      Creates and returns a copy of this object.

      The object will be the same except for the subproperty flag, that will be disabled in the clone object.

      Specified by:
      clone in interface CSSTypedValue
      Specified by:
      clone in interface CSSValue
      Specified by:
      clone in class TypedValue
      Returns:
      a copy of this object.

    • getCssText

      public String getCssText()
      Description copied from class: StyleValue
      Get a string representation of the current value.
      Specified by:
      getCssText in interface CSSValue
      Specified by:
      getCssText in class StyleValue
      Returns:
      the css text representing the value of this property.