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

Class FunctionValue

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.FunctionValue
All Implemented Interfaces:
CSSFunctionValue, CSSPrimitiveValue, CSSTypedValue, CSSValue, Serializable, Cloneable
Direct Known Subclasses:
GradientValue, MathFunctionValue, TransformFunction
public class FunctionValue extends TypedValue implements CSSFunctionValue
Function value.
See Also:

  • Constructor Details

    • FunctionValue

      public FunctionValue()

    • FunctionValue

      protected FunctionValue(CSSValue.Type type)

    • FunctionValue

      protected FunctionValue(FunctionValue copied)

  • Method Details

    • getArguments

      public LinkedCSSValueList getArguments()
      Description copied from interface: CSSFunctionValue
      Get the arguments of this function.
      Specified by:
      getArguments in interface CSSFunctionValue
      Returns:
      the list of arguments of this function.

    • getComponent

      public StyleValue getComponent(int index)
      Description copied from class: TypedValue
      Get the component at index.

      This method allows to access the components regardless of them being indexed or not. It is convenient to perform common tasks at the components (like when computing values).

      Overrides:
      getComponent in class TypedValue
      Parameters:
      index - the index. For colors, index 0 is always the alpha channel.
      Returns:
      the component, or null if the index is incorrect.

    • setComponent

      public void setComponent(int index, StyleValue component)
      Description copied from class: TypedValue
      If this value has components, set the component at index.

      This method allows to access the components regardless of them being formally indexed or not. It is convenient to perform common tasks at the components (like when computing values).

      Overrides:
      setComponent in class TypedValue
      Parameters:
      index - the index. For colors, index 0 is always the alpha channel. Setting a component at an index that does not exist has no effect.
      component - the new component. Cannot be a KEYWORD nor a SHORTHAND. For colors, must be a primitive value (that is, either TYPED or a PROXY).

    • getComponentCount

      public int getComponentCount()
      Description copied from class: TypedValue
      Get the number of components of this value.
      Overrides:
      getComponentCount in class TypedValue
      Returns:
      the number of components, 0 if none.

    • getFunctionName

      public String getFunctionName()
      Description copied from interface: CSSFunctionValue
      Get the function name.
      Specified by:
      getFunctionName in interface CSSFunctionValue
      Returns:
      the function name.

    • 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.

    • getMinifiedCssText

      public String getMinifiedCssText(String pname)
      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:
      pname - the property name.
      Returns:
      the minified css text.

    • 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.

    • getStringValue

      public String getStringValue() throws DOMException
      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
      Returns:
      the string value.
      Throws:
      DOMException - INVALID_ACCESS_ERR if this value is not a string.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class PrimitiveValue

    • equals

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

    • clone

      public FunctionValue 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 CSSFunctionValue
      Specified by:
      clone in interface CSSTypedValue
      Specified by:
      clone in interface CSSValue
      Specified by:
      clone in class TypedValue
      Returns:
      a copy of this object.