fop 1.0

org.apache.fop.render.pdf
Class PDFImageHandlerGraphics2D

java.lang.Object
  extended by org.apache.fop.render.AbstractImageHandlerGraphics2D
      extended by org.apache.fop.render.pdf.PDFImageHandlerGraphics2D
All Implemented Interfaces:
ImageHandler, ImageHandlerBase, PDFImageHandler

public class PDFImageHandlerGraphics2D
extends AbstractImageHandlerGraphics2D
implements PDFImageHandler

PDFImageHandler implementation which handles Graphics2D images.


Constructor Summary
PDFImageHandlerGraphics2D()
           
 
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 Class subclass supported by this instance.
 org.apache.xmlgraphics.image.loader.ImageFlavor[] getSupportedImageFlavors()
          Returns the ImageFlavors supported by this instance
 void handleImage(RenderingContext context, org.apache.xmlgraphics.image.loader.Image image, java.awt.Rectangle pos)
          Handles the given Image instance painting it at the indicated position in the output format being generated.
 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.
 
Methods inherited from class org.apache.fop.render.AbstractImageHandlerGraphics2D
paintToBufferedImage, setRenderingHintsForBufferedImage
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PDFImageHandlerGraphics2D

public PDFImageHandlerGraphics2D()
Method Detail

generateImage

public 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".

Specified by:
generateImage in interface PDFImageHandler
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

handleImage

public void handleImage(RenderingContext context,
                        org.apache.xmlgraphics.image.loader.Image image,
                        java.awt.Rectangle pos)
                 throws java.io.IOException
Handles the given Image instance painting it at the indicated position in the output format being generated.

Specified by:
handleImage in interface ImageHandler
Parameters:
context - the rendering context
image - the image to be handled
pos - the position and scaling of the image relative to the origin point of the current viewport (in millipoints)
Throws:
java.io.IOException - if an I/O error occurs

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.

Specified by:
getPriority in interface ImageHandlerBase
Returns:
a positive integer (>0) indicating the priority

getSupportedImageClass

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

Specified by:
getSupportedImageClass in interface ImageHandlerBase
Returns:
the image Class type

getSupportedImageFlavors

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

Specified by:
getSupportedImageFlavors in interface ImageHandlerBase
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.

Specified by:
isCompatible in interface ImageHandler
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

fop 1.0

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