Package org.apache.pdfbox.examples.rendering

Class CustomGraphicsStreamEngine

java.lang.Object

org.apache.pdfbox.contentstream.PDFStreamEngine

org.apache.pdfbox.contentstream.PDFGraphicsStreamEngine

org.apache.pdfbox.examples.rendering.CustomGraphicsStreamEngine

public class CustomGraphicsStreamEngine
extends PDFGraphicsStreamEngine

Example of a custom PDFGraphicsStreamEngine subclass. Allows text and graphics to be processed in a custom manner. This example simply prints the operations to stdout.

See PDFStreamEngine for further methods which may be overridden.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CustomGraphicsStreamEngine(PDPage page)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	appendRectangle(java.awt.geom.Point2D p0, java.awt.geom.Point2D p1, java.awt.geom.Point2D p2, java.awt.geom.Point2D p3)	Append a rectangle to the current path.
void	clip(int windingRule)	Modify the current clipping path by intersecting it with the current path.
void	closePath()	Closes the current path.
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.
void	drawImage(PDImage pdImage)	Draw the image.
void	endPath()	Ends the current path without filling or stroking it.
void	fillAndStrokePath(int windingRule)	Fills and then strokes the path.
void	fillPath(int windingRule)	Fill the path.
java.awt.geom.Point2D	getCurrentPoint()	Returns the current point of the current path.
void	lineTo(float x, float y)	Draws a line from the current point to (x,y).
static void	main(java.lang.String[] args)
void	moveTo(float x, float y)	Starts a new path at (x,y).
void	run()	Runs the engine on the current page.
void	shadingFill(COSName shadingName)	Fill with Shading.
protected void	showGlyph(Matrix textRenderingMatrix, PDFont font, int code, Vector displacement)	Overridden from PDFStreamEngine.
void	showTextString(byte[] string)	Overridden from PDFStreamEngine.
void	showTextStrings(COSArray array)	Overridden from PDFStreamEngine.
void	strokePath()	Stroke the path.

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

getPage

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, showText, showTransparencyGroup, showType3Glyph, transformedPoint, transformWidth, unsupportedOperator

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomGraphicsStreamEngine

protected CustomGraphicsStreamEngine(PDPage page)

Constructor.

Parameters:

page - PDF Page

Method Detail

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException

Throws:

java.io.IOException

run

public void run()
         throws java.io.IOException

Runs the engine on the current page.

Throws:

java.io.IOException - If there is an IO error while drawing the page.

appendRectangle

public void appendRectangle(java.awt.geom.Point2D p0,
                            java.awt.geom.Point2D p1,
                            java.awt.geom.Point2D p2,
                            java.awt.geom.Point2D p3)
                     throws java.io.IOException

Description copied from class: PDFGraphicsStreamEngine

Append a rectangle to the current path.

Specified by:

appendRectangle in class PDFGraphicsStreamEngine

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:

java.io.IOException - if the rectangle could not be appended

drawImage

public void drawImage(PDImage pdImage)
               throws java.io.IOException

Description copied from class: PDFGraphicsStreamEngine

Draw the image.

Specified by:

drawImage in class PDFGraphicsStreamEngine

Parameters:

pdImage - The image to draw.

Throws:

java.io.IOException - if the image could not be drawn

clip

public void clip(int windingRule)
          throws java.io.IOException

Description copied from class: PDFGraphicsStreamEngine

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.

Specified by:

clip in class PDFGraphicsStreamEngine

Parameters:

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

Throws:

java.io.IOException - if the clipping path could not be modified

moveTo

public void moveTo(float x,
                   float y)
            throws java.io.IOException

Description copied from class: PDFGraphicsStreamEngine

Starts a new path at (x,y).

Specified by:

moveTo in class PDFGraphicsStreamEngine

Parameters:

x - the x-coordinate to move to

y - the y-coordinate to move to

Throws:

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

lineTo

public void lineTo(float x,
                   float y)
            throws java.io.IOException

Description copied from class: PDFGraphicsStreamEngine

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

Specified by:

lineTo in class PDFGraphicsStreamEngine

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:

java.io.IOException - if the line could not be drawn

curveTo

public void curveTo(float x1,
                    float y1,
                    float x2,
                    float y2,
                    float x3,
                    float y3)
             throws java.io.IOException

Description copied from class: PDFGraphicsStreamEngine

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

Specified by:

curveTo in class PDFGraphicsStreamEngine

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:

java.io.IOException - if the curve could not be drawn

getCurrentPoint

public java.awt.geom.Point2D getCurrentPoint()
                                      throws java.io.IOException

Description copied from class: PDFGraphicsStreamEngine

Returns the current point of the current path.

Specified by:

getCurrentPoint in class PDFGraphicsStreamEngine

Returns:

the current point or null

Throws:

java.io.IOException - if the something went wrong when providing the current point

closePath

public void closePath()
               throws java.io.IOException

Description copied from class: PDFGraphicsStreamEngine

Closes the current path.

Specified by:

closePath in class PDFGraphicsStreamEngine

Throws:

java.io.IOException - if the current path could not be closed

endPath

public void endPath()
             throws java.io.IOException

Description copied from class: PDFGraphicsStreamEngine

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

Specified by:

endPath in class PDFGraphicsStreamEngine

Throws:

java.io.IOException - if the current path could not be ended

strokePath

public void strokePath()
                throws java.io.IOException

Description copied from class: PDFGraphicsStreamEngine

Stroke the path.

Specified by:

strokePath in class PDFGraphicsStreamEngine

Throws:

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

fillPath

public void fillPath(int windingRule)
              throws java.io.IOException

Description copied from class: PDFGraphicsStreamEngine

Fill the path.

Specified by:

fillPath in class PDFGraphicsStreamEngine

Parameters:

windingRule - The winding rule this path will use.

Throws:

java.io.IOException - if the path could not be filled

fillAndStrokePath

public void fillAndStrokePath(int windingRule)
                       throws java.io.IOException

Description copied from class: PDFGraphicsStreamEngine

Fills and then strokes the path.

Specified by:

fillAndStrokePath in class PDFGraphicsStreamEngine

Parameters:

windingRule - The winding rule this path will use.

Throws:

java.io.IOException - if the path could not be filled and stroke

shadingFill

public void shadingFill(COSName shadingName)
                 throws java.io.IOException

Description copied from class: PDFGraphicsStreamEngine

Fill with Shading.

Specified by:

shadingFill in class PDFGraphicsStreamEngine

Parameters:

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

Throws:

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

showTextString

public void showTextString(byte[] string)
                    throws java.io.IOException

Overridden from PDFStreamEngine.

Overrides:

showTextString in class PDFStreamEngine

Parameters:

string - the encoded text

Throws:

java.io.IOException - if there was an error showing the text

showTextStrings

public void showTextStrings(COSArray array)
                     throws java.io.IOException

Overridden from PDFStreamEngine.

Overrides:

showTextStrings in class PDFStreamEngine

Parameters:

array - array of encoded text strings and adjustments

Throws:

java.io.IOException - if there was an error showing the text

showGlyph

protected void showGlyph(Matrix textRenderingMatrix,
                         PDFont font,
                         int code,
                         Vector displacement)
                  throws java.io.IOException

Overridden from PDFStreamEngine.

Overrides:

showGlyph in class PDFStreamEngine

Parameters:

textRenderingMatrix - the current text rendering matrix, T_rm

font - the current font

code - internal PDF character code for the glyph

displacement - the displacement (i.e. advance) of the glyph in text space

Throws:

java.io.IOException - if the glyph cannot be processed