Package org.apache.fop.render.svg
Class EmbeddedSVGImageHandler
- java.lang.Object
-
- org.apache.fop.render.svg.EmbeddedSVGImageHandler
-
- All Implemented Interfaces:
ImageHandler
,ImageHandlerBase
,SVGConstants
,XMLConstants
public class EmbeddedSVGImageHandler extends java.lang.Object implements ImageHandler, SVGConstants
Image handler implementation that embeds SVG images in the target SVG file.
-
-
Field Summary
Fields Modifier and Type Field Description private static java.lang.String
CDATA
Constant for the "CDATA" attribute type.private static org.apache.commons.logging.Log
log
logging instance-
Fields inherited from interface org.apache.fop.render.svg.SVGConstants
FILE_EXTENSION_SVG, MIME_SVG_PRINT, MIME_TYPE, NAMESPACE, SVG_ELEMENT
-
Fields inherited from interface org.apache.fop.util.XMLConstants
XLINK_HREF, XLINK_NAMESPACE, XLINK_PREFIX, XML_NAMESPACE, XML_PREFIX, XML_SPACE, XMLNS_NAMESPACE_URI, XMLNS_PREFIX
-
-
Constructor Summary
Constructors Constructor Description EmbeddedSVGImageHandler()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getPriority()
Returns the priority for this image handler.java.lang.Class
getSupportedImageClass()
Returns theClass
subclass supported by this instance.org.apache.xmlgraphics.image.loader.ImageFlavor[]
getSupportedImageFlavors()
Returns theImageFlavor
s supported by this instancevoid
handleImage(RenderingContext context, org.apache.xmlgraphics.image.loader.Image image, java.awt.Rectangle pos)
Handles the givenImage
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.
-
-
-
Field Detail
-
log
private static org.apache.commons.logging.Log log
logging instance
-
CDATA
private static final java.lang.String CDATA
Constant for the "CDATA" attribute type.- See Also:
- Constant Field Values
-
-
Method Detail
-
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 interfaceImageHandlerBase
- Returns:
- a positive integer (>0) indicating the priority
-
getSupportedImageClass
public java.lang.Class getSupportedImageClass()
Returns theClass
subclass supported by this instance.- Specified by:
getSupportedImageClass
in interfaceImageHandlerBase
- Returns:
- the image Class type
-
getSupportedImageFlavors
public org.apache.xmlgraphics.image.loader.ImageFlavor[] getSupportedImageFlavors()
Returns theImageFlavor
s supported by this instance- Specified by:
getSupportedImageFlavors
in interfaceImageHandlerBase
- Returns:
- the supported image flavors
-
handleImage
public void handleImage(RenderingContext context, org.apache.xmlgraphics.image.loader.Image image, java.awt.Rectangle pos) throws java.io.IOException
Handles the givenImage
instance painting it at the indicated position in the output format being generated.- Specified by:
handleImage
in interfaceImageHandler
- Parameters:
context
- the rendering contextimage
- the image to be handledpos
- 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
-
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 ofImageXMLDOM
, 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 interfaceImageHandler
- Parameters:
targetContext
- the target rendering contextimage
- 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
-
-