CustomGraphicsStreamEngine (PDFBox reactor 2.0.2 API)

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.

Author:

John Hewson

Constructor Summary

Constructors
Modifier Constructor and Description

protected CustomGraphicsStreamEngine(PDPage page)
Constructor.

Constructors
Modifier	Constructor and Description
`protected`	`CustomGraphicsStreamEngine(PDPage page)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`appendRectangle(Point2D p0, Point2D p1, Point2D p2, 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.
`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(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, String unicode, 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 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(String[] args)
                 throws IOException
```
    Throws:
    
    IOException
  - run
```
public void run()
         throws IOException
```
    Runs the engine on the current page.
    
    Throws:
    
    IOException - If there is an IO error while drawing the page.
  - appendRectangle
```
public void appendRectangle(Point2D p0,
                   Point2D p1,
                   Point2D p2,
                   Point2D p3)
                     throws IOException
```
    Description copied from class: PDFGraphicsStreamEngine
    
    Append a rectangle to the current path.
    
    Specified by:
    
    appendRectangle in class PDFGraphicsStreamEngine
    
    Throws:
    
    IOException
  - drawImage
```
public void drawImage(PDImage pdImage)
               throws IOException
```
    Description copied from class: PDFGraphicsStreamEngine
    
    Draw the image.
    
    Specified by:
    
    drawImage in class PDFGraphicsStreamEngine
    
    Parameters:
    pdImage - The image to draw.
    
    Throws:
    
    IOException
  - clip
```
public void clip(int windingRule)
          throws 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:
    
    IOException
  - moveTo
```
public void moveTo(float x,
          float y)
            throws IOException
```
    Description copied from class: PDFGraphicsStreamEngine
    
    Starts a new path at (x,y).
    
    Specified by:
    
    moveTo in class PDFGraphicsStreamEngine
    
    Throws:
    
    IOException
  - lineTo
```
public void lineTo(float x,
          float y)
            throws IOException
```
    Description copied from class: PDFGraphicsStreamEngine
    
    Draws a line from the current point to (x,y).
    
    Specified by:
    
    lineTo in class PDFGraphicsStreamEngine
    
    Throws:
    
    IOException
  - curveTo
```
public void curveTo(float x1,
           float y1,
           float x2,
           float y2,
           float x3,
           float y3)
             throws 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
    
    Throws:
    
    IOException
  - getCurrentPoint
```
public Point2D getCurrentPoint()
                        throws IOException
```
    Description copied from class: PDFGraphicsStreamEngine
    
    Returns the current point of the current path.
    
    Specified by:
    
    getCurrentPoint in class PDFGraphicsStreamEngine
    
    Throws:
    
    IOException
  - closePath
```
public void closePath()
               throws IOException
```
    Description copied from class: PDFGraphicsStreamEngine
    
    Closes the current path.
    
    Specified by:
    
    closePath in class PDFGraphicsStreamEngine
    
    Throws:
    
    IOException
  - endPath
```
public void endPath()
             throws 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:
    
    IOException
  - strokePath
```
public void strokePath()
                throws IOException
```
    Description copied from class: PDFGraphicsStreamEngine
    
    Stroke the path.
    
    Specified by:
    
    strokePath in class PDFGraphicsStreamEngine
    
    Throws:
    
    IOException - If there is an IO error while stroking the path.
  - fillPath
```
public void fillPath(int windingRule)
              throws 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:
    
    IOException
  - fillAndStrokePath
```
public void fillAndStrokePath(int windingRule)
                       throws 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:
    
    IOException
  - shadingFill
```
public void shadingFill(COSName shadingName)
                 throws 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:
    
    IOException
  - showTextString
```
public void showTextString(byte[] string)
                    throws IOException
```
    Overridden from PDFStreamEngine.
    
    Overrides:
    
    showTextString in class PDFStreamEngine
    
    Parameters:
    string - the encoded text
    
    Throws:
    
    IOException - if there was an error showing the text
  - showTextStrings
```
public void showTextStrings(COSArray array)
                     throws IOException
```
    Overridden from PDFStreamEngine.
    
    Overrides:
    
    showTextStrings in class PDFStreamEngine
    
    Parameters:
    array - array of encoded text strings and adjustments
    
    Throws:
    
    IOException - if there was an error showing the text
  - showGlyph
```
protected void showGlyph(Matrix textRenderingMatrix,
             PDFont font,
             int code,
             String unicode,
             Vector displacement)
                  throws 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
    unicode - the Unicode text for this glyph, or null if the PDF does provide it
    displacement - the displacement (i.e. advance) of the glyph in text space
    
    Throws:
    
    IOException - if the glyph cannot be processed

Class CustomGraphicsStreamEngine

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

CustomGraphicsStreamEngine

Method Detail

main

run

appendRectangle

drawImage

clip

moveTo

lineTo

curveTo

getCurrentPoint

closePath

endPath

strokePath

fillPath

fillAndStrokePath

shadingFill

showTextString

showTextStrings

showGlyph