Package org.apache.pdfbox.contentstream

Class PDFGraphicsStreamEngine

java.lang.Object

org.apache.pdfbox.contentstream.PDFStreamEngine

org.apache.pdfbox.contentstream.PDFGraphicsStreamEngine

Direct Known Subclasses:

CustomGraphicsStreamEngine, ExtractImages.ImageGraphicsEngine, PageDrawer

public abstract class PDFGraphicsStreamEngine
extends PDFStreamEngine

PDFStreamEngine subclass for advanced processing of graphics. This class should be subclassed by end users looking to hook into graphics operations.

Field Summary

Fields

Modifier and Type	Field	Description
private final PDPage	page

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PDFGraphicsStreamEngine(PDPage page)	Constructor.

Method Summary

Modifier and Type	Method	Description
abstract void	appendRectangle(Point2D p0, Point2D p1, Point2D p2, Point2D p3)	Append a rectangle to the current path.
abstract void	clip(int windingRule)	Modify the current clipping path by intersecting it with the current path.
abstract void	closePath()	Closes the current path.
abstract void	curveTo(float x1, float y1, float x2, float y2, float x3, float y3)	Draws a curve from the current point to (x3,y3) using (x1,y1) and (x2,y2) as control points.
abstract void	drawImage(PDImage pdImage)	Draw the image.
abstract void	endPath()	Ends the current path without filling or stroking it.
abstract void	fillAndStrokePath(int windingRule)	Fills and then strokes the path.
abstract void	fillPath(int windingRule)	Fill the path.
abstract Point2D	getCurrentPoint()	Returns the current point of the current path.
protected final PDPage	getPage()	Returns the page.
abstract void	lineTo(float x, float y)	Draws a line from the current point to (x,y).
abstract void	moveTo(float x, float y)	Starts a new path at (x,y).
abstract void	shadingFill(COSName shadingName)	Fill with Shading.
abstract void	strokePath()	Stroke the path.

Methods inherited from class org.apache.pdfbox.contentstream.PDFStreamEngine

addOperator, applyTextAdjustment, beginMarkedContentSequence, beginText, decreaseLevel, endMarkedContentSequence, endText, getAppearance, getCurrentPage, getGraphicsStackSize, getGraphicsState, getInitialMatrix, getLevel, getResources, getTextLineMatrix, getTextMatrix, increaseLevel, isShouldProcessColorOperators, markedContentPoint, operatorException, processAnnotation, processChildStream, processOperator, processOperator, processPage, processSoftMask, processTilingPattern, processTilingPattern, processTransparencyGroup, processType3Stream, restoreGraphicsStack, restoreGraphicsState, saveGraphicsStack, saveGraphicsState, setLineDashPattern, setTextLineMatrix, setTextMatrix, showAnnotation, showFontGlyph, showForm, showGlyph, showText, showTextString, showTextStrings, showTransparencyGroup, showType3Glyph, transformedPoint, transformWidth, unsupportedOperator

Methods inherited from class java.lang.Object

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

Field Details

page

private final PDPage page

Constructor Details

PDFGraphicsStreamEngine

protected PDFGraphicsStreamEngine(PDPage page)

Constructor.

Parameters:

page - the page the content stream belongs to

Method Details

getPage

protected final PDPage getPage()

Returns the page.

Returns:

the current page

appendRectangle

public abstract void appendRectangle(Point2D p0,
 Point2D p1,
 Point2D p2,
 Point2D p3)
                              throws IOException

Append a rectangle to the current path.

Parameters:

p0 - starting coordinate of the rectangle

p1 - second coordinate of the rectangle

p2 - third coordinate of the rectangle

p3 - last coordinate of the rectangle

Throws:

IOException - if the rectangle could not be appended

drawImage

public abstract void drawImage(PDImage pdImage)
                        throws IOException

Draw the image.

Parameters:

pdImage - The image to draw.

Throws:

IOException - if the image could not be drawn

clip

public abstract void clip(int windingRule)
                   throws IOException

Modify the current clipping path by intersecting it with the current path. The clipping path will not be updated until the succeeding painting operator is called.

Parameters:

windingRule - The winding rule which will be used for clipping.

Throws:

IOException - if the clipping path could not be modified

moveTo

public abstract void moveTo(float x,
 float y)
                     throws IOException

Starts a new path at (x,y).

Parameters:

x - the x-coordinate to move to

y - the y-coordinate to move to

Throws:

IOException - if the something went wrong when moving to the given coordinate

lineTo

public abstract void lineTo(float x,
 float y)
                     throws IOException

Draws a line from the current point to (x,y).

Parameters:

x - the X-coordinate of the ending-point of the line to be drawn

y - the Y-coordinate of the ending-point of the line to be drawn

Throws:

IOException - if the line could not be drawn

curveTo

public abstract void curveTo(float x1,
 float y1,
 float x2,
 float y2,
 float x3,
 float y3)
                      throws IOException

Draws a curve from the current point to (x3,y3) using (x1,y1) and (x2,y2) as control points.

Parameters:

x1 - the X coordinate of the first Bézier control point

y1 - the Y coordinate of the first Bézier control point

x2 - the X coordinate of the second Bézier control point

y2 - the Y coordinate of the second Bézier control point

x3 - the X coordinate of the final end point

y3 - the Y coordinate of the final end point

Throws:

IOException - if the curve could not be drawn

getCurrentPoint

public abstract Point2D getCurrentPoint()
                                 throws IOException

Returns the current point of the current path.

Returns:

the current point or null

Throws:

IOException - if the something went wrong when providing the current point

closePath

public abstract void closePath()
                        throws IOException

Closes the current path.

Throws:

IOException - if the current path could not be closed

endPath

public abstract void endPath()
                      throws IOException

Ends the current path without filling or stroking it. The clipping path is updated here.

Throws:

IOException - if the current path could not be ended

strokePath

public abstract void strokePath()
                         throws IOException

Stroke the path.

Throws:

IOException - If there is an IO error while stroking the path.

fillPath

public abstract void fillPath(int windingRule)
                       throws IOException

Fill the path.

Parameters:

windingRule - The winding rule this path will use.

Throws:

IOException - if the path could not be filled

fillAndStrokePath

public abstract void fillAndStrokePath(int windingRule)
                                throws IOException

Fills and then strokes the path.

Parameters:

windingRule - The winding rule this path will use.

Throws:

IOException - if the path could not be filled and stroke

shadingFill

public abstract void shadingFill(COSName shadingName)
                          throws IOException

Fill with Shading.

Parameters:

shadingName - The name of the Shading Dictionary to use for this fill instruction.

Throws:

IOException - if the path could not be filled using the given shading