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

Interface CSSColor

All Known Subinterfaces:
HSLColor, HWBColor, LABColor, LCHColor, RGBAColor, XYZColor
public interface CSSColor
A color.

  • Method Details

    • getColorModel

      CSSColorValue.ColorModel getColorModel()
      Get the color model that this color uses.

      If this methods returns the PROFILE value, this color belongs to a custom profile.

      Returns:
      the color model.

    • getColorSpace

      String getColorSpace()
      Get the color space to which this color belongs.

      See ColorSpace.

      Returns:
      the color space.

    • getAlpha

      CSSPrimitiveValue getAlpha()
      Get the alpha channel of this color.
      Returns:
      the alpha channel.

    • item

      CSSPrimitiveValue item(int index)
      Get the component of this color located at index.

      The alpha channel is considered the component 0, so the actual color component index starts at 1.

      Parameters:
      index - the index. 0 is always the alpha channel.
      Returns:
      the component, or null if the index is out of range.

    • component

      CSSNumberValue component(String name)
      Get the component of this color named by name.

      Percentages are normalized to numbers in the [0-1] interval, and angles to degrees.

      Parameters:
      name - the component name. alpha is the alpha channel.
      Returns:
      the component, or null if the component name is unknown.

    • getLength

      int getLength()
      The number of component values plus the alpha channel.
      Returns:
      the number of component values plus the alpha channel.

    • toNumberArray

      double[] toNumberArray() throws DOMException
      Convert the color components to a normalized form and put them in an array.

      The array does not include the alpha channel (that is, the array length is getLength() - 1).

      For RGB colors, the components are in the [0,1] interval.

      Returns:
      the array with the non-alpha normalized color components.
      Throws:
      DOMException - INVALID_STATE_ERR if the components cannot be converted to numbers.

    • isInGamut

      boolean isInGamut(String colorSpace)
      Is this color inside the given gamut?
      Parameters:
      colorSpace - the color gamut to check.
      Returns:
      true if this color is in the gamut of the given color space.
      Throws:
      DOMException - NOT_SUPPORTED_ERR if the color space is not supported, INVALID_STATE_ERR if the color components have to be converted to typed values.

    • toColorSpace

      CSSColor toColorSpace(String colorSpace) throws DOMException
      Convert this color to the given CSS color space.
      Parameters:
      colorSpace - the destination color space. The color spaces in ColorSpace are supported, as well as the other valid CSS space names (hsl and hwb).
      Returns:
      a color converted to the given color space.
      Throws:
      DOMException - if the color space is not supported.
      IllegalStateException - if the color components have to be converted to typed values.

    • toXYZ

      double[] toXYZ(Illuminant white)
      Convert this color to the XYZ space using the given reference illuminant.
      Parameters:
      white - the standard illuminant. If you need a conversion for an illuminant not included in the Illuminant enumeration, please use toXYZ(double[]).
      Returns:
      the color expressed in XYZ coordinates with the given white point.

    • toXYZ

      double[] toXYZ(double[] white)
      Convert this color to the XYZ space using the given reference white.

      If your white happens to be D65 or D50, please use toXYZ(Illuminant) instead which is faster.

      Parameters:
      white - the white point tristimulus value, normalized so the Y component is always 1.
      Returns:
      the color expressed in XYZ coordinates with the given white point.

    • deltaEOK

      float deltaEOK(CSSColor color)
      Compute the difference to the given color, according to ΔEOK.

      If the delta is inferior to 0.02, it is considered that the two colors are difficult to distinguish.

      Parameters:
      color - the color to compute the delta from.
      Returns:
      the ΔEOK.

    • toMinifiedString

      String toMinifiedString()
      Gives a minified string representation of this color.
      Returns:
      a minified serialization.

    • packInValue

      CSSColorValue packInValue()
      Pack this color into a new CSS value.

      Colors that come from a conversion sometimes aren't packed into a CSSColorValue, and this method provides a way to create one.

      Returns:
      the new CSS value packing this color.

    • clone

      CSSColor clone()
      Clone this color.
      Returns:
      a clone of this color.