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

Class NumberValue

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.NumberValue
All Implemented Interfaces:
CSSNumberValue, CSSPrimitiveValue, CSSTypedValue, CSSValue, Serializable, Cloneable
Direct Known Subclasses:
PercentageValue
public class NumberValue extends TypedValue implements CSSNumberValue
Number-specific value.
See Also:

  • Field Details

    • realvalue

      protected float realvalue

  • Constructor Details

    • NumberValue

      public NumberValue()
      Instantiates a number value which is set to CSS_NUMBER by default.

    • NumberValue

      protected NumberValue(NumberValue copied)

  • Method Details

    • getUnitType

      public short getUnitType()
      Description copied from interface: CSSPrimitiveValue
      If this is a NUMERIC value, get its unit type.

      You can also find the unit types of mathematical functions and calc() expressions, although this may be computationally expensive:

      Specified by:
      getUnitType in interface CSSPrimitiveValue
      Returns:
      the unit type as in CSSUnit, or CSS_INVALID if the type is not numeric or the unit is not valid.

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

    • serializeAbsolute

      public void serializeAbsolute(SimpleWriter wri) throws IOException
      Throws:
      IOException

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

    • minifyAbsolute

      public String minifyAbsolute(String propertyName)

    • setFloatValue

      public void setFloatValue(short unitType, float floatValue) throws DOMException
      Description copied from interface: CSSTypedValue
      If this value is numeric, set a float value with the given unit.
      Specified by:
      setFloatValue in interface CSSTypedValue
      Parameters:
      unitType - the unit type according to CSSUnit.
      floatValue - the float value.
      Throws:
      DOMException - INVALID_ACCESS_ERR if the unit is not a CSSUnit one, or this value is not a number.
      NO_MODIFICATION_ALLOWED_ERR if this value is unmodifiable.

    • setFloatValuePt

      public void setFloatValuePt(float floatValue)

    • setIntegerValue

      public void setIntegerValue(int intValue)

    • setExpectInteger

      public void setExpectInteger() throws DOMException
      Description copied from interface: CSSPrimitiveValue
      This value is expected to contain an integer.

      If this value is a non-integer number, an exception will be thrown immediately.

      If this value is a calc() that ever produces a non-integer number, the value shall be rounded to the nearest integer.

      If the value is a proxy that ever produces other than an integer number (without calc() involvement), an exception should be thrown later.

      Specified by:
      setExpectInteger in interface CSSPrimitiveValue
      Overrides:
      setExpectInteger in class PrimitiveValue
      Throws:
      DOMException - TYPE_MISMATCH_ERR if the value is a constant number and not an integer.

    • roundToInteger

      public void roundToInteger() throws DOMException
      Description copied from interface: CSSNumberValue
      Round this value to the nearest integer.
      Specified by:
      roundToInteger in interface CSSNumberValue
      Throws:
      DOMException - TYPE_MISMATCH_ERR if this value is not a plain <number>.

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

    • isCalculatedNumber

      public boolean isCalculatedNumber()
      Description copied from interface: CSSTypedValue
      Test whether this is a numeric value that was the result of a calc() expression.
      Specified by:
      isCalculatedNumber in interface CSSTypedValue
      Returns:
      true if this is a numeric value, and it was produced as the output of a calculation (instead of declared as a plain, constant numeric value).

    • setCalculatedNumber

      public void setCalculatedNumber(boolean calculated)
      Sets whether this number is the result of a calculation.
      Specified by:
      setCalculatedNumber in interface CSSNumberValue
      Parameters:
      calculated - true if this number was calculated.

    • setAbsolutizedUnit

      public void setAbsolutizedUnit()
      Set that the value that this number represents was originally specified as a calculation or as a relative unit, but comes from being either calculated or absolutized.

      This has consequences as to how the number is serialized.

    • setMaximumFractionDigits

      public void setMaximumFractionDigits(int maxFractionDigits)
      Set the maximum fraction digits to use in the serialization of this number when it was not specified or is the result of a calculation.
      Specified by:
      setMaximumFractionDigits in interface CSSNumberValue
      Parameters:
      maxFractionDigits - the maximum fraction digits.

    • isNegativeNumber

      public boolean isNegativeNumber()
      Description copied from interface: CSSPrimitiveValue
      Test whether this is a numeric value that is less than zero.
      Specified by:
      isNegativeNumber in interface CSSPrimitiveValue
      Returns:
      true if this is a numeric value and its value is negative.

    • isNumberZero

      public boolean isNumberZero()
      Description copied from class: TypedValue
      Is this value a number set to a value of zero, or an absolute value less than 1e-5 ?
      Specified by:
      isNumberZero in interface CSSTypedValue
      Overrides:
      isNumberZero in class TypedValue
      Returns:
      true if this is a number and is set to zero (or equivalently small value).

    • getFloatValue

      public float getFloatValue()
      Gets the float value in the current unit.
      Specified by:
      getFloatValue in interface CSSTypedValue
      Returns:
      The float value.

    • getFloatValue

      public float getFloatValue(short unitType) throws DOMException
      Gets a float value in a specified unit.
      Specified by:
      getFloatValue in interface CSSTypedValue
      Overrides:
      getFloatValue in class TypedValue
      Parameters:
      unitType - A unit code to get the float value, like CSS_NUMBER, CSS_PERCENTAGE, CSS_PT or CSS_EX.
      Returns:
      The float value in the specified unit.
      Throws:
      DOMException - INVALID_ACCESS_ERR if the CSS value can't be converted into the specified unit.

    • floatValueConversion

      public static float floatValueConversion(float fvalue, short declType, short unitType) throws DOMException
      Converts a float value, expressed in declType units, to unitType units.
      Parameters:
      fvalue - the float value to convert.
      declType - the declared type of the value.
      unitType - the desired unit type.
      Returns:
      the value converted to the unitType unit.
      Throws:
      DOMException - if the unit conversion could not be done.

    • getDimensionUnitText

      public String getDimensionUnitText()
      Gives the text representation of the dimension unit, if this value represents a dimension.
      Returns:
      the text representation of the dimension unit, or the empty string if this value does not represent a dimension.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class PrimitiveValue

    • equals

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

    • clone

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

    • createCSSNumberValue

      public static NumberValue createCSSNumberValue(short unit, float floatValue)