Package org.apache.fop.render.svg
Class SVGPainter
java.lang.Object
org.apache.fop.render.intermediate.AbstractIFPainter<AbstractSVGDocumentHandler>
org.apache.fop.render.svg.SVGPainter
- All Implemented Interfaces:
IFPainter
,SVGConstants
,XMLConstants
public class SVGPainter
extends AbstractIFPainter<AbstractSVGDocumentHandler>
implements SVGConstants
IFPainter implementation that writes SVG.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate GenerationHelperContentHandler
The SAX content handler that receives the generated XML events.private int
private static final int
private static final int
Fields inherited from class org.apache.fop.render.intermediate.AbstractIFPainter
INSTREAM_OBJECT_URI, state
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
CDATA, XLINK_HREF, XLINK_NAMESPACE, XLINK_PREFIX, XML_NAMESPACE, XML_PREFIX, XML_SPACE, XMLNS_NAMESPACE_URI, XMLNS_PREFIX
-
Constructor Summary
ConstructorsConstructorDescriptionSVGPainter
(AbstractSVGDocumentHandler parent, GenerationHelperContentHandler contentHandler) Main constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
clipBackground
(Rectangle rect, BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd) Restricts the current clipping region to the inner border.void
Restricts the current clipping region with the given rectangle.protected RenderingContext
Creates a new RenderingContext instance.void
drawBorderRect
(Rectangle rect, BorderProps before, BorderProps after, BorderProps start, BorderProps end) void
Draws an image identified by a URI inside a given rectangle.void
Draws an image (represented by a DOM document) inside a given rectangle.void
Draws a line.void
Draws text.void
endGroup()
Ends the current group and restores the previous coordinate system (and layer).void
Ends the current viewport and restores the previous coordinate system.private void
private void
establish
(int newMode) void
fillBackground
(Rectangle rect, Paint fill, BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd) void
Fills a rectangular area.void
handleExtensionObject
(Object extension) private void
void
startGroup
(AffineTransform[] transforms, String layer) Starts a new group of graphical elements.void
startGroup
(AffineTransform transform, String layer) Starts a new group of graphical elements.private void
startGroup
(String transform, String layer) private void
void
startViewport
(AffineTransform[] transforms, Dimension size, Rectangle clipRect) Starts a new viewport, establishing a new coordinate system.void
startViewport
(AffineTransform transform, Dimension size, Rectangle clipRect) Starts a new viewport, establishing a new coordinate system.private void
startViewport
(String transform, Dimension size, Rectangle clipRect) private static String
Methods inherited from class org.apache.fop.render.intermediate.AbstractIFPainter
createDefaultImageProcessingHints, drawBorderRect, drawImage, drawImage, drawImageUsingDocument, drawImageUsingImageHandler, drawImageUsingURI, drawSVGText, drawText, getContext, getDocumentHandler, getFontInfo, getFontKey, getImageInfo, getLineBoundingBox, getUserAgent, hasOnlySolidBorders, isBackgroundRequired, setFont, toPoints
-
Field Details
-
handler
The SAX content handler that receives the generated XML events. -
MODE_NORMAL
private static final int MODE_NORMAL- See Also:
-
MODE_TEXT
private static final int MODE_TEXT- See Also:
-
mode
private int mode
-
-
Constructor Details
-
SVGPainter
Main constructor.- Parameters:
parent
- the parent document handlercontentHandler
- the target SAX content handler
-
-
Method Details
-
startViewport
public void startViewport(AffineTransform transform, Dimension size, Rectangle clipRect) throws IFException Starts a new viewport, establishing a new coordinate system. A viewport has a size and can optionally be clipped. Corresponds to SVG's svg element.- Specified by:
startViewport
in interfaceIFPainter
- Parameters:
transform
- the transformation matrix establishing the new coordinate systemsize
- the size of the viewportclipRect
- the clipping rectangle (may be null)- Throws:
IFException
- if an error occurs while handling this element
-
startViewport
public void startViewport(AffineTransform[] transforms, Dimension size, Rectangle clipRect) throws IFException Starts a new viewport, establishing a new coordinate system. A viewport has a size and can optionally be clipped. Corresponds to SVG's svg element.- Specified by:
startViewport
in interfaceIFPainter
- Overrides:
startViewport
in classAbstractIFPainter<AbstractSVGDocumentHandler>
- Parameters:
transforms
- a series of transformation matrices establishing the new coordinate systemsize
- the size of the viewportclipRect
- the clipping rectangle (may be null)- Throws:
IFException
- if an error occurs while handling this element
-
startViewport
- Throws:
IFException
-
endViewport
Ends the current viewport and restores the previous coordinate system.- Specified by:
endViewport
in interfaceIFPainter
- Throws:
IFException
- if an error occurs while handling this element
-
startGroup
Starts a new group of graphical elements. Corresponds to SVG's g element.- Specified by:
startGroup
in interfaceIFPainter
- Overrides:
startGroup
in classAbstractIFPainter<AbstractSVGDocumentHandler>
- Parameters:
transforms
- a series of transformation matrices establishing the new coordinate systemlayer
- an optional layer label (or null if none)- Throws:
IFException
- if an error occurs while handling this element
-
startGroup
Starts a new group of graphical elements. Corresponds to SVG's g element.- Specified by:
startGroup
in interfaceIFPainter
- Parameters:
transform
- the transformation matrix establishing the new coordinate systemlayer
- an optional layer label (or null if none)- Throws:
IFException
- if an error occurs while handling this element
-
startGroup
- Throws:
IFException
-
endGroup
Ends the current group and restores the previous coordinate system (and layer).- Specified by:
endGroup
in interfaceIFPainter
- Throws:
IFException
- if an error occurs while handling this element
-
drawImage
Draws an image identified by a URI inside a given rectangle. This is the equivalent to an fo:external-graphic in XSL-FO.- Specified by:
drawImage
in interfaceIFPainter
- Parameters:
uri
- the image's URIrect
- the rectangle in which the image shall be painted- Throws:
IFException
- if an error occurs while handling this event
-
drawImage
Draws an image (represented by a DOM document) inside a given rectangle. This is the equivalent to an fo:instream-foreign-object in XSL-FO.- Specified by:
drawImage
in interfaceIFPainter
- Parameters:
doc
- the DOM document containing the foreign objectrect
- the rectangle in which the image shall be painted- Throws:
IFException
- if an error occurs while handling this event
-
createRenderingContext
Creates a new RenderingContext instance.- Specified by:
createRenderingContext
in classAbstractIFPainter<AbstractSVGDocumentHandler>
- Returns:
- the new rendering context.
-
toString
-
clipRect
Restricts the current clipping region with the given rectangle.- Specified by:
clipRect
in interfaceIFPainter
- Parameters:
rect
- the rectangle's coordinates and extent- Throws:
IFException
- if an error occurs while handling this event
-
clipBackground
public void clipBackground(Rectangle rect, BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd) throws IFException Restricts the current clipping region to the inner border.- Specified by:
clipBackground
in interfaceIFPainter
- Parameters:
rect
- the rectangle's coordinates and extentbpsBefore
- the border segment on the before-side (top)bpsAfter
- the border segment on the after-side (bottom)bpsStart
- the border segment on the start-side (left)bpsEnd
- the border segment on the end-side (right)- Throws:
IFException
- if an error occurs while handling this event
-
fillRect
Fills a rectangular area.- Specified by:
fillRect
in interfaceIFPainter
- Parameters:
rect
- the rectangle's coordinates and extentfill
- the fill paint- Throws:
IFException
- if an error occurs while handling this event
-
drawBorderRect
public void drawBorderRect(Rectangle rect, BorderProps before, BorderProps after, BorderProps start, BorderProps end) throws IFException - Throws:
IFException
-
drawLine
public void drawLine(Point start, Point end, int width, Color color, RuleStyle style) throws IFException Draws a line. NOTE: Currently, only horizontal lines are implemented!- Specified by:
drawLine
in interfaceIFPainter
- Overrides:
drawLine
in classAbstractIFPainter<AbstractSVGDocumentHandler>
- Parameters:
start
- the start point of the lineend
- the end point of the linewidth
- the line widthcolor
- the line colorstyle
- the line style (using the Constants.EN_* constants for the rule-style property)- Throws:
IFException
- if an error occurs while handling this event
-
drawText
public void drawText(int x, int y, int letterSpacing, int wordSpacing, int[][] dp, String text) throws IFException Draws text. The initial coordinates (x and y) point to the starting point at the normal baseline of the font. The parameters letterSpacing, wordSpacing and the array dx are optional and can be used to influence character positioning (for example, for kerning).- Specified by:
drawText
in interfaceIFPainter
- Parameters:
x
- X-coordinate of the starting point of the texty
- Y-coordinate of the starting point of the textletterSpacing
- additional spacing between characters (may be 0)wordSpacing
- additional spacing between words (may be 0)dp
- an array of 4-tuples, expressing [X,Y] placment adjustments and [X,Y] advancement adjustments, in that order (may be null); if not null, then adjustments.length must be the same as text.length()text
- the text- Throws:
IFException
- if an error occurs while handling this event
-
leaveTextMode
- Throws:
SAXException
-
establish
- Throws:
SAXException
-
enterTextMode
- Throws:
SAXException
-
startTextGroup
- Throws:
SAXException
-
handleExtensionObject
- Parameters:
extension
- an extension object- Throws:
IFException
- if not caught
-
fillBackground
public void fillBackground(Rectangle rect, Paint fill, BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd) throws IFException - Throws:
IFException
-