Package org.apache.fop.render.afp
Class AFPPainter
java.lang.Object
org.apache.fop.render.intermediate.AbstractIFPainter<AFPDocumentHandler>
org.apache.fop.render.afp.AFPPainter
- All Implemented Interfaces:
IFPainter
IFPainter implementation that produces AFP (MO:DCA).
-
Field Summary
Fields inherited from class org.apache.fop.render.intermediate.AbstractIFPainter
INSTREAM_OBJECT_URI, state
-
Constructor Summary
Constructors -
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 Map
createDefaultImageProcessingHints
(org.apache.xmlgraphics.image.loader.ImageSessionContext sessionContext) Creates the default map of processing hints for the image loading framework.protected RenderingContext
Creates a new RenderingContext instance.void
drawBorderRect
(Rectangle rect, BorderProps top, BorderProps bottom, BorderProps left, BorderProps right, Color innerBackgroundColor) Draws a border rectangle.void
Draws an image identified by a URI inside a given rectangle.protected void
drawImage
(org.apache.xmlgraphics.image.loader.Image image, Rectangle rect, RenderingContext context, boolean convert, Map additionalHints) Draws an image using a suitable image handler.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.void
fillBackground
(Rectangle rect, Paint fill, BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd) void
Fills a rectangular area.getFontKey
(FontTriplet triplet) boolean
isBackgroundRequired
(BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd) TODO Painter-specific rounded borders logic required background drawing to be made optional.protected void
Restores the last graphics state of the rendering engine.protected void
Saves the graphics state of the rendering engine.void
startGroup
(AffineTransform transform, String layer) Starts a new group of graphical elements.void
startViewport
(AffineTransform transform, Dimension size, Rectangle clipRect) Starts a new viewport, establishing a new coordinate system.Methods inherited from class org.apache.fop.render.intermediate.AbstractIFPainter
drawImage, drawImageUsingDocument, drawImageUsingImageHandler, drawImageUsingURI, drawSVGText, drawText, getContext, getDocumentHandler, getFontInfo, getImageInfo, getLineBoundingBox, getUserAgent, hasOnlySolidBorders, setFont, startGroup, startViewport, toPoints
-
Constructor Details
-
AFPPainter
Default constructor.- Parameters:
documentHandler
- the parent document handler
-
-
Method Details
-
getFontKey
- Overrides:
getFontKey
in classAbstractIFPainter<AFPDocumentHandler>
- Throws:
IFException
-
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.- 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
-
endViewport
Ends the current viewport and restores the previous coordinate system.- Throws:
IFException
- if an error occurs while handling this element
-
startGroup
Starts a new group of graphical elements. Corresponds to SVG's g element.- 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
-
endGroup
Ends the current group and restores the previous coordinate system (and layer).- Throws:
IFException
- if an error occurs while handling this element
-
createDefaultImageProcessingHints
protected Map createDefaultImageProcessingHints(org.apache.xmlgraphics.image.loader.ImageSessionContext sessionContext) Creates the default map of processing hints for the image loading framework.- Overrides:
createDefaultImageProcessingHints
in classAbstractIFPainter<AFPDocumentHandler>
- Parameters:
sessionContext
- the session context for access to resolution information- Returns:
- the default processing hints
-
createRenderingContext
Creates a new RenderingContext instance.- Specified by:
createRenderingContext
in classAbstractIFPainter<AFPDocumentHandler>
- Returns:
- the new rendering context.
-
drawImage
Draws an image identified by a URI inside a given rectangle. This is the equivalent to an fo:external-graphic in XSL-FO.- 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
protected void drawImage(org.apache.xmlgraphics.image.loader.Image image, Rectangle rect, RenderingContext context, boolean convert, Map additionalHints) throws IOException, org.apache.xmlgraphics.image.loader.ImageException Draws an image using a suitable image handler.- Overrides:
drawImage
in classAbstractIFPainter<AFPDocumentHandler>
- Parameters:
image
- the image to be painted (it needs to of a supported image flavor)rect
- the rectangle in which to paint the imagecontext
- a suitable rendering contextconvert
- true to run the image through image conversion if that is necessaryadditionalHints
- additional image processing hints- Throws:
IOException
- in case of an I/O error while handling/writing the imageorg.apache.xmlgraphics.image.loader.ImageException
- if an error occurs while converting the image to a suitable format
-
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.- 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
-
clipRect
Restricts the current clipping region with the given rectangle.- Parameters:
rect
- the rectangle's coordinates and extent- Throws:
IFException
- if an error occurs while handling this event
-
fillRect
Fills a rectangular area.- 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 top, BorderProps bottom, BorderProps left, BorderProps right, Color innerBackgroundColor) throws IFException Description copied from class:AbstractIFPainter
Draws a border rectangle. The border segments are specified throughBorderProps
instances.- Specified by:
drawBorderRect
in interfaceIFPainter
- Overrides:
drawBorderRect
in classAbstractIFPainter<AFPDocumentHandler>
- Parameters:
rect
- the rectangle's coordinates and extenttop
- the border segment on the top edgebottom
- the border segment on the bottom edgeleft
- the border segment on the left edgeright
- the border segment on the right edgeinnerBackgroundColor
- the color of the inner background- Throws:
IFException
- if an error occurs while handling this event
-
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<AFPDocumentHandler>
- 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).- 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
-
saveGraphicsState
Saves the graphics state of the rendering engine.- Throws:
IOException
- if an I/O error occurs
-
restoreGraphicsState
Restores the last graphics state of the rendering engine.- Throws:
IOException
- if an I/O error occurs
-
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.- 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
-
isBackgroundRequired
public boolean isBackgroundRequired(BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd) TODO Painter-specific rounded borders logic required background drawing to be made optional. A future refactoring of the rounded borders code should aim to make the need for this abstraction obsolete- Specified by:
isBackgroundRequired
in interfaceIFPainter
- Overrides:
isBackgroundRequired
in classAbstractIFPainter<AFPDocumentHandler>
- Parameters:
bpsBefore
- the before borderbpsAfter
- the after borderbpsStart
- the start borderbpsEnd
- the end border- Returns:
- true if and only if background drawing is required
-
fillBackground
public void fillBackground(Rectangle rect, Paint fill, BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd) throws IFException - Throws:
IFException
-