Class ImageRawJPEGAdapter

  • All Implemented Interfaces:
    PDFImage

    public class ImageRawJPEGAdapter
    extends AbstractImageAdapter
    PDFImage implementation for the PDF renderer which handles raw JPEG images.

    The JPEG is copied to the XObject's stream as-is but some elements (marker segments) are filtered. For example, an embedded color profile is filtered since it is already added as a PDF object and associated with the XObject. This way, the PDF file size is kept as small as possible.

    • Constructor Detail

      • ImageRawJPEGAdapter

        public ImageRawJPEGAdapter​(org.apache.xmlgraphics.image.loader.impl.ImageRawJPEG image,
                                   java.lang.String key)
        Creates a new PDFImage from an Image instance.
        Parameters:
        image - the JPEG image
        key - XObject key
    • Method Detail

      • getImage

        public org.apache.xmlgraphics.image.loader.impl.ImageRawJPEG getImage()
        Returns the ImageRawJPEG instance for this adapter.
        Returns:
        the image instance
      • setup

        public void setup​(PDFDocument doc)
        Setup the PDF image for the current document. Some image formats may need to access the document (for example to add an ICC profile to the document).
        Specified by:
        setup in interface PDFImage
        Overrides:
        setup in class AbstractImageAdapter
        Parameters:
        doc - the PDF parent document (todo) Remove this and delegate to the XObject
      • getColorSpace

        public PDFDeviceColorSpace getColorSpace()
        Get the color space for this image. Possible results are: DeviceGray, DeviceRGB, or DeviceCMYK
        Returns:
        the color space
      • getBitsPerComponent

        public int getBitsPerComponent()
        Get the bits per color component for this image.
        Returns:
        the bits per component
      • getPDFFilter

        public PDFFilter getPDFFilter()
        Get the PDF Filter to be applied to the image.
        Returns:
        the PDF Filter or null
      • outputContents

        public void outputContents​(java.io.OutputStream out)
                            throws java.io.IOException
        Writes the raw, unencoded contents of the image to a given output stream.
        Parameters:
        out - OutputStream to write to
        Throws:
        java.io.IOException - if there creating stream
      • getFilterHint

        public java.lang.String getFilterHint()
        Returns a hint in form of a String (Possible values from PDFFilterList) indicating which filter setup should be used to encode the object.
        Returns:
        the filter setup hint