Package org.apache.fop.render.pcl
Class PCLPainter
java.lang.Object
org.apache.fop.render.intermediate.AbstractIFPainter<PCLDocumentHandler>
org.apache.fop.render.pcl.PCLPainter
- All Implemented Interfaces:
IFPainter
,PCLConstants
IFPainter
implementation that produces PCL 5.-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate PCLPageDefinition
private int
private static final boolean
private PCLGenerator
The PCL generatorprivate org.apache.xmlgraphics.java2d.GraphicContext
private Stack
<org.apache.xmlgraphics.java2d.GraphicContext> private static final double
private PCLSoftFontManager
Fields inherited from class org.apache.fop.render.intermediate.AbstractIFPainter
INSTREAM_OBJECT_URI, state
Fields inherited from interface org.apache.fop.render.pcl.PCLConstants
COLOR_CANVAS, DISABLE_CLIPPING, SRC_TRANSPARENCY
-
Constructor Summary
ConstructorsConstructorDescriptionPCLPainter
(PCLDocumentHandler parent, PCLPageDefinition pageDefinition) Main constructor. -
Method Summary
Modifier and TypeMethodDescriptionprivate void
void
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.private void
concatenateTransformationMatrix
(AffineTransform transform) protected RenderingContext
Creates a new RenderingContext instance.void
drawBorderRect
(Rectangle rect, BorderProps top, BorderProps bottom, BorderProps left, BorderProps right) 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.private void
drawTextAsBitmap
(int x, int y, int letterSpacing, int wordSpacing, int[][] dp, String text, FontTriplet triplet) private void
drawTextNative
(int x, int y, int letterSpacing, int wordSpacing, int[][] dp, String text, FontTriplet triplet) private void
drawTextUsingSoftFont
(int x, int y, int letterSpacing, int wordSpacing, int[][] dp, String text, FontTriplet triplet, PCLSoftFont softFont) 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
Fills a rectangular area.(package private) PCLRenderingUtil
protected int
private Rectangle
getTextBoundingBox
(int x, int y, int letterSpacing, int wordSpacing, int[][] dp, String text, Font font, FontMetricsMapper metrics) private Typeface
getTypeface
(String fontName) private boolean
private boolean
isTrueType
(Typeface tf) private void
paintMarksAsBitmap
(org.apache.xmlgraphics.java2d.Graphics2DImagePainter painter, Rectangle boundingBox) private void
Restores the last graphics state from the stack.private void
Saves the current graphics state on the stack.(package private) void
setCursorPos
(int x, int y) Sets the current cursor position.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.private Point2D
transformedPoint
(int x, int y) 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, startGroup, startViewport, toPoints
-
Field Details
-
DEBUG
private static final boolean DEBUG- See Also:
-
gen
The PCL generator -
currentPageDefinition
-
currentPrintDirection
private int currentPrintDirection -
graphicContextStack
-
graphicContext
private org.apache.xmlgraphics.java2d.GraphicContext graphicContext -
sfManager
-
SAFETY_MARGIN_FACTOR
private static final double SAFETY_MARGIN_FACTOR- See Also:
-
-
Constructor Details
-
PCLPainter
Main constructor.- Parameters:
parent
- the parent document handlerpageDefinition
- the page definition describing the page to be rendered
-
-
Method Details
-
getPCLUtil
PCLRenderingUtil getPCLUtil() -
getResolution
protected int getResolution()- Returns:
- the target resolution
-
isSpeedOptimized
private boolean isSpeedOptimized() -
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
-
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
- 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).- 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
-
createRenderingContext
Creates a new RenderingContext instance.- Specified by:
createRenderingContext
in classAbstractIFPainter<PCLDocumentHandler>
- Returns:
- the new rendering context.
-
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
-
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 top, BorderProps bottom, BorderProps left, BorderProps right) 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<PCLDocumentHandler>
- 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
-
paintMarksAsBitmap
private void paintMarksAsBitmap(org.apache.xmlgraphics.java2d.Graphics2DImagePainter painter, Rectangle boundingBox) throws IFException - Throws:
IFException
-
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
-
isTrueType
-
getTypeface
-
drawTextNative
private void drawTextNative(int x, int y, int letterSpacing, int wordSpacing, int[][] dp, String text, FontTriplet triplet) throws IOException - Throws:
IOException
-
drawTextUsingSoftFont
private void drawTextUsingSoftFont(int x, int y, int letterSpacing, int wordSpacing, int[][] dp, String text, FontTriplet triplet, PCLSoftFont softFont) throws IOException - Throws:
IOException
-
getTextBoundingBox
private Rectangle getTextBoundingBox(int x, int y, int letterSpacing, int wordSpacing, int[][] dp, String text, Font font, FontMetricsMapper metrics) -
drawTextAsBitmap
private void drawTextAsBitmap(int x, int y, int letterSpacing, int wordSpacing, int[][] dp, String text, FontTriplet triplet) throws IFException - Throws:
IFException
-
saveGraphicsState
private void saveGraphicsState()Saves the current graphics state on the stack. -
restoreGraphicsState
private void restoreGraphicsState()Restores the last graphics state from the stack. -
concatenateTransformationMatrix
- Throws:
IOException
-
transformedPoint
-
changePrintDirection
- Throws:
IOException
-
setCursorPos
Sets the current cursor position. The coordinates are transformed to the absolute position on the logical PCL page and then passed on to the PCLGenerator.- Parameters:
x
- the x coordinate (in millipoints)y
- the y coordinate (in millipoints)- Throws:
IOException
-