Class PDFImageHandlerRenderedImage

java.lang.Object
org.apache.fop.render.pdf.AbstractPDFImageHandler
org.apache.fop.render.pdf.PDFImageHandlerRenderedImage
All Implemented Interfaces:
ImageHandler, ImageHandlerBase

public class PDFImageHandlerRenderedImage extends AbstractPDFImageHandler
Image handler implementation which handles RenderedImage instances for PDF output.
  • Field Details

    • FLAVORS

      private static final org.apache.xmlgraphics.image.loader.ImageFlavor[] FLAVORS
  • Constructor Details

    • PDFImageHandlerRenderedImage

      public PDFImageHandlerRenderedImage()
  • Method Details

    • createPDFImage

      PDFImage createPDFImage(org.apache.xmlgraphics.image.loader.Image image, String xobjectKey)
      Description copied from class: AbstractPDFImageHandler
      Creates a PDF image object out of the given image.
      Specified by:
      createPDFImage in class AbstractPDFImageHandler
      Parameters:
      image - an image
      xobjectKey - a key for retrieval of the image from the document's XObject collection
      Returns:
      a suitable PDFImage implementation that can handle the flavour of the given image
    • getPriority

      public int getPriority()
      Returns the priority for this image handler. A lower value means higher priority. This information is used to build the ordered/prioritized list of supported ImageFlavors. The built-in handlers use priorities between 100 and 999.
      Returns:
      a positive integer (>0) indicating the priority
    • getSupportedImageClass

      public Class getSupportedImageClass()
      Returns the Class subclass supported by this instance.
      Returns:
      the image Class type
    • getSupportedImageFlavors

      public org.apache.xmlgraphics.image.loader.ImageFlavor[] getSupportedImageFlavors()
      Returns the ImageFlavors supported by this instance
      Returns:
      the supported image flavors
    • isCompatible

      public boolean isCompatible(RenderingContext targetContext, org.apache.xmlgraphics.image.loader.Image image)
      Indicates whether the image handler is compatible with the indicated target represented by the rendering context object and with the image to be processed. The image is also passed as a parameter because a handler might not support every subtype of image that is presented. For example: in the case of ImageXMLDOM, the image might carry an SVG or some other XML format. One handler might only handle SVG but no other XML format.
      Parameters:
      targetContext - the target rendering context
      image - the image to be processed (or null if only to check based on the rendering context)
      Returns:
      true if this handler is compatible with the target rendering context