Package org.apache.fop.render.pdf
Class PDFPainter
- java.lang.Object
-
- org.apache.fop.render.intermediate.AbstractIFPainter<PDFDocumentHandler>
-
- org.apache.fop.render.pdf.PDFPainter
-
- All Implemented Interfaces:
IFPainter
public class PDFPainter extends AbstractIFPainter<PDFDocumentHandler>
IFPainter implementation that produces PDF.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
PDFPainter.LanguageAvailabilityChecker
-
Field Summary
Fields Modifier and Type Field Description private boolean
accessEnabled
private BorderPainter
borderPainter
protected PDFContentGenerator
generator
The current content generatorprivate GraphicsPainter
graphicsPainter
private PDFLogicalStructureHandler.MarkedContentInfo
imageMCI
private PDFPainter.LanguageAvailabilityChecker
languageAvailabilityChecker
private PDFLogicalStructureHandler
logicalStructureHandler
private static int[]
paZero
-
Fields inherited from class org.apache.fop.render.intermediate.AbstractIFPainter
INSTREAM_OBJECT_URI, state
-
-
Constructor Summary
Constructors Constructor Description PDFPainter(PDFDocumentHandler documentHandler, PDFLogicalStructureHandler logicalStructureHandler)
Default constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private void
addStructTreeBBox(java.awt.Rectangle rect)
void
clipBackground(java.awt.Rectangle rect, BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd)
Restricts the current clipping region to the inner border.void
clipRect(java.awt.Rectangle rect)
Restricts the current clipping region with the given rectangle.protected RenderingContext
createRenderingContext()
Creates a new RenderingContext instance.void
drawBorderRect(java.awt.Rectangle rect, BorderProps top, BorderProps bottom, BorderProps left, BorderProps right, java.awt.Color innerBackgroundColor)
Draws a border rectangle.void
drawImage(java.lang.String uri, java.awt.Rectangle rect)
Draws an image identified by a URI inside a given rectangle.void
drawImage(org.w3c.dom.Document doc, java.awt.Rectangle rect)
Draws an image (represented by a DOM document) inside a given rectangle.protected void
drawImageUsingURI(java.lang.String uri, java.awt.Rectangle rect)
Default drawing method for handling an image referenced by a URI.void
drawLine(java.awt.Point start, java.awt.Point end, int width, java.awt.Color color, RuleStyle style)
Draws a line.void
drawText(int x, int y, int letterSpacing, int wordSpacing, int[][] dp, java.lang.String text)
Draws text.void
drawText(int x, int y, int letterSpacing, int wordSpacing, int[][] dp, java.lang.String text, boolean nextIsSpace)
private void
drawTextWithDP(int x, int y, java.lang.String text, FontTriplet triplet, int letterSpacing, int wordSpacing, int[][] dp)
private void
drawTextWithDX(int x, int y, java.lang.String text, FontTriplet triplet, int letterSpacing, int wordSpacing, int[] dx)
void
endGroup()
Ends the current group and restores the previous coordinate system (and layer).private void
endSimulateStyle(Typeface tf, FontTriplet triplet)
void
endViewport()
Ends the current viewport and restores the previous coordinate system.void
fillRect(java.awt.Rectangle rect, java.awt.Paint fill)
Fills a rectangular area.private void
flushPDFDoc()
protected static java.lang.String
format(int value)
Formats a integer value (normally coordinates in millipoints) to a String.private Typeface
getTypeface(java.lang.String fontName)
private double
maybeWordOffsetX(double wox, int ch, Direction dir)
private void
placeImage(java.awt.Rectangle rect, PDFXObject xobj)
Places a previously registered image at a certain place on the page.private void
placeImageAccess(java.awt.Rectangle rect, PDFXObject xobj)
Places a previously registered image at a certain place on the page - Accessibility versionprivate void
prepareImageMCID(PDFStructElem structElem)
private int
selectAndMapSingleByteFont(Typeface tf, java.lang.String fontName, float fontSize, PDFTextUtil textutil, int ch)
void
startGroup(java.awt.geom.AffineTransform transform, java.lang.String layer)
Starts a new group of graphical elements.private double
startSimulateStyle(Typeface tf, FontTriplet triplet)
void
startViewport(java.awt.geom.AffineTransform transform, java.awt.Dimension size, java.awt.Rectangle clipRect)
Starts a new viewport, establishing a new coordinate system.-
Methods inherited from class org.apache.fop.render.intermediate.AbstractIFPainter
createDefaultImageProcessingHints, drawImage, drawImage, drawImageUsingDocument, drawImageUsingImageHandler, drawSVGText, getContext, getDocumentHandler, getFontInfo, getFontKey, getImageInfo, getLineBoundingBox, getUserAgent, hasOnlySolidBorders, isBackgroundRequired, setFont, startGroup, startViewport, toPoints
-
-
-
-
Field Detail
-
generator
protected PDFContentGenerator generator
The current content generator
-
graphicsPainter
private final GraphicsPainter graphicsPainter
-
borderPainter
private final BorderPainter borderPainter
-
accessEnabled
private boolean accessEnabled
-
imageMCI
private PDFLogicalStructureHandler.MarkedContentInfo imageMCI
-
logicalStructureHandler
private PDFLogicalStructureHandler logicalStructureHandler
-
languageAvailabilityChecker
private final PDFPainter.LanguageAvailabilityChecker languageAvailabilityChecker
-
paZero
private static int[] paZero
-
-
Constructor Detail
-
PDFPainter
public PDFPainter(PDFDocumentHandler documentHandler, PDFLogicalStructureHandler logicalStructureHandler)
Default constructor.- Parameters:
documentHandler
- the parent document handlerlogicalStructureHandler
- the logical structure handler
-
-
Method Detail
-
startViewport
public void startViewport(java.awt.geom.AffineTransform transform, java.awt.Dimension size, java.awt.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
public void endViewport() throws IFException
Ends the current viewport and restores the previous coordinate system.- Throws:
IFException
- if an error occurs while handling this element
-
startGroup
public void startGroup(java.awt.geom.AffineTransform transform, java.lang.String layer) throws IFException
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
public void endGroup() throws IFException
Ends the current group and restores the previous coordinate system (and layer).- Throws:
IFException
- if an error occurs while handling this element
-
drawImage
public void drawImage(java.lang.String uri, java.awt.Rectangle rect) throws IFException
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
-
addStructTreeBBox
private void addStructTreeBBox(java.awt.Rectangle rect)
-
drawImageUsingURI
protected void drawImageUsingURI(java.lang.String uri, java.awt.Rectangle rect)
Description copied from class:AbstractIFPainter
Default drawing method for handling an image referenced by a URI.- Overrides:
drawImageUsingURI
in classAbstractIFPainter<PDFDocumentHandler>
- Parameters:
uri
- the image's URIrect
- the rectangle in which to paint the image
-
prepareImageMCID
private void prepareImageMCID(PDFStructElem structElem)
-
createRenderingContext
protected RenderingContext createRenderingContext()
Creates a new RenderingContext instance.- Specified by:
createRenderingContext
in classAbstractIFPainter<PDFDocumentHandler>
- Returns:
- the new rendering context.
-
placeImage
private void placeImage(java.awt.Rectangle rect, PDFXObject xobj)
Places a previously registered image at a certain place on the page.- Parameters:
rect
- the rectangle for the imagexobj
- the image XObject
-
placeImageAccess
private void placeImageAccess(java.awt.Rectangle rect, PDFXObject xobj)
Places a previously registered image at a certain place on the page - Accessibility version- Parameters:
rect
- the rectangle for the imagexobj
- the image XObject
-
drawImage
public void drawImage(org.w3c.dom.Document doc, java.awt.Rectangle rect) throws IFException
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
-
flushPDFDoc
private void flushPDFDoc() throws IFException
- Throws:
IFException
-
format
protected static java.lang.String format(int value)
Formats a integer value (normally coordinates in millipoints) to a String.- Parameters:
value
- the value (in millipoints)- Returns:
- the formatted value
-
clipRect
public void clipRect(java.awt.Rectangle rect) throws IFException
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
-
clipBackground
public void clipBackground(java.awt.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
-
fillRect
public void fillRect(java.awt.Rectangle rect, java.awt.Paint fill) throws IFException
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(java.awt.Rectangle rect, BorderProps top, BorderProps bottom, BorderProps left, BorderProps right, java.awt.Color innerBackgroundColor) throws IFException
Draws a border rectangle. The border segments are specified throughBorderProps
instances.- Specified by:
drawBorderRect
in interfaceIFPainter
- Overrides:
drawBorderRect
in classAbstractIFPainter<PDFDocumentHandler>
- 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(java.awt.Point start, java.awt.Point end, int width, java.awt.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<PDFDocumentHandler>
- 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
-
getTypeface
private Typeface getTypeface(java.lang.String fontName)
-
drawText
public void drawText(int x, int y, int letterSpacing, int wordSpacing, int[][] dp, java.lang.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
-
drawText
public void drawText(int x, int y, int letterSpacing, int wordSpacing, int[][] dp, java.lang.String text, boolean nextIsSpace) throws IFException
- Specified by:
drawText
in interfaceIFPainter
- Overrides:
drawText
in classAbstractIFPainter<PDFDocumentHandler>
- Throws:
IFException
-
drawTextWithDX
private void drawTextWithDX(int x, int y, java.lang.String text, FontTriplet triplet, int letterSpacing, int wordSpacing, int[] dx) throws IFException
- Throws:
IFException
-
startSimulateStyle
private double startSimulateStyle(Typeface tf, FontTriplet triplet)
-
endSimulateStyle
private void endSimulateStyle(Typeface tf, FontTriplet triplet)
-
drawTextWithDP
private void drawTextWithDP(int x, int y, java.lang.String text, FontTriplet triplet, int letterSpacing, int wordSpacing, int[][] dp)
-
maybeWordOffsetX
private double maybeWordOffsetX(double wox, int ch, Direction dir)
-
selectAndMapSingleByteFont
private int selectAndMapSingleByteFont(Typeface tf, java.lang.String fontName, float fontSize, PDFTextUtil textutil, int ch)
-
-