Class ImageParameters

java.lang.Object
org.apache.pdfbox.util.ImageParameters

public class ImageParameters extends Object
This contains all of the image parameters for in inlined image.
Version:
$Revision: 1.4 $
Author:
Ben Litchfield
  • Constructor Details

    • ImageParameters

      public ImageParameters()
      Constructor.
    • ImageParameters

      public ImageParameters(COSDictionary params)
      Constructor.
      Parameters:
      params - The image parameters.
  • Method Details

    • getDictionary

      public COSDictionary getDictionary()
      This will get the dictionary that stores the image parameters.
      Returns:
      The COS dictionary that stores the image parameters.
    • getBitsPerComponent

      public int getBitsPerComponent()
      The bits per component of this image. This will return -1 if one has not been set.
      Returns:
      The number of bits per component.
    • setBitsPerComponent

      public void setBitsPerComponent(int bpc)
      Set the number of bits per component.
      Parameters:
      bpc - The number of bits per component.
    • getColorSpace

      public PDColorSpace getColorSpace() throws IOException
      This will get the color space or null if none exists.
      Returns:
      The color space for this image.
      Throws:
      IOException - If there is an error getting the colorspace.
    • getColorSpace

      public PDColorSpace getColorSpace(Map colorSpaces) throws IOException
      This will get the color space or null if none exists.
      Parameters:
      colorSpaces - The ColorSpace dictionary from the current resources, if any.
      Returns:
      The color space for this image.
      Throws:
      IOException - If there is an error getting the colorspace.
    • setColorSpace

      public void setColorSpace(PDColorSpace cs)
      This will set the color space for this image.
      Parameters:
      cs - The color space for this image.
    • getHeight

      public int getHeight()
      The height of this image. This will return -1 if one has not been set.
      Returns:
      The height.
    • setHeight

      public void setHeight(int h)
      Set the height of the image.
      Parameters:
      h - The height of the image.
    • getWidth

      public int getWidth()
      The width of this image. This will return -1 if one has not been set.
      Returns:
      The width.
    • setWidth

      public void setWidth(int w)
      Set the width of the image.
      Parameters:
      w - The width of the image.
    • getFilters

      public List getFilters()
      This will get the list of filters that are associated with this stream. Or null if there are none.
      Returns:
      A list of all encoding filters to apply to this stream.
    • setFilters

      public void setFilters(List filters)
      This will set the filters that are part of this stream.
      Parameters:
      filters - The filters that are part of this stream.
    • isStencil

      public boolean isStencil()
      Returns true if the image is a stencil mask.
      Returns:
      true if the image is a stencil mask.
    • setStencil

      public void setStencil(boolean isStencil)
      Sets whether or not the image is a stencil. This corresponds to the ImageMask entry in the image stream's dictionary.
      Parameters:
      isStencil - True to make the image a stencil.