Package org.apache.pdfbox.pdmodel.graphics.color

Class PDIndexed

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ABBREVIATED_NAME
      The abbreviated name of this color space.
      static java.lang.String NAME
      The name of this color space.

      • Fields inherited from class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace

        array

    • Constructor Summary

      Constructors 
      Constructor Description
      PDIndexed()
      Constructor, default DeviceRGB, hival 255.
      PDIndexed​(COSArray indexedArray)
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      float[] calculateColorValues​(int index)
      Returns the components of the color for the given index.
      java.awt.image.ColorModel createColorModel​(int bpc)
      Create a Java color model for this colorspace.
      java.awt.image.ColorModel createColorModel​(int bpc, int mask)
      Create a Java color model for this colorspace including the given mask value.
      protected java.awt.color.ColorSpace createColorSpace()
      Create a Java colorspace for this colorspace.
      PDColorSpace getBaseColorSpace()
      This will get the color space that acts as the index for this color space.
      COSBase getCOSObject()
      Convert this standard java object to a COS object.
      int getHighValue()
      Get the highest value for the lookup.
      byte[] getLookupData()
      Get the lookup data table.
      java.lang.String getName()
      This will return the name of the color space.
      int getNumberOfComponents()
      This will return the number of color components.
      int lookupColor​(int lookupIndex, int componentNumber)
      This will perform a lookup into the color lookup table.
      void setBaseColorSpace​(PDColorSpace base)
      This will set the base color space.
      void setHighValue​(int high)
      This will set the highest value that is allowed.
      void setLookupColor​(int lookupIndex, int componentNumber, int color)
      This will set a color in the color lookup table.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • NAME

        public static final java.lang.String NAME
        The name of this color space.
        See Also:
        Constant Field Values

      • ABBREVIATED_NAME

        public static final java.lang.String ABBREVIATED_NAME
        The abbreviated name of this color space.
        See Also:
        Constant Field Values

    • Constructor Detail

      • PDIndexed

        public PDIndexed()
        Constructor, default DeviceRGB, hival 255.

      • PDIndexed

        public PDIndexed​(COSArray indexedArray)
        Constructor.
        Parameters:
        indexedArray - The array containing the indexed parameters

    • Method Detail

      • getNumberOfComponents

        public int getNumberOfComponents()
                          throws java.io.IOException
        This will return the number of color components. This will return the number of color components in the base color.
        Specified by:
        getNumberOfComponents in class PDColorSpace
        Returns:
        The number of components in this color space.
        Throws:
        java.io.IOException - If there is an error getting the number of color components.

      • getName

        public java.lang.String getName()
        This will return the name of the color space.
        Specified by:
        getName in class PDColorSpace
        Returns:
        The name of the color space.

      • createColorSpace

        protected java.awt.color.ColorSpace createColorSpace()
                                              throws java.io.IOException
        Create a Java colorspace for this colorspace.
        Specified by:
        createColorSpace in class PDColorSpace
        Returns:
        A color space that can be used for Java AWT operations.
        Throws:
        java.io.IOException - If there is an error creating the color space.

      • createColorModel

        public java.awt.image.ColorModel createColorModel​(int bpc)
                                           throws java.io.IOException
        Create a Java color model for this colorspace.
        Specified by:
        createColorModel in class PDColorSpace
        Parameters:
        bpc - The number of bits per component.
        Returns:
        A color model that can be used for Java AWT operations.
        Throws:
        java.io.IOException - If there is an error creating the color model.

      • createColorModel

        public java.awt.image.ColorModel createColorModel​(int bpc,
                                                  int mask)
                                           throws java.io.IOException
        Create a Java color model for this colorspace including the given mask value.
        Parameters:
        bpc - The number of bits per component of the indexed color model.
        mask - the mask value, -1 indicates no mask
        Returns:
        A color model that can be used for Java AWT operations.
        Throws:
        java.io.IOException - If there is an error creating the color model.

      • getBaseColorSpace

        public PDColorSpace getBaseColorSpace()
                               throws java.io.IOException
        This will get the color space that acts as the index for this color space.
        Returns:
        The base color space.
        Throws:
        java.io.IOException - If there is error creating the base color space.

      • setBaseColorSpace

        public void setBaseColorSpace​(PDColorSpace base)
        This will set the base color space.
        Parameters:
        base - The base color space to use as the index.

      • getHighValue

        public int getHighValue()
        Get the highest value for the lookup.
        Returns:
        The hival entry.

      • setHighValue

        public void setHighValue​(int high)
        This will set the highest value that is allowed. This cannot be higher than 255.
        Parameters:
        high - The highest value for the lookup table.

      • lookupColor

        public int lookupColor​(int lookupIndex,
                       int componentNumber)
                throws java.io.IOException
        This will perform a lookup into the color lookup table.
        Parameters:
        lookupIndex - The zero-based index into the table, should not exceed the high value.
        componentNumber - The component number, probably 1,2,3,3.
        Returns:
        The value that was from the lookup table.
        Throws:
        java.io.IOException - If there is an error looking up the color.

      • getLookupData

        public byte[] getLookupData()
                     throws java.io.IOException
        Get the lookup data table.
        Returns:
        a byte array containing the lookup data.
        Throws:
        java.io.IOException - if an error occurs.

      • setLookupColor

        public void setLookupColor​(int lookupIndex,
                           int componentNumber,
                           int color)
                    throws java.io.IOException
        This will set a color in the color lookup table.
        Parameters:
        lookupIndex - The zero-based index into the table, should not exceed the high value.
        componentNumber - The component number, probably 1,2,3,3.
        color - The color that will go into the table.
        Throws:
        java.io.IOException - If there is an error looking up the color.

      • calculateColorValues

        public float[] calculateColorValues​(int index)
                             throws java.io.IOException
        Returns the components of the color for the given index.
        Parameters:
        index - the index of the color value
        Returns:
        COSArray with the color components
        Throws:
        java.io.IOException - If the tint function is not supported