PageDrawer (Apache PDFBox 2.0.0 API)

java.lang.Object
- org.apache.pdfbox.contentstream.PDFStreamEngine
- - org.apache.pdfbox.contentstream.PDFGraphicsStreamEngine
  - - org.apache.pdfbox.rendering.PageDrawer

```
public class PageDrawer
extends PDFGraphicsStreamEngine
```
Paints a page in a PDF document to a Graphics context. May be subclassed to provide custom rendering.
If you want to do custom graphics processing rather than Graphics2D rendering, then you should subclass PDFGraphicsStreamEngine instead. Subclassing PageDrawer is only suitable for cases where the goal is to render onto a Graphics2D surface.

Author:

Ben Litchfield

Constructor Summary

Constructors
Constructor and Description

PageDrawer(PageDrawerParameters parameters)
Constructor.

Constructors
Constructor and Description
`PageDrawer(PageDrawerParameters parameters)` 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`	`beginText()` Called when the BT operator is encountered.
`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`	`drawPage(Graphics g, PDRectangle pageSize)` Draws the page to the requested context.
`void`	`endPath()` Ends the current path without filling or stroking it.
`void`	`endText()` Called when the ET operator is encountered.
`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.
`protected Graphics2D`	`getGraphics()` Returns the underlying Graphics2D.
`protected GeneralPath`	`getLinePath()` Returns the current line path.
`protected Paint`	`getPaint(PDColor color)` Returns an AWT paint for the given PDColor.
`PDFRenderer`	`getRenderer()` Returns the parent renderer.
`void`	`lineTo(float x, float y)` Draws a line from the current point to (x,y).
`void`	`moveTo(float x, float y)` Starts a new path at (x,y).
`void`	`shadingFill(COSName shadingName)` Fill with Shading.
`void`	`showAnnotation(PDAnnotation annotation)` Shows the given annotation.
`protected void`	`showFontGlyph(Matrix textRenderingMatrix, PDFont font, int code, String unicode, Vector displacement)` Called when a glyph is to be processed.This method is intended for overriding in subclasses, the default implementation does nothing.
`void`	`showTransparencyGroup(PDTransparencyGroup form)` Shows a transparency group from the content stream.
`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
  - PageDrawer
```
public PageDrawer(PageDrawerParameters parameters)
           throws IOException
```
    Constructor.
    
    Parameters:
    parameters - Parameters for page drawing.
    
    Throws:
    
    IOException - If there is an error loading properties from the file.
- Method Detail
  - getRenderer
```
public final PDFRenderer getRenderer()
```
    Returns the parent renderer.
  - getGraphics
```
protected final Graphics2D getGraphics()
```
    Returns the underlying Graphics2D. May be null if drawPage has not yet been called.
  - getLinePath
```
protected final GeneralPath getLinePath()
```
    Returns the current line path. This is reset to empty after each fill/stroke.
  - drawPage
```
public void drawPage(Graphics g,
            PDRectangle pageSize)
              throws IOException
```
    Draws the page to the requested context.
    
    Parameters:
    g - The graphics context to draw onto.
    pageSize - The size of the page to draw.
    
    Throws:
    
    IOException - If there is an IO error while drawing the page.
  - getPaint
```
protected Paint getPaint(PDColor color)
                  throws IOException
```
    Returns an AWT paint for the given PDColor.
    
    Throws:
    
    IOException
  - beginText
```
public void beginText()
               throws IOException
```
    Description copied from class: PDFStreamEngine
    
    Called when the BT operator is encountered. This method is for overriding in subclasses, the default implementation does nothing.
    
    Overrides:
    
    beginText in class PDFStreamEngine
    
    Throws:
    
    IOException - if there was an error processing the text
  - endText
```
public void endText()
             throws IOException
```
    Description copied from class: PDFStreamEngine
    
    Called when the ET operator is encountered. This method is for overriding in subclasses, the default implementation does nothing.
    
    Overrides:
    
    endText in class PDFStreamEngine
    
    Throws:
    
    IOException - if there was an error processing the text
  - showFontGlyph
```
protected void showFontGlyph(Matrix textRenderingMatrix,
                 PDFont font,
                 int code,
                 String unicode,
                 Vector displacement)
                      throws IOException
```
    Description copied from class: PDFStreamEngine
    
    Called when a glyph is to be processed.This method is intended for overriding in subclasses, the default implementation does nothing.
    
    Overrides:
    
    showFontGlyph 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
  - appendRectangle
```
public void appendRectangle(Point2D p0,
                   Point2D p1,
                   Point2D p2,
                   Point2D p3)
```
    Description copied from class: PDFGraphicsStreamEngine
    
    Append a rectangle to the current path.
    
    Specified by:
    
    appendRectangle in class PDFGraphicsStreamEngine
  - 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
```
    Fills and then strokes the path.
    
    Specified by:
    
    fillAndStrokePath in class PDFGraphicsStreamEngine
    
    Parameters:
    windingRule - The winding rule this path will use.
    
    Throws:
    
    IOException - If there is an IO error while filling the path.
  - clip
```
public void clip(int windingRule)
```
    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.
  - moveTo
```
public void moveTo(float x,
          float y)
```
    Description copied from class: PDFGraphicsStreamEngine
    
    Starts a new path at (x,y).
    
    Specified by:
    
    moveTo in class PDFGraphicsStreamEngine
  - lineTo
```
public void lineTo(float x,
          float y)
```
    Description copied from class: PDFGraphicsStreamEngine
    
    Draws a line from the current point to (x,y).
    
    Specified by:
    
    lineTo in class PDFGraphicsStreamEngine
  - curveTo
```
public void curveTo(float x1,
           float y1,
           float x2,
           float y2,
           float x3,
           float y3)
```
    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
  - getCurrentPoint
```
public Point2D getCurrentPoint()
```
    Description copied from class: PDFGraphicsStreamEngine
    
    Returns the current point of the current path.
    
    Specified by:
    
    getCurrentPoint in class PDFGraphicsStreamEngine
  - closePath
```
public void closePath()
```
    Description copied from class: PDFGraphicsStreamEngine
    
    Closes the current path.
    
    Specified by:
    
    closePath in class PDFGraphicsStreamEngine
  - endPath
```
public void endPath()
```
    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
  - 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
  - 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
  - showAnnotation
```
public void showAnnotation(PDAnnotation annotation)
                    throws IOException
```
    Description copied from class: PDFStreamEngine
    
    Shows the given annotation.
    
    Overrides:
    
    showAnnotation in class PDFStreamEngine
    
    Parameters:
    annotation - An annotation on the current page.
    
    Throws:
    
    IOException - If an error occurred reading the annotation
  - showTransparencyGroup
```
public void showTransparencyGroup(PDTransparencyGroup form)
                           throws IOException
```
    Description copied from class: PDFStreamEngine
    
    Shows a transparency group from the content stream.
    
    Overrides:
    
    showTransparencyGroup in class PDFStreamEngine
    
    Parameters:
    form - transparency group (form) XObject
    
    Throws:
    
    IOException - if the transparency group cannot be processed

Class PageDrawer

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

PageDrawer

Method Detail

getRenderer

getGraphics

getLinePath

drawPage

getPaint

beginText

endText

showFontGlyph

appendRectangle

strokePath

fillPath

fillAndStrokePath

clip

moveTo

lineTo

curveTo

getCurrentPoint

closePath

endPath

drawImage

shadingFill

showAnnotation

showTransparencyGroup