Module org.sejda.sambox
Package org.sejda.sambox.pdmodel.graphics.color

Class PDColor

java.lang.Object
org.sejda.sambox.pdmodel.graphics.color.PDColor
public final class PDColor extends Object
A color value, consisting of one or more color components, or for pattern color spaces, a name and optional color components. Color values are not associated with any given color space.

Instances of PDColor are immutable.

Author:
John Hewson

  • Constructor Details

    • PDColor

      public PDColor(COSArray array, PDColorSpace colorSpace)
      Creates a PDColor containing the given color value.
      Parameters:
      array - a COS array containing the color value
      colorSpace - color space in which the color value is defined

    • PDColor

      public PDColor(float[] components, PDColorSpace colorSpace)
      Creates a PDColor containing the given color component values.
      Parameters:
      components - array of color component values
      colorSpace - color space in which the components are defined

    • PDColor

      public PDColor(COSName patternName, PDColorSpace colorSpace)
      Creates a PDColor containing the given pattern name.
      Parameters:
      patternName - the name of a pattern in a pattern dictionary
      colorSpace - color space in which the pattern is defined

    • PDColor

      public PDColor(float[] components, COSName patternName, PDColorSpace colorSpace)
      Creates a PDColor containing the given color component values and pattern name.
      Parameters:
      components - array of color component values
      patternName - the name of a pattern in a pattern dictionary
      colorSpace - color space in which the pattern/components are defined

  • Method Details

    • getComponents

      public float[] getComponents()
      Returns the components of this color value.
      Returns:
      the components of this color value

    • getPatternName

      public COSName getPatternName()
      Returns the pattern name from this color value.
      Returns:
      the pattern name from this color value

    • isPattern

      public boolean isPattern()
      Returns true if this color value is a pattern.
      Returns:
      true if this color value is a pattern

    • toRGB

      public int toRGB() throws IOException
      Returns the packed RGB value for this color, if any.
      Returns:
      RGB
      Throws:
      IOException - if the color conversion fails
      IllegalStateException - if this color value is a pattern.

    • toCOSArray

      public COSArray toCOSArray()
      Returns this color value as a COS array
      Returns:
      the color value as a COS array

    • toComponentsCOSArray

      public COSArray toComponentsCOSArray()
      Returns:
      the color value as a COSarray containing onlye the components values, no pattern name.

    • getColorSpace

      public PDColorSpace getColorSpace()
      Returns the color space in which this color value is defined.

    • toString

      public String toString()
      Overrides:
      toString in class Object