fop 0.95

org.apache.fop.render.pdf
Interface PDFImageHandler

All Known Implementing Classes:
PDFImageHandlerGraphics2D, PDFImageHandlerRawCCITTFax, PDFImageHandlerRawJPEG, PDFImageHandlerRenderedImage, PDFImageHandlerXML

public interface PDFImageHandler

This interface is used for handling all sorts of image type for PDF output.


Method Summary
 PDFXObject generateImage(RendererContext context, org.apache.xmlgraphics.image.loader.Image image, java.awt.Point origin, java.awt.Rectangle pos)
          Generates the PDF objects for the given Image instance.
 int getPriority()
          Returns the priority for this image handler.
 java.lang.Class getSupportedImageClass()
          Returns the Image subclass supported by this instance.
 org.apache.xmlgraphics.image.loader.ImageFlavor[] getSupportedImageFlavors()
          Returns the ImageFlavors supported by this instance
 

Method Detail

getPriority

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 for the PDF renderer. The built-in handlers use priorities between 100 and 999.

Returns:
a positive integer (>0) indicating the priority

getSupportedImageFlavors

org.apache.xmlgraphics.image.loader.ImageFlavor[] getSupportedImageFlavors()
Returns the ImageFlavors supported by this instance

Returns:
the supported image flavors

getSupportedImageClass

java.lang.Class getSupportedImageClass()
Returns the Image subclass supported by this instance.

Returns:
the Image type

generateImage

PDFXObject generateImage(RendererContext context,
                         org.apache.xmlgraphics.image.loader.Image image,
                         java.awt.Point origin,
                         java.awt.Rectangle pos)
                         throws java.io.IOException
Generates the PDF objects for the given Image instance. If the handler generates an XObject, it shall return it or otherwise return null. A generated XObject shall be placed in the current viewport according to the two parameters "origin" and "pos".

Parameters:
context - the PDF renderer context
image - the image to be handled
origin - the current position in the current viewport (in millipoints)
pos - the position and scaling of the image relative to the origin point (in millipoints)
Returns:
the generated XObject or null if no XObject was generated
Throws:
java.io.IOException - if an I/O error occurs

fop 0.95

Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.