Class PCLPainter

java.lang.Object

org.apache.fop.render.intermediate.AbstractIFPainter<PCLDocumentHandler>

org.apache.fop.render.pcl.PCLPainter

All Implemented Interfaces:

IFPainter, PCLConstants

public class PCLPainter
extends AbstractIFPainter<PCLDocumentHandler>
implements PCLConstants

IFPainter implementation that produces PCL 5.

Field Summary

Fields

Modifier and Type	Field	Description
private PCLPageDefinition	currentPageDefinition
private int	currentPrintDirection
private int	currentX
private int	currentY
private static final boolean	DEBUG
private PCLGenerator	gen	The PCL generator
private org.apache.xmlgraphics.java2d.GraphicContext	graphicContext
private Stack<org.apache.xmlgraphics.java2d.GraphicContext>	graphicContextStack
private static final double	SAFETY_MARGIN_FACTOR
private PCLSoftFontManager	sfManager

Fields inherited from class AbstractIFPainter

INSTREAM_OBJECT_URI, state

Fields inherited from interface PCLConstants

COLOR_CANVAS, DISABLE_CLIPPING, SRC_TRANSPARENCY

Constructor Summary

Constructors

Constructor	Description
PCLPainter(PCLDocumentHandler parent, PCLPageDefinition pageDefinition)	Main constructor.

Method Summary

Modifier and Type	Method	Description
private void	changePrintDirection()
void	clipBackground(Rectangle rect, BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd)	Restricts the current clipping region to the inner border.
void	clipRect(Rectangle rect)	Restricts the current clipping region with the given rectangle.
private void	concatenateTransformationMatrix(AffineTransform transform)
protected RenderingContext	createRenderingContext()	Creates a new RenderingContext instance.
void	drawBorderRect(Rectangle rect, BorderProps top, BorderProps bottom, BorderProps left, BorderProps right)
void	drawImage(String uri, Rectangle rect)	Draws an image identified by a URI inside a given rectangle.
void	drawImage(Document doc, Rectangle rect)	Draws an image (represented by a DOM document) inside a given rectangle.
void	drawLine(Point start, Point end, int width, Color color, RuleStyle style)	Draws a line.
void	drawText(int x, int y, int letterSpacing, int wordSpacing, int[][] dp, String text)	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	endViewport()	Ends the current viewport and restores the previous coordinate system.
void	fillRect(Rectangle rect, Paint fill)	Fills a rectangular area.
private int	getCharWidth(int i, Font font, char orgChar, String text)
(package private) PCLRenderingUtil	getPCLUtil()
protected int	getResolution()
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	isSpeedOptimized()
private boolean	isTrueType(Typeface tf)
private void	paintMarksAsBitmap(org.apache.xmlgraphics.java2d.Graphics2DImagePainter painter, Rectangle boundingBox)
private void	restoreGraphicsState()	Restores the last graphics state from the stack.
private void	saveGraphicsState()	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 AbstractIFPainter

createDefaultImageProcessingHints, drawBorderRect, drawImage, drawImage, drawImageUsingDocument, drawImageUsingImageHandler, drawImageUsingURI, drawSVGText, drawText, getContext, getDocumentHandler, getFontInfo, getFontKey, getImageForSupportedFlavors, getImageInfo, getLineBoundingBox, getUserAgent, hasOnlySolidBorders, isBackgroundRequired, setFont, startGroup, startViewport, toPoints

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEBUG

private static final boolean DEBUG

See Also:

• Constant Field Values

gen

private PCLGenerator gen

The PCL generator

currentPageDefinition

private PCLPageDefinition currentPageDefinition

currentPrintDirection

private int currentPrintDirection

graphicContextStack

private Stack<org.apache.xmlgraphics.java2d.GraphicContext> graphicContextStack

graphicContext

private org.apache.xmlgraphics.java2d.GraphicContext graphicContext

sfManager

private PCLSoftFontManager sfManager

currentX

private int currentX

currentY

private int currentY

SAFETY_MARGIN_FACTOR

private static final double SAFETY_MARGIN_FACTOR

See Also:

• Constant Field Values

Constructor Details

PCLPainter

public PCLPainter(PCLDocumentHandler parent,
 PCLPageDefinition pageDefinition)

Main constructor.

Parameters:

parent - the parent document handler

pageDefinition - 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 interface IFPainter

Parameters:

transform - the transformation matrix establishing the new coordinate system

size - the size of the viewport

clipRect - 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.

Specified by:

endViewport in interface IFPainter

Throws:

IFException - if an error occurs while handling this element

startGroup

public void startGroup(AffineTransform transform,
 String layer)
                throws IFException

Starts a new group of graphical elements. Corresponds to SVG's g element.

Specified by:

startGroup in interface IFPainter

Parameters:

transform - the transformation matrix establishing the new coordinate system

layer - 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).

Specified by:

endGroup in interface IFPainter

Throws:

IFException - if an error occurs while handling this element

drawImage

public void drawImage(String uri,
 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.

Specified by:

drawImage in interface IFPainter

Parameters:

uri - the image's URI

rect - the rectangle in which the image shall be painted

Throws:

IFException - if an error occurs while handling this event

createRenderingContext

protected RenderingContext createRenderingContext()

Creates a new RenderingContext instance.

Specified by:

createRenderingContext in class AbstractIFPainter<PCLDocumentHandler>

Returns:

the new rendering context.

drawImage

public void drawImage(Document doc,
 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.

Specified by:

drawImage in interface IFPainter

Parameters:

doc - the DOM document containing the foreign object

rect - the rectangle in which the image shall be painted

Throws:

IFException - if an error occurs while handling this event

clipRect

public void clipRect(Rectangle rect)
              throws IFException

Restricts the current clipping region with the given rectangle.

Specified by:

clipRect in interface IFPainter

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 interface IFPainter

Parameters:

rect - the rectangle's coordinates and extent

bpsBefore - 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(Rectangle rect,
 Paint fill)
              throws IFException

Fills a rectangular area.

Specified by:

fillRect in interface IFPainter

Parameters:

rect - the rectangle's coordinates and extent

fill - 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 interface IFPainter

Overrides:

drawLine in class AbstractIFPainter<PCLDocumentHandler>

Parameters:

start - the start point of the line

end - the end point of the line

width - the line width

color - the line color

style - 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 interface IFPainter

Parameters:

x - X-coordinate of the starting point of the text

y - Y-coordinate of the starting point of the text

letterSpacing - 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

private boolean isTrueType(Typeface tf)

getTypeface

private Typeface getTypeface(String fontName)

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

getCharWidth

private int getCharWidth(int i,
 Font font,
 char orgChar,
 String text)

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

private void concatenateTransformationMatrix(AffineTransform transform)
                                      throws IOException

Throws:

IOException

transformedPoint

private Point2D transformedPoint(int x,
 int y)

changePrintDirection

private void changePrintDirection()
                           throws IOException

Throws:

IOException

setCursorPos

void setCursorPos(int x,
 int y)
           throws IOException

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