PDPageContentStream (PDFBox reactor 2.0.8 API)

java.lang.Object
- org.apache.pdfbox.pdmodel.PDPageContentStream

All Implemented Interfaces:

Closeable, AutoCloseable
```
public final class PDPageContentStream
extends Object
implements Closeable
```
Provides the ability to write to a page content stream.

Author:

Ben Litchfield

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PDPageContentStream.AppendMode
This is to choose what to do with the stream: overwrite, append or prepend.

Nested Classes
Modifier and Type	Class and Description
`static class`	`PDPageContentStream.AppendMode` This is to choose what to do with the stream: overwrite, append or prepend.

Constructor Summary

Constructors
Constructor and Description
`PDPageContentStream(PDDocument doc, PDAppearanceStream appearance)` Create a new appearance stream.
`PDPageContentStream(PDDocument doc, PDAppearanceStream appearance, OutputStream outputStream)` Create a new appearance stream.
`PDPageContentStream(PDDocument document, PDPage sourcePage)` Create a new PDPage content stream.
`PDPageContentStream(PDDocument document, PDPage sourcePage, boolean appendContent, boolean compress)` Deprecated. use `PDPageContentStream(PDDocument, PDPage, PDPageContentStream.AppendMode, boolean)`
`PDPageContentStream(PDDocument document, PDPage sourcePage, boolean appendContent, boolean compress, boolean resetContext)` Deprecated. use `PDPageContentStream(PDDocument, PDPage, PDPageContentStream.AppendMode, boolean, boolean)`
`PDPageContentStream(PDDocument document, PDPage sourcePage, PDPageContentStream.AppendMode appendContent, boolean compress)` Create a new PDPage content stream.
`PDPageContentStream(PDDocument document, PDPage sourcePage, PDPageContentStream.AppendMode appendContent, boolean compress, boolean resetContext)` Create a new PDPage content stream.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addBezier31(float x1, float y1, float x3, float y3)` Deprecated. Use `curveTo1(float, float, float, float)` instead.
`void`	`addBezier312(float x1, float y1, float x2, float y2, float x3, float y3)` Deprecated. Use `curveTo(float, float, float, float, float, float)` instead.
`void`	`addBezier32(float x2, float y2, float x3, float y3)` Deprecated. Use `curveTo2(float, float, float, float)` instead.
`void`	`addComment(String comment)` Write a comment line.
`void`	`addLine(float xStart, float yStart, float xEnd, float yEnd)` Deprecated. Use `moveto(xStart,yStart)` followed by `lineTo(xEnd,yEnd)`.
`void`	`addPolygon(float[] x, float[] y)` Deprecated. Use `moveTo(float, float)` and `lineTo(float, float)` methods instead.
`void`	`addRect(float x, float y, float width, float height)` Add a rectangle to the current path.
`void`	`appendCOSName(COSName name)` Deprecated. This method will be removed in a future release.
`void`	`appendRawCommands(byte[] commands)` Deprecated. This method will be removed in a future release.
`void`	`appendRawCommands(double data)` Deprecated. This method will be removed in a future release.
`void`	`appendRawCommands(float data)` Deprecated. This method will be removed in a future release.
`void`	`appendRawCommands(int data)` Deprecated. This method will be removed in a future release.
`void`	`appendRawCommands(String commands)` Deprecated. This method will be removed in a future release.
`void`	`beginMarkedContent(COSName tag)` Begin a marked content sequence.
`void`	`beginMarkedContent(COSName tag, PDPropertyList propertyList)` Begin a marked content sequence with a reference to an entry in the page resources' Properties dictionary.
`void`	`beginMarkedContentSequence(COSName tag)` Deprecated. Use `beginMarkedContent(org.apache.pdfbox.cos.COSName)` instead.
`void`	`beginMarkedContentSequence(COSName tag, COSName propsName)` Deprecated. Use `beginMarkedContent(COSName, PDPropertyList)` instead.
`void`	`beginText()` Begin some text operations.
`void`	`clip()` Intersects the current clipping path with the current path, using the nonzero rule.
`void`	`clipEvenOdd()` Intersects the current clipping path with the current path, using the even-odd rule.
`void`	`clipPath(int windingRule)` Deprecated. Use `clip()` or `clipEvenOdd()` instead.
`void`	`close()` Close the content stream.
`void`	`closeAndFillAndStroke()` Close, fill, and then stroke the path, using the nonzero winding number rule to determine the region to fill.
`void`	`closeAndFillAndStrokeEvenOdd()` Close, fill, and then stroke the path, using the even-odd rule to determine the region to fill.
`void`	`closeAndStroke()` Close and stroke the path.
`void`	`closePath()` Closes the current subpath.
`void`	`closeSubPath()` Deprecated. Use `closePath()` instead.
`void`	`concatenate2CTM(AffineTransform at)` Deprecated. Use `transform(org.apache.pdfbox.util.Matrix)` instead.
`void`	`concatenate2CTM(double a, double b, double c, double d, double e, double f)` Deprecated. Use `transform(org.apache.pdfbox.util.Matrix)` instead.
`void`	`curveTo(float x1, float y1, float x2, float y2, float x3, float y3)` Append a cubic Bézier curve to the current path.
`void`	`curveTo1(float x1, float y1, float x3, float y3)` Append a cubic Bézier curve to the current path.
`void`	`curveTo2(float x2, float y2, float x3, float y3)` Append a cubic Bézier curve to the current path.
`void`	`drawForm(PDFormXObject form)` Draws the given Form XObject at the current location.
`void`	`drawImage(PDImageXObject image, float x, float y)` Draw an image at the x,y coordinates, with the default size of the image.
`void`	`drawImage(PDImageXObject image, float x, float y, float width, float height)` Draw an image at the x,y coordinates, with the given size.
`void`	`drawImage(PDImageXObject image, Matrix matrix)` Draw an image at the origin with the given transformation matrix.
`void`	`drawImage(PDInlineImage inlineImage, float x, float y)` Draw an inline image at the x,y coordinates, with the default size of the image.
`void`	`drawImage(PDInlineImage inlineImage, float x, float y, float width, float height)` Draw an inline image at the x,y coordinates and a certain width and height.
`void`	`drawInlineImage(PDInlineImage inlineImage, float x, float y)` Deprecated. Use `drawImage(PDInlineImage, float, float)` instead.
`void`	`drawInlineImage(PDInlineImage inlineImage, float x, float y, float width, float height)` Deprecated. Use `drawImage(PDInlineImage, float, float, float, float)` instead.
`void`	`drawLine(float xStart, float yStart, float xEnd, float yEnd)` Deprecated. Use `moveto(xStart,yStart)` followed by `lineTo(xEnd,yEnd)` followed by `stroke()`.
`void`	`drawPolygon(float[] x, float[] y)` Deprecated. Use `moveTo(float, float)` and `lineTo(float, float)` methods instead.
`void`	`drawString(String text)` Deprecated. Use `showText(java.lang.String)` instead.
`void`	`drawXObject(PDXObject xobject, AffineTransform transform)` Deprecated. Use `drawImage(PDImageXObject, Matrix)` or `drawForm(PDFormXObject)` with `transform(Matrix)` instead.
`void`	`drawXObject(PDXObject xobject, float x, float y, float width, float height)` Deprecated. Use `drawImage(org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject, float, float)` instead.
`void`	`endMarkedContent()` End a marked content sequence.
`void`	`endMarkedContentSequence()` Deprecated. Use `endMarkedContent()` instead.
`void`	`endText()` End some text operations.
`void`	`fill()` Fills the path using the nonzero winding number rule.
`void`	`fill(int windingRule)` Deprecated. Use `fill()` or `fillEvenOdd()` instead.
`void`	`fillAndStroke()` Fill and then stroke the path, using the nonzero winding number rule to determine the region to fill.
`void`	`fillAndStrokeEvenOdd()` Fill and then stroke the path, using the even-odd rule to determine the region to fill.
`void`	`fillEvenOdd()` Fills the path using the even-odd winding rule.
`void`	`fillPolygon(float[] x, float[] y)` Deprecated. Use `moveTo(float, float)` and `lineTo(float, float)` methods instead.
`void`	`fillRect(float x, float y, float width, float height)` Deprecated. Use `addRect(float, float, float, float)` followed by `fill()` instead.
`void`	`lineTo(float x, float y)` Draw a line from the current position to the given coordinates.
`void`	`moveTextPositionByAmount(float tx, float ty)` Deprecated. Use `newLineAtOffset(float, float)` instead.
`void`	`moveTo(float x, float y)` Move the current position to the given coordinates.
`void`	`newLine()` Move to the start of the next line of text.
`void`	`newLineAtOffset(float tx, float ty)` The Td operator.
`void`	`restoreGraphicsState()` Q operator.
`void`	`saveGraphicsState()` q operator.
`void`	`setCharacterSpacing(float spacing)` Set the character spacing.
`void`	`setFont(PDFont font, float fontSize)` Set the font and font size to draw text with.
`void`	`setGraphicsStateParameters(PDExtendedGraphicsState state)` Set an extended graphics state.
`void`	`setHorizontalScaling(float scale)` Set the horizontal scaling to scale / 100.
`void`	`setLeading(double leading)` Sets the text leading.
`void`	`setLineCapStyle(int lineCapStyle)` Set the line cap style.
`void`	`setLineDashPattern(float[] pattern, float phase)` Set the line dash pattern.
`void`	`setLineJoinStyle(int lineJoinStyle)` Set the line join style.
`void`	`setLineWidth(float lineWidth)` Set line width to the given value.
`void`	`setMiterLimit(float miterLimit)` Set the miter limit.
`void`	`setNonStrokingColor(Color color)` Set the non-stroking color using an AWT color.
`void`	`setNonStrokingColor(double g)` Set the non-stroking color in the DeviceGray color space.
`void`	`setNonStrokingColor(double c, double m, double y, double k)` Set the non-stroking color in the DeviceRGB color space.
`void`	`setNonStrokingColor(float[] components)` Deprecated. Use `setNonStrokingColor(PDColor)` instead.
`void`	`setNonStrokingColor(int g)` Set the non-stroking color in the DeviceGray color space.
`void`	`setNonStrokingColor(int r, int g, int b)` Set the non-stroking color in the DeviceRGB color space.
`void`	`setNonStrokingColor(int c, int m, int y, int k)` Set the non-stroking color in the DeviceCMYK color space.
`void`	`setNonStrokingColor(PDColor color)` Sets the non-stroking color and, if necessary, the non-stroking color space.
`void`	`setNonStrokingColorSpace(PDColorSpace colorSpace)` Deprecated. Use `setNonStrokingColor(org.apache.pdfbox.pdmodel.graphics.color.PDColor)` instead.
`void`	`setRenderingMode(RenderingMode rm)` Set the text rendering mode.
`void`	`setStrokingColor(Color color)` Set the stroking color using an AWT color.
`void`	`setStrokingColor(double g)` Set the stroking color in the DeviceGray color space.
`void`	`setStrokingColor(float[] components)` Deprecated. Use `setStrokingColor(PDColor)` instead.
`void`	`setStrokingColor(float c, float m, float y, float k)` Set the stroking color in the DeviceCMYK color space.
`void`	`setStrokingColor(int g)` Deprecated. Use `setStrokingColor(double)` instead.
`void`	`setStrokingColor(int r, int g, int b)` Set the stroking color in the DeviceRGB color space.
`void`	`setStrokingColor(int c, int m, int y, int k)` Deprecated. Use `setStrokingColor(float, float, float, float)` instead.
`void`	`setStrokingColor(PDColor color)` Sets the stroking color and, if necessary, the stroking color space.
`void`	`setStrokingColorSpace(PDColorSpace colorSpace)` Deprecated. Use `setStrokingColor(org.apache.pdfbox.pdmodel.graphics.color.PDColor)` instead.
`void`	`setTextMatrix(AffineTransform matrix)` Deprecated. Use `setTextMatrix(Matrix)` instead.
`void`	`setTextMatrix(double a, double b, double c, double d, double e, double f)` Deprecated. Use `setTextMatrix(Matrix)` instead.
`void`	`setTextMatrix(Matrix matrix)` The Tm operator.
`void`	`setTextRotation(double angle, double tx, double ty)` Deprecated. Use `setTextMatrix(Matrix)` instead.
`void`	`setTextScaling(double sx, double sy, double tx, double ty)` Deprecated. Use `setTextMatrix(Matrix)` instead.
`void`	`setTextTranslation(double tx, double ty)` Deprecated. Use `setTextMatrix(Matrix)` instead.
`void`	`setWordSpacing(float spacing)` Set the word spacing.
`void`	`shadingFill(PDShading shading)` Fills the clipping area with the given shading.
`void`	`showText(String text)` Shows the given text at the location specified by the current text matrix.
`void`	`stroke()` Stroke the path.
`void`	`transform(Matrix matrix)` The cm operator.
`protected void`	`writeOperand(float real)` Writes a real number to the content stream.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PDPageContentStream
```
public PDPageContentStream(PDDocument document,
                   PDPage sourcePage)
                    throws IOException
```
    Create a new PDPage content stream. This constructor overwrites all existing content streams of this page.
    
    Parameters:
    document - The document the page is part of.
    sourcePage - The page to write the contents to.
    
    Throws:
    
    IOException - If there is an error writing to the page contents.
  - PDPageContentStream
```
@Deprecated
public PDPageContentStream(PDDocument document,
                              PDPage sourcePage,
                              boolean appendContent,
                              boolean compress)
                    throws IOException
```
    Deprecated. use PDPageContentStream(PDDocument, PDPage, PDPageContentStream.AppendMode, boolean)
    
    Create a new PDPage content stream.
    
    Parameters:
    document - The document the page is part of.
    sourcePage - The page to write the contents to.
    appendContent - Indicates whether content will be overwritten. If false all previous content is deleted.
    compress - Tell if the content stream should compress the page contents.
    
    Throws:
    
    IOException - If there is an error writing to the page contents.
  - PDPageContentStream
```
public PDPageContentStream(PDDocument document,
                   PDPage sourcePage,
                   PDPageContentStream.AppendMode appendContent,
                   boolean compress)
                    throws IOException
```
    Create a new PDPage content stream. If the appendContent parameter is set to PDPageContentStream.AppendMode.APPEND, you may want to use PDPageContentStream(PDDocument, PDPage, PDPageContentStream.AppendMode, boolean, boolean) instead, with the fifth parameter set to true.
    
    Parameters:
    document - The document the page is part of.
    sourcePage - The page to write the contents to.
    appendContent - Indicates whether content will be overwritten, appended or prepended.
    compress - Tell if the content stream should compress the page contents.
    
    Throws:
    
    IOException - If there is an error writing to the page contents.
  - PDPageContentStream
```
@Deprecated
public PDPageContentStream(PDDocument document,
                              PDPage sourcePage,
                              boolean appendContent,
                              boolean compress,
                              boolean resetContext)
                    throws IOException
```
    Deprecated. use PDPageContentStream(PDDocument, PDPage, PDPageContentStream.AppendMode, boolean, boolean)
    
    Create a new PDPage content stream.
    
    Parameters:
    document - The document the page is part of.
    sourcePage - The page to write the contents to.
    appendContent - Indicates whether content will be overwritten. If false all previous content is deleted.
    compress - Tell if the content stream should compress the page contents.
    resetContext - Tell if the graphic context should be reseted. You should use this when appending to an existing stream, because the existing stream may have changed graphic properties (e.g. scaling, rotation).
    
    Throws:
    
    IOException - If there is an error writing to the page contents.
  - PDPageContentStream
```
public PDPageContentStream(PDDocument document,
                   PDPage sourcePage,
                   PDPageContentStream.AppendMode appendContent,
                   boolean compress,
                   boolean resetContext)
                    throws IOException
```
    Create a new PDPage content stream.
    
    Parameters:
    document - The document the page is part of.
    sourcePage - The page to write the contents to.
    appendContent - Indicates whether content will be overwritten, appended or prepended.
    compress - Tell if the content stream should compress the page contents.
    resetContext - Tell if the graphic context should be reset. This is only relevant when the appendContent parameter is set to PDPageContentStream.AppendMode.APPEND. You should use this when appending to an existing stream, because the existing stream may have changed graphic properties (e.g. scaling, rotation).
    
    Throws:
    
    IOException - If there is an error writing to the page contents.
  - PDPageContentStream
```
public PDPageContentStream(PDDocument doc,
                   PDAppearanceStream appearance)
                    throws IOException
```
    Create a new appearance stream. Note that this is not actually a "page" content stream.
    
    Parameters:
    doc - The document the page is part of.
    appearance - The appearance stream to write to.
    
    Throws:
    
    IOException - If there is an error writing to the page contents.
  - PDPageContentStream
```
public PDPageContentStream(PDDocument doc,
                   PDAppearanceStream appearance,
                   OutputStream outputStream)
                    throws IOException
```
    Create a new appearance stream. Note that this is not actually a "page" content stream.
    
    Parameters:
    doc - The document the appearance is part of.
    appearance - The appearance stream to add to.
    outputStream - The appearances output stream to write to.
    
    Throws:
    
    IOException - If there is an error writing to the page contents.
- Method Detail
  - beginText
```
public void beginText()
               throws IOException
```
    Begin some text operations.
    
    Throws:
    
    IOException - If there is an error writing to the stream or if you attempt to nest beginText calls.
    
    IllegalStateException - If the method was not allowed to be called at this time.
  - endText
```
public void endText()
             throws IOException
```
    End some text operations.
    
    Throws:
    
    IOException - If there is an error writing to the stream or if you attempt to nest endText calls.
    
    IllegalStateException - If the method was not allowed to be called at this time.
  - setFont
```
public void setFont(PDFont font,
           float fontSize)
             throws IOException
```
    Set the font and font size to draw text with.
    
    Parameters:
    font - The font to use.
    fontSize - The font size to draw the text.
    
    Throws:
    
    IOException - If there is an error writing the font information.
  - drawString
```
@Deprecated
public void drawString(String text)
                throws IOException
```
    Deprecated. Use showText(java.lang.String) instead.
    
    This will draw a string at the current location on the screen.
    
    Parameters:
    text - The text to draw.
    
    Throws:
    
    IOException - If an io exception occurs.
  - showText
```
public void showText(String text)
              throws IOException
```
    Shows the given text at the location specified by the current text matrix.
    
    Parameters:
    text - The Unicode text to show.
    
    Throws:
    
    IOException - If an io exception occurs.
  - setLeading
```
public void setLeading(double leading)
                throws IOException
```
    Sets the text leading.
    
    Parameters:
    leading - The leading in unscaled text units.
    
    Throws:
    
    IOException - If there is an error writing to the stream.
  - newLine
```
public void newLine()
             throws IOException
```
    Move to the start of the next line of text. Requires the leading (see setLeading(double)) to have been set.
    
    Throws:
    
    IOException - If there is an error writing to the stream.
  - moveTextPositionByAmount
```
@Deprecated
public void moveTextPositionByAmount(float tx,
                                       float ty)
                              throws IOException
```
    Deprecated. Use newLineAtOffset(float, float) instead.
    
    The Td operator. A current text matrix will be replaced with a new one (1 0 0 1 x y).
    
    Parameters:
    tx - The x translation.
    ty - The y translation.
    
    Throws:
    
    IOException - If there is an error writing to the stream.
  - newLineAtOffset
```
public void newLineAtOffset(float tx,
                   float ty)
                     throws IOException
```
    The Td operator. Move to the start of the next line, offset from the start of the current line by (tx, ty).
    
    Parameters:
    tx - The x translation.
    ty - The y translation.
    
    Throws:
    
    IOException - If there is an error writing to the stream.
    
    IllegalStateException - If the method was not allowed to be called at this time.
  - setTextMatrix
```
@Deprecated
public void setTextMatrix(double a,
                            double b,
                            double c,
                            double d,
                            double e,
                            double f)
                   throws IOException
```
    Deprecated. Use setTextMatrix(Matrix) instead.
    
    The Tm operator. Sets the text matrix to the given values. A current text matrix will be replaced with the new one.
    
    Parameters:
    a - The a value of the matrix.
    b - The b value of the matrix.
    c - The c value of the matrix.
    d - The d value of the matrix.
    e - The e value of the matrix.
    f - The f value of the matrix.
    
    Throws:
    
    IOException - If there is an error writing to the stream.
  - setTextMatrix
```
@Deprecated
public void setTextMatrix(AffineTransform matrix)
                   throws IOException
```
    Deprecated. Use setTextMatrix(Matrix) instead.
    
    The Tm operator. Sets the text matrix to the given values. A current text matrix will be replaced with the new one.
    
    Parameters:
    matrix - the transformation matrix
    
    Throws:
    
    IOException - If there is an error writing to the stream.
  - setTextMatrix
```
public void setTextMatrix(Matrix matrix)
                   throws IOException
```
    The Tm operator. Sets the text matrix to the given values. A current text matrix will be replaced with the new one.
    
    Parameters:
    matrix - the transformation matrix
    
    Throws:
    
    IOException - If there is an error writing to the stream.
    
    IllegalStateException - If the method was not allowed to be called at this time.
  - setTextScaling
```
@Deprecated
public void setTextScaling(double sx,
                             double sy,
                             double tx,
                             double ty)
                    throws IOException
```
    Deprecated. Use setTextMatrix(Matrix) instead.
    
    The Tm operator. Sets the text matrix to the given scaling and translation values. A current text matrix will be replaced with the new one.
    
    Parameters:
    sx - The scaling factor in x-direction.
    sy - The scaling factor in y-direction.
    tx - The translation value in x-direction.
    ty - The translation value in y-direction.
    
    Throws:
    
    IOException - If there is an error writing to the stream.
  - setTextTranslation
```
@Deprecated
public void setTextTranslation(double tx,
                                 double ty)
                        throws IOException
```
    Deprecated. Use setTextMatrix(Matrix) instead.
    
    The Tm operator. Sets the text matrix to the given translation values. A current text matrix will be replaced with the new one.
    
    Parameters:
    tx - The translation value in x-direction.
    ty - The translation value in y-direction.
    
    Throws:
    
    IOException - If there is an error writing to the stream.
  - setTextRotation
```
@Deprecated
public void setTextRotation(double angle,
                              double tx,
                              double ty)
                     throws IOException
```
    Deprecated. Use setTextMatrix(Matrix) instead.
    
    The Tm operator. Sets the text matrix to the given rotation and translation values. A current text matrix will be replaced with the new one.
    
    Parameters:
    angle - The angle used for the counterclockwise rotation in radians.
    tx - The translation value in x-direction.
    ty - The translation value in y-direction.
    
    Throws:
    
    IOException - If there is an error writing to the stream.
  - drawImage
```
public void drawImage(PDImageXObject image,
             float x,
             float y)
               throws IOException
```
    Draw an image at the x,y coordinates, with the default size of the image.
    
    Parameters:
    image - The image to draw.
    x - The x-coordinate to draw the image.
    y - The y-coordinate to draw the image.
    
    Throws:
    
    IOException - If there is an error writing to the stream.
  - drawImage
```
public void drawImage(PDImageXObject image,
             float x,
             float y,
             float width,
             float height)
               throws IOException
```
    Draw an image at the x,y coordinates, with the given size.
    
    Parameters:
    image - The image to draw.
    x - The x-coordinate to draw the image.
    y - The y-coordinate to draw the image.
    width - The width to draw the image.
    height - The height to draw the image.
    
    Throws:
    
    IOException - If there is an error writing to the stream.
    
    IllegalStateException - If the method was called within a text block.
  - drawImage
```
public void drawImage(PDImageXObject image,
             Matrix matrix)
               throws IOException
```
    Draw an image at the origin with the given transformation matrix.
    
    Parameters:
    image - The image to draw.
    matrix - The transformation matrix to apply to the image.
    
    Throws:
    
    IOException - If there is an error writing to the stream.
    
    IllegalStateException - If the method was called within a text block.
  - drawInlineImage
```
@Deprecated
public void drawInlineImage(PDInlineImage inlineImage,
                              float x,
                              float y)
                     throws IOException
```
    Deprecated. Use drawImage(PDInlineImage, float, float) instead.
    
    Draw an inline image at the x,y coordinates, with the default size of the image.
    
    Parameters:
    inlineImage - The inline image to draw.
    x - The x-coordinate to draw the inline image.
    y - The y-coordinate to draw the inline image.
    
    Throws:
    
    IOException - If there is an error writing to the stream.
  - drawImage
```
public void drawImage(PDInlineImage inlineImage,
             float x,
             float y)
               throws IOException
```
    Draw an inline image at the x,y coordinates, with the default size of the image.
    
    Parameters:
    inlineImage - The inline image to draw.
    x - The x-coordinate to draw the inline image.
    y - The y-coordinate to draw the inline image.
    
    Throws:
    
    IOException - If there is an error writing to the stream.
  - drawInlineImage
```
@Deprecated
public void drawInlineImage(PDInlineImage inlineImage,
                              float x,
                              float y,
                              float width,
                              float height)
                     throws IOException
```
    Deprecated. Use drawImage(PDInlineImage, float, float, float, float) instead.
    
    Draw an inline image at the x,y coordinates and a certain width and height.
    
    Parameters:
    inlineImage - The inline image to draw.
    x - The x-coordinate to draw the inline image.
    y - The y-coordinate to draw the inline image.
    width - The width of the inline image to draw.
    height - The height of the inline image to draw.
    
    Throws:
    
    IOException - If there is an error writing to the stream.
  - drawImage
```
public void drawImage(PDInlineImage inlineImage,
             float x,
             float y,
             float width,
             float height)
               throws IOException
```
    Draw an inline image at the x,y coordinates and a certain width and height.
    
    Parameters:
    inlineImage - The inline image to draw.
    x - The x-coordinate to draw the inline image.
    y - The y-coordinate to draw the inline image.
    width - The width of the inline image to draw.
    height - The height of the inline image to draw.
    
    Throws:
    
    IOException - If there is an error writing to the stream.
    
    IllegalStateException - If the method was called within a text block.
  - drawXObject
```
@Deprecated
public void drawXObject(PDXObject xobject,
                          float x,
                          float y,
                          float width,
                          float height)
                 throws IOException
```
    Deprecated. Use drawImage(org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject, float, float) instead.
    
    Draw an xobject(form or image) at the x,y coordinates and a certain width and height.
    
    Parameters:
    xobject - The xobject to draw.
    x - The x-coordinate to draw the image.
    y - The y-coordinate to draw the image.
    width - The width of the image to draw.
    height - The height of the image to draw.
    
    Throws:
    
    IOException - If there is an error writing to the stream.
  - drawXObject
```
@Deprecated
public void drawXObject(PDXObject xobject,
                          AffineTransform transform)
                 throws IOException
```
    Deprecated. Use drawImage(PDImageXObject, Matrix) or drawForm(PDFormXObject) with transform(Matrix) instead.
    
    Draw an xobject(form or image) using the given AffineTransform to position the xobject.
    
    Parameters:
    xobject - The xobject to draw.
    transform - the transformation matrix
    
    Throws:
    
    IOException - If there is an error writing to the stream.
    
    IllegalStateException - If the method was called within a text block.
  - drawForm
```
public void drawForm(PDFormXObject form)
              throws IOException
```
    Draws the given Form XObject at the current location.
    
    Parameters:
    form - Form XObject
    
    Throws:
    
    IOException - if the content stream could not be written
    
    IllegalStateException - If the method was called within a text block.
  - concatenate2CTM
```
@Deprecated
public void concatenate2CTM(double a,
                              double b,
                              double c,
                              double d,
                              double e,
                              double f)
                     throws IOException
```
    Deprecated. Use transform(org.apache.pdfbox.util.Matrix) instead.
    
    The cm operator. Concatenates the current transformation matrix with the given values.
    
    Parameters:
    a - The a value of the matrix.
    b - The b value of the matrix.
    c - The c value of the matrix.
    d - The d value of the matrix.
    e - The e value of the matrix.
    f - The f value of the matrix.
    
    Throws:
    
    IOException - If there is an error writing to the stream.
  - concatenate2CTM
```
@Deprecated
public void concatenate2CTM(AffineTransform at)
                     throws IOException
```
    Deprecated. Use transform(org.apache.pdfbox.util.Matrix) instead.
    
    The cm operator. Concatenates the current transformation matrix with the given AffineTransform.
    
    Parameters:
    at - the transformation matrix
    
    Throws:
    
    IOException - If there is an error writing to the stream.
  - transform
```
public void transform(Matrix matrix)
               throws IOException
```
    The cm operator. Concatenates the given matrix with the CTM.
    
    Parameters:
    matrix - the transformation matrix
    
    Throws:
    
    IOException - If there is an error writing to the stream.
  - saveGraphicsState
```
public void saveGraphicsState()
                       throws IOException
```
    q operator. Saves the current graphics state.
    
    Throws:
    
    IOException - If an error occurs while writing to the stream.
  - restoreGraphicsState
```
public void restoreGraphicsState()
                          throws IOException
```
    Q operator. Restores the current graphics state.
    
    Throws:
    
    IOException - If an error occurs while writing to the stream.
  - setStrokingColorSpace
```
@Deprecated
public void setStrokingColorSpace(PDColorSpace colorSpace)
                           throws IOException
```
    Deprecated. Use setStrokingColor(org.apache.pdfbox.pdmodel.graphics.color.PDColor) instead.
    
    Set the stroking color space. This will add the colorspace to the PDResources if necessary.
    
    Parameters:
    colorSpace - The colorspace to write.
    
    Throws:
    
    IOException - If there is an error writing the colorspace.
  - setNonStrokingColorSpace
```
@Deprecated
public void setNonStrokingColorSpace(PDColorSpace colorSpace)
                              throws IOException
```
    Deprecated. Use setNonStrokingColor(org.apache.pdfbox.pdmodel.graphics.color.PDColor) instead.
    
    Set the stroking color space. This will add the colorspace to the PDResources if necessary.
    
    Parameters:
    colorSpace - The colorspace to write.
    
    Throws:
    
    IOException - If there is an error writing the colorspace.
  - setStrokingColor
```
public void setStrokingColor(PDColor color)
                      throws IOException
```
    Sets the stroking color and, if necessary, the stroking color space.
    
    Parameters:
    color - Color in a specific color space.
    
    Throws:
    
    IOException - If an IO error occurs while writing to the stream.
  - setStrokingColor
```
public void setStrokingColor(Color color)
                      throws IOException
```
    Set the stroking color using an AWT color. Conversion uses the default sRGB color space.
    
    Parameters:
    color - The color to set.
    
    Throws:
    
    IOException - If an IO error occurs while writing to the stream.
  - setStrokingColor
```
@Deprecated
public void setStrokingColor(float[] components)
                      throws IOException
```
    Deprecated. Use setStrokingColor(PDColor) instead.
    
    Set the color components of current stroking color space.
    
    Parameters:
    components - The components to set for the current color.
    
    Throws:
    
    IOException - If there is an error while writing to the stream.
  - setStrokingColor
```
public void setStrokingColor(int r,
                    int g,
                    int b)
                      throws IOException
```
    Set the stroking color in the DeviceRGB color space. Range is 0..255.
    
    Parameters:
    r - The red value
    g - The green value.
    b - The blue value.
    
    Throws:
    
    IOException - If an IO error occurs while writing to the stream.
    
    IllegalArgumentException - If the parameters are invalid.
  - setStrokingColor
```
@Deprecated
public void setStrokingColor(int c,
                               int m,
                               int y,
                               int k)
                      throws IOException
```
    Deprecated. Use setStrokingColor(float, float, float, float) instead.
    
    Set the stroking color in the DeviceCMYK color space. Range is 0..255.
    
    Parameters:
    c - The cyan value.
    m - The magenta value.
    y - The yellow value.
    k - The black value.
    
    Throws:
    
    IOException - If an IO error occurs while writing to the stream.
    
    IllegalArgumentException - If the parameters are invalid.
  - setStrokingColor
```
public void setStrokingColor(float c,
                    float m,
                    float y,
                    float k)
                      throws IOException
```
    Set the stroking color in the DeviceCMYK color space. Range is 0..1
    
    Parameters:
    c - The cyan value.
    m - The magenta value.
    y - The yellow value.
    k - The black value.
    
    Throws:
    
    IOException - If an IO error occurs while writing to the stream.
    
    IllegalArgumentException - If the parameters are invalid.
  - setStrokingColor
```
@Deprecated
public void setStrokingColor(int g)
                      throws IOException
```
    Deprecated. Use setStrokingColor(double) instead.
    
    Set the stroking color in the DeviceGray color space. Range is 0..255.
    
    Parameters:
    g - The gray value.
    
    Throws:
    
    IOException - If an IO error occurs while writing to the stream.
    
    IllegalArgumentException - If the parameter is invalid.
  - setStrokingColor
```
public void setStrokingColor(double g)
                      throws IOException
```
    Set the stroking color in the DeviceGray color space. Range is 0..1.
    
    Parameters:
    g - The gray value.
    
    Throws:
    
    IOException - If an IO error occurs while writing to the stream.
    
    IllegalArgumentException - If the parameter is invalid.
  - setNonStrokingColor
```
public void setNonStrokingColor(PDColor color)
                         throws IOException
```
    Sets the non-stroking color and, if necessary, the non-stroking color space.
    
    Parameters:
    color - Color in a specific color space.
    
    Throws:
    
    IOException - If an IO error occurs while writing to the stream.
  - setNonStrokingColor
```
public void setNonStrokingColor(Color color)
                         throws IOException
```
    Set the non-stroking color using an AWT color. Conversion uses the default sRGB color space.
    
    Parameters:
    color - The color to set.
    
    Throws:
    
    IOException - If an IO error occurs while writing to the stream.
  - setNonStrokingColor
```
@Deprecated
public void setNonStrokingColor(float[] components)
                         throws IOException
```
    Deprecated. Use setNonStrokingColor(PDColor) instead.
    
    Set the color components of current non-stroking color space.
    
    Parameters:
    components - The components to set for the current color.
    
    Throws:
    
    IOException - If there is an error while writing to the stream.
  - setNonStrokingColor
```
public void setNonStrokingColor(int r,
                       int g,
                       int b)
                         throws IOException
```
    Set the non-stroking color in the DeviceRGB color space. Range is 0..255.
    
    Parameters:
    r - The red value.
    g - The green value.
    b - The blue value.
    
    Throws:
    
    IOException - If an IO error occurs while writing to the stream.
    
    IllegalArgumentException - If the parameters are invalid.
  - setNonStrokingColor
```
public void setNonStrokingColor(int c,
                       int m,
                       int y,
                       int k)
                         throws IOException
```
    Set the non-stroking color in the DeviceCMYK color space. Range is 0..255.
    
    Parameters:
    c - The cyan value.
    m - The magenta value.
    y - The yellow value.
    k - The black value.
    
    Throws:
    
    IOException - If an IO error occurs while writing to the stream.
    
    IllegalArgumentException - If the parameters are invalid.
  - setNonStrokingColor
```
public void setNonStrokingColor(double c,
                       double m,
                       double y,
                       double k)
                         throws IOException
```
    Set the non-stroking color in the DeviceRGB color space. Range is 0..1.
    
    Parameters:
    c - The cyan value.
    m - The magenta value.
    y - The yellow value.
    k - The black value.
    
    Throws:
    
    IOException - If an IO error occurs while writing to the stream.
  - setNonStrokingColor
```
public void setNonStrokingColor(int g)
                         throws IOException
```
    Set the non-stroking color in the DeviceGray color space. Range is 0..255.
    
    Parameters:
    g - The gray value.
    
    Throws:
    
    IOException - If an IO error occurs while writing to the stream.
    
    IllegalArgumentException - If the parameter is invalid.
  - setNonStrokingColor
```
public void setNonStrokingColor(double g)
                         throws IOException
```
    Set the non-stroking color in the DeviceGray color space. Range is 0..1.
    
    Parameters:
    g - The gray value.
    
    Throws:
    
    IOException - If an IO error occurs while writing to the stream.
    
    IllegalArgumentException - If the parameter is invalid.
  - addRect
```
public void addRect(float x,
           float y,
           float width,
           float height)
             throws IOException
```
    Add a rectangle to the current path.
    
    Parameters:
    x - The lower left x coordinate.
    y - The lower left y coordinate.
    width - The width of the rectangle.
    height - The height of the rectangle.
    
    Throws:
    
    IOException - If the content stream could not be written.
    
    IllegalStateException - If the method was called within a text block.
  - fillRect
```
@Deprecated
public void fillRect(float x,
                       float y,
                       float width,
                       float height)
              throws IOException
```
    Deprecated. Use addRect(float, float, float, float) followed by fill() instead.
    
    Fill a rectangle on the page using the current non stroking color.
    
    Parameters:
    x - The lower left x coordinate.
    y - The lower left y coordinate.
    width - The width of the rectangle.
    height - The height of the rectangle.
    
    Throws:
    
    IOException - If there is an error while drawing on the screen.
    
    IllegalStateException - If the method was called within a text block.
  - addBezier312
```
@Deprecated
public void addBezier312(float x1,
                           float y1,
                           float x2,
                           float y2,
                           float x3,
                           float y3)
                  throws IOException
```
    Deprecated. Use curveTo(float, float, float, float, float, float) instead.
    
    Append a cubic Bézier curve to the current path. The curve extends from the current point to the point (x3 , y3 ), using (x1 , y1 ) and (x2 , y2 ) as the Bézier control points
    
    Parameters:
    x1 - x coordinate of the point 1
    y1 - y coordinate of the point 1
    x2 - x coordinate of the point 2
    y2 - y coordinate of the point 2
    x3 - x coordinate of the point 3
    y3 - y coordinate of the point 3
    
    Throws:
    
    IOException - If there is an error while adding the .
  - curveTo
```
public void curveTo(float x1,
           float y1,
           float x2,
           float y2,
           float x3,
           float y3)
             throws IOException
```
    Append a cubic Bézier curve to the current path. The curve extends from the current point to the point (x3, y3), using (x1, y1) and (x2, y2) as the Bézier control points.
    
    Parameters:
    x1 - x coordinate of the point 1
    y1 - y coordinate of the point 1
    x2 - x coordinate of the point 2
    y2 - y coordinate of the point 2
    x3 - x coordinate of the point 3
    y3 - y coordinate of the point 3
    
    Throws:
    
    IOException - If the content stream could not be written.
    
    IllegalStateException - If the method was called within a text block.
  - addBezier32
```
@Deprecated
public void addBezier32(float x2,
                          float y2,
                          float x3,
                          float y3)
                 throws IOException
```
    Deprecated. Use curveTo2(float, float, float, float) instead.
    
    Append a cubic Bézier curve to the current path. The curve extends from the current point to the point (x3 , y3 ), using the current point and (x2 , y2 ) as the Bézier control points/
    
    Parameters:
    x2 - x coordinate of the point 2
    y2 - y coordinate of the point 2
    x3 - x coordinate of the point 3
    y3 - y coordinate of the point 3
    
    Throws:
    
    IOException - If there is an error while adding the .
  - curveTo2
```
public void curveTo2(float x2,
            float y2,
            float x3,
            float y3)
              throws IOException
```
    Append a cubic Bézier curve to the current path. The curve extends from the current point to the point (x3, y3), using the current point and (x2, y2) as the Bézier control points.
    
    Parameters:
    x2 - x coordinate of the point 2
    y2 - y coordinate of the point 2
    x3 - x coordinate of the point 3
    y3 - y coordinate of the point 3
    
    Throws:
    
    IllegalStateException - If the method was called within a text block.
    
    IOException - If the content stream could not be written.
  - addBezier31
```
@Deprecated
public void addBezier31(float x1,
                          float y1,
                          float x3,
                          float y3)
                 throws IOException
```
    Deprecated. Use curveTo1(float, float, float, float) instead.
    
    Append a cubic Bézier curve to the current path. The curve extends from the current point to the point (x3 , y3 ), using (x1 , y1 ) and (x3 , y3 ) as the Bézier control points/
    
    Parameters:
    x1 - x coordinate of the point 1
    y1 - y coordinate of the point 1
    x3 - x coordinate of the point 3
    y3 - y coordinate of the point 3
    
    Throws:
    
    IOException - If there is an error while adding the .
  - curveTo1
```
public void curveTo1(float x1,
            float y1,
            float x3,
            float y3)
              throws IOException
```
    Append a cubic Bézier curve to the current path. The curve extends from the current point to the point (x3, y3), using (x1, y1) and (x3, y3) as the Bézier control points.
    
    Parameters:
    x1 - x coordinate of the point 1
    y1 - y coordinate of the point 1
    x3 - x coordinate of the point 3
    y3 - y coordinate of the point 3
    
    Throws:
    
    IOException - If the content stream could not be written.
    
    IllegalStateException - If the method was called within a text block.
  - moveTo
```
public void moveTo(float x,
          float y)
            throws IOException
```
    Move the current position to the given coordinates.
    
    Parameters:
    x - The x coordinate.
    y - The y coordinate.
    
    Throws:
    
    IOException - If the content stream could not be written.
    
    IllegalStateException - If the method was called within a text block.
  - lineTo
```
public void lineTo(float x,
          float y)
            throws IOException
```
    Draw a line from the current position to the given coordinates.
    
    Parameters:
    x - The x coordinate.
    y - The y coordinate.
    
    Throws:
    
    IOException - If the content stream could not be written.
    
    IllegalStateException - If the method was called within a text block.
  - addLine
```
@Deprecated
public void addLine(float xStart,
                      float yStart,
                      float xEnd,
                      float yEnd)
             throws IOException
```
    Deprecated. Use moveto(xStart,yStart) followed by lineTo(xEnd,yEnd).
    
    add a line to the current path.
    
    Parameters:
    xStart - The start x coordinate.
    yStart - The start y coordinate.
    xEnd - The end x coordinate.
    yEnd - The end y coordinate.
    
    Throws:
    
    IOException - If there is an error while adding the line.
    
    IllegalStateException - If the method was called within a text block.
  - drawLine
```
@Deprecated
public void drawLine(float xStart,
                       float yStart,
                       float xEnd,
                       float yEnd)
              throws IOException
```
    Deprecated. Use moveto(xStart,yStart) followed by lineTo(xEnd,yEnd) followed by stroke().
    
    Draw a line on the page using the current stroking color and the current line width.
    
    Parameters:
    xStart - The start x coordinate.
    yStart - The start y coordinate.
    xEnd - The end x coordinate.
    yEnd - The end y coordinate.
    
    Throws:
    
    IOException - If there is an error while drawing on the screen.
    
    IllegalStateException - If the method was called within a text block.
  - addPolygon
```
@Deprecated
public void addPolygon(float[] x,
                         float[] y)
                throws IOException
```
    Deprecated. Use moveTo(float, float) and lineTo(float, float) methods instead.
    
    Add a polygon to the current path.
    
    Parameters:
    x - x coordinate of each points
    y - y coordinate of each points
    
    Throws:
    
    IOException - If there is an error while drawing on the screen.
    
    IllegalStateException - If the method was called within a text block.
    
    IllegalArgumentException - If the two arrays have different lengths.
  - drawPolygon
```
@Deprecated
public void drawPolygon(float[] x,
                          float[] y)
                 throws IOException
```
    Deprecated. Use moveTo(float, float) and lineTo(float, float) methods instead.
    
    Draw a polygon on the page using the current stroking color.
    
    Parameters:
    x - x coordinate of each points
    y - y coordinate of each points
    
    Throws:
    
    IOException - If there is an error while drawing on the screen.
    
    IllegalStateException - If the method was called within a text block.
  - fillPolygon
```
@Deprecated
public void fillPolygon(float[] x,
                          float[] y)
                 throws IOException
```
    Deprecated. Use moveTo(float, float) and lineTo(float, float) methods instead.
    
    Draw and fill a polygon on the page using the current stroking / non stroking colors.
    
    Parameters:
    x - x coordinate of each points
    y - y coordinate of each points
    
    Throws:
    
    IOException - If there is an error while drawing on the screen.
    
    IllegalStateException - If the method was called within a text block.
  - stroke
```
public void stroke()
            throws IOException
```
    Stroke the path.
    
    Throws:
    
    IOException - If the content stream could not be written
    
    IllegalStateException - If the method was called within a text block.
  - closeAndStroke
```
public void closeAndStroke()
                    throws IOException
```
    Close and stroke the path.
    
    Throws:
    
    IOException - If the content stream could not be written
    
    IllegalStateException - If the method was called within a text block.
  - fill
```
@Deprecated
public void fill(int windingRule)
          throws IOException
```
    Deprecated. Use fill() or fillEvenOdd() instead.
    
    Fill the path.
    
    Parameters:
    windingRule - the winding rule to be used for filling
    
    Throws:
    
    IOException - If the content stream could not be written
    
    IllegalArgumentException - If the parameter is not a valid winding rule.
  - fill
```
public void fill()
          throws IOException
```
    Fills the path using the nonzero winding number rule.
    
    Throws:
    
    IOException - If the content stream could not be written
    
    IllegalStateException - If the method was called within a text block.
  - fillEvenOdd
```
public void fillEvenOdd()
                 throws IOException
```
    Fills the path using the even-odd winding rule.
    
    Throws:
    
    IOException - If the content stream could not be written
    
    IllegalStateException - If the method was called within a text block.
  - fillAndStroke
```
public void fillAndStroke()
                   throws IOException
```
    Fill and then stroke the path, using the nonzero winding number rule to determine the region to fill. This shall produce the same result as constructing two identical path objects, painting the first with fill() and the second with stroke().
    
    Throws:
    
    IOException - If the content stream could not be written
    
    IllegalStateException - If the method was called within a text block.
  - fillAndStrokeEvenOdd
```
public void fillAndStrokeEvenOdd()
                          throws IOException
```
    Fill and then stroke the path, using the even-odd rule to determine the region to fill. This shall produce the same result as constructing two identical path objects, painting the first with fillEvenOdd() and the second with stroke().
    
    Throws:
    
    IOException - If the content stream could not be written
    
    IllegalStateException - If the method was called within a text block.
  - closeAndFillAndStroke
```
public void closeAndFillAndStroke()
                           throws IOException
```
    Close, fill, and then stroke the path, using the nonzero winding number rule to determine the region to fill. This shall have the same effect as the sequence closePath() and then fillAndStroke().
    
    Throws:
    
    IOException - If the content stream could not be written
    
    IllegalStateException - If the method was called within a text block.
  - closeAndFillAndStrokeEvenOdd
```
public void closeAndFillAndStrokeEvenOdd()
                                  throws IOException
```
    Close, fill, and then stroke the path, using the even-odd rule to determine the region to fill. This shall have the same effect as the sequence closePath() and then fillAndStrokeEvenOdd().
    
    Throws:
    
    IOException - If the content stream could not be written
    
    IllegalStateException - If the method was called within a text block.
  - shadingFill
```
public void shadingFill(PDShading shading)
                 throws IOException
```
    Fills the clipping area with the given shading.
    
    Parameters:
    shading - Shading resource
    
    Throws:
    
    IOException - If the content stream could not be written
    
    IllegalStateException - If the method was called within a text block.
  - closeSubPath
```
@Deprecated
public void closeSubPath()
                  throws IOException
```
    Deprecated. Use closePath() instead.
    
    Closes the current subpath.
    
    Throws:
    
    IOException - If the content stream could not be written
  - closePath
```
public void closePath()
               throws IOException
```
    Closes the current subpath.
    
    Throws:
    
    IOException - If the content stream could not be written
    
    IllegalStateException - If the method was called within a text block.
  - clipPath
```
@Deprecated
public void clipPath(int windingRule)
              throws IOException
```
    Deprecated. Use clip() or clipEvenOdd() instead.
    
    Clip path.
    
    Parameters:
    windingRule - the winding rule to be used for clipping
    
    Throws:
    
    IOException - If there is an error while clipping the path.
    
    IllegalStateException - If the method was called within a text block.
  - clip
```
public void clip()
          throws IOException
```
    Intersects the current clipping path with the current path, using the nonzero rule.
    
    Throws:
    
    IOException - If the content stream could not be written
    
    IllegalStateException - If the method was called within a text block.
  - clipEvenOdd
```
public void clipEvenOdd()
                 throws IOException
```
    Intersects the current clipping path with the current path, using the even-odd rule.
    
    Throws:
    
    IOException - If the content stream could not be written
    
    IllegalStateException - If the method was called within a text block.
  - setLineWidth
```
public void setLineWidth(float lineWidth)
                  throws IOException
```
    Set line width to the given value.
    
    Parameters:
    lineWidth - The width which is used for drwaing.
    
    Throws:
    
    IOException - If the content stream could not be written
    
    IllegalStateException - If the method was called within a text block.
  - setLineJoinStyle
```
public void setLineJoinStyle(int lineJoinStyle)
                      throws IOException
```
    Set the line join style.
    
    Parameters:
    lineJoinStyle - 0 for miter join, 1 for round join, and 2 for bevel join.
    
    Throws:
    
    IOException - If the content stream could not be written.
    
    IllegalStateException - If the method was called within a text block.
    
    IllegalArgumentException - If the parameter is not a valid line join style.
  - setLineCapStyle
```
public void setLineCapStyle(int lineCapStyle)
                     throws IOException
```
    Set the line cap style.
    
    Parameters:
    lineCapStyle - 0 for butt cap, 1 for round cap, and 2 for projecting square cap.
    
    Throws:
    
    IOException - If the content stream could not be written.
    
    IllegalStateException - If the method was called within a text block.
    
    IllegalArgumentException - If the parameter is not a valid line cap style.
  - setLineDashPattern
```
public void setLineDashPattern(float[] pattern,
                      float phase)
                        throws IOException
```
    Set the line dash pattern.
    
    Parameters:
    pattern - The pattern array
    phase - The phase of the pattern
    
    Throws:
    
    IOException - If the content stream could not be written.
    
    IllegalStateException - If the method was called within a text block.
  - setMiterLimit
```
public void setMiterLimit(float miterLimit)
                   throws IOException
```
    Set the miter limit.
    
    Parameters:
    miterLimit - the new miter limit.
    
    Throws:
    
    IOException - If the content stream could not be written.
  - beginMarkedContentSequence
```
@Deprecated
public void beginMarkedContentSequence(COSName tag)
                                throws IOException
```
    Deprecated. Use beginMarkedContent(org.apache.pdfbox.cos.COSName) instead.
    
    Begin a marked content sequence.
    
    Parameters:
    tag - the tag
    
    Throws:
    
    IOException - if an I/O error occurs
  - beginMarkedContent
```
public void beginMarkedContent(COSName tag)
                        throws IOException
```
    Begin a marked content sequence.
    
    Parameters:
    tag - the tag
    
    Throws:
    
    IOException - If the content stream could not be written
  - beginMarkedContentSequence
```
@Deprecated
public void beginMarkedContentSequence(COSName tag,
                                         COSName propsName)
                                throws IOException
```
    Deprecated. Use beginMarkedContent(COSName, PDPropertyList) instead.
    
    Begin a marked content sequence with a reference to an entry in the page resources' Properties dictionary.
    
    Parameters:
    tag - the tag
    propsName - the properties reference
    
    Throws:
    
    IOException - if an I/O error occurs
  - beginMarkedContent
```
public void beginMarkedContent(COSName tag,
                      PDPropertyList propertyList)
                        throws IOException
```
    Begin a marked content sequence with a reference to an entry in the page resources' Properties dictionary.
    
    Parameters:
    tag - the tag
    propertyList - property list
    
    Throws:
    
    IOException - If the content stream could not be written
  - endMarkedContentSequence
```
@Deprecated
public void endMarkedContentSequence()
                              throws IOException
```
    Deprecated. Use endMarkedContent() instead.
    
    End a marked content sequence.
    
    Throws:
    
    IOException - If the content stream could not be written
  - endMarkedContent
```
public void endMarkedContent()
                      throws IOException
```
    End a marked content sequence.
    
    Throws:
    
    IOException - If the content stream could not be written
  - appendRawCommands
```
@Deprecated
public void appendRawCommands(String commands)
                       throws IOException
```
    Deprecated. This method will be removed in a future release.
    
    This will append raw commands to the content stream.
    
    Parameters:
    commands - The commands to append to the stream.
    
    Throws:
    
    IOException - If an error occurs while writing to the stream.
  - appendRawCommands
```
@Deprecated
public void appendRawCommands(byte[] commands)
                       throws IOException
```
    Deprecated. This method will be removed in a future release.
    
    This will append raw commands to the content stream.
    
    Parameters:
    commands - The commands to append to the stream.
    
    Throws:
    
    IOException - If an error occurs while writing to the stream.
  - appendRawCommands
```
@Deprecated
public void appendRawCommands(int data)
                       throws IOException
```
    Deprecated. This method will be removed in a future release.
    
    This will append raw commands to the content stream.
    
    Parameters:
    data - Append a raw byte to the stream.
    
    Throws:
    
    IOException - If an error occurs while writing to the stream.
  - appendRawCommands
```
@Deprecated
public void appendRawCommands(double data)
                       throws IOException
```
    Deprecated. This method will be removed in a future release.
    
    This will append raw commands to the content stream.
    
    Parameters:
    data - Append a formatted double value to the stream.
    
    Throws:
    
    IOException - If an error occurs while writing to the stream.
  - appendRawCommands
```
@Deprecated
public void appendRawCommands(float data)
                       throws IOException
```
    Deprecated. This method will be removed in a future release.
    
    This will append raw commands to the content stream.
    
    Parameters:
    data - Append a formatted float value to the stream.
    
    Throws:
    
    IOException - If an error occurs while writing to the stream.
  - appendCOSName
```
@Deprecated
public void appendCOSName(COSName name)
                   throws IOException
```
    Deprecated. This method will be removed in a future release.
    
    This will append a COSName to the content stream.
    
    Parameters:
    name - the name
    
    Throws:
    
    IOException - If an error occurs while writing to the stream.
  - setGraphicsStateParameters
```
public void setGraphicsStateParameters(PDExtendedGraphicsState state)
                                throws IOException
```
    Set an extended graphics state.
    
    Parameters:
    state - The extended graphics state.
    
    Throws:
    
    IOException - If the content stream could not be written.
  - addComment
```
public void addComment(String comment)
                throws IOException
```
    Write a comment line.
    
    Parameters:
    comment -
    
    Throws:
    
    IOException - If the content stream could not be written.
    
    IllegalArgumentException - If the comment contains a newline. This is not allowed, because the next line could be ordinary PDF content.
  - writeOperand
```
protected void writeOperand(float real)
                     throws IOException
```
    Writes a real number to the content stream.
    
    Throws:
    
    IOException
  - close
```
public void close()
           throws IOException
```
    Close the content stream. This must be called when you are done with this object.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    IOException - If the underlying stream has a problem being written to.
  - setRenderingMode
```
public void setRenderingMode(RenderingMode rm)
                      throws IOException
```
    Set the text rendering mode. This determines whether showing text shall cause glyph outlines to be stroked, filled, used as a clipping boundary, or some combination of the three.
    
    Parameters:
    rm - The text rendering mode.
    
    Throws:
    
    IOException - If the content stream could not be written.
  - setCharacterSpacing
```
public void setCharacterSpacing(float spacing)
                         throws IOException
```
    Set the character spacing. The value shall be added to the horizontal or vertical component of the glyph's displacement, depending on the writing mode.
    
    Parameters:
    spacing - character spacing
    
    Throws:
    
    IOException - If the content stream could not be written.
  - setWordSpacing
```
public void setWordSpacing(float spacing)
                    throws IOException
```
    Set the word spacing. The value shall be added to the horizontal or vertical component of the ASCII SPACE character, depending on the writing mode.
    
    Parameters:
    spacing - word spacing
    
    Throws:
    
    IOException - If the content stream could not be written.
  - setHorizontalScaling
```
public void setHorizontalScaling(float scale)
                          throws IOException
```
    Set the horizontal scaling to scale / 100.
    
    Parameters:
    scale - number specifying the percentage of the normal width. Default value: 100 (normal width).
    
    Throws:
    
    IOException - If the content stream could not be written.

Class PDPageContentStream

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PDPageContentStream

PDPageContentStream

PDPageContentStream

PDPageContentStream

PDPageContentStream

PDPageContentStream

PDPageContentStream

Method Detail

beginText

endText

setFont

drawString

showText

setLeading

newLine

moveTextPositionByAmount

newLineAtOffset

setTextMatrix

setTextMatrix

setTextMatrix

setTextScaling

setTextTranslation

setTextRotation

drawImage

drawImage

drawImage

drawInlineImage

drawImage

drawInlineImage

drawImage

drawXObject

drawXObject

drawForm

concatenate2CTM

concatenate2CTM

transform

saveGraphicsState

restoreGraphicsState

setStrokingColorSpace

setNonStrokingColorSpace

setStrokingColor

setStrokingColor

setStrokingColor

setStrokingColor

setStrokingColor

setStrokingColor

setStrokingColor

setStrokingColor

setNonStrokingColor

setNonStrokingColor

setNonStrokingColor

setNonStrokingColor

setNonStrokingColor

setNonStrokingColor

setNonStrokingColor

setNonStrokingColor

addRect

fillRect

addBezier312

curveTo

addBezier32

curveTo2

addBezier31

curveTo1

moveTo

lineTo

addLine

drawLine

addPolygon

drawPolygon

fillPolygon

stroke

closeAndStroke

fill