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

Class RatioValue

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.RatioValue
All Implemented Interfaces:
CSSPrimitiveValue, CSSRatioValue, CSSTypedValue, CSSValue, Serializable, Cloneable
public class RatioValue extends TypedValue implements CSSRatioValue
Ratio value.
See Also:

  • Constructor Details

    • RatioValue

      public RatioValue()

    • RatioValue

      protected RatioValue(RatioValue copied)

  • Method Details

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

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

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

    • getAntecedentValue

      public PrimitiveValue getAntecedentValue()
      Description copied from interface: CSSRatioValue
      Get the antecedent value (i.e. the 'a' in 'a/b').
      Specified by:
      getAntecedentValue in interface CSSRatioValue
      Returns:
      the antecedent value.

    • getConsequentValue

      public PrimitiveValue getConsequentValue()
      Description copied from interface: CSSRatioValue
      Get the consequent value (i.e. the 'b' in 'a/b').
      Specified by:
      getConsequentValue in interface CSSRatioValue
      Returns:
      the consequent value.

    • setAntecedentValue

      public void setAntecedentValue(PrimitiveValue antecedentValue) throws DOMException
      Set the first value in the ratio.
      Parameters:
      antecedentValue - the first value.
      Throws:
      DOMException - if the value is null or of the wrong type.

    • setConsequentValue

      public void setConsequentValue(PrimitiveValue consequentValue) throws DOMException
      Set the second value in the ratio.
      Parameters:
      consequentValue - the second value.
      Throws:
      DOMException - if the value is null or of the wrong type.

    • getComponent

      public PrimitiveValue 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.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class PrimitiveValue

    • equals

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

    • clone

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