Package com.tom_roush.pdfbox.pdmodel

Class PDAppearanceContentStream

  • All Implemented Interfaces:
    Closeable, AutoCloseable
    public final class PDAppearanceContentStream
extends Object
implements Closeable
    Provides the ability to write to an appearance content stream.

    • Field Detail

      • inTextMode

        protected boolean inTextMode

      • nonStrokingColorSpaceStack

        protected final Deque<PDColorSpace> nonStrokingColorSpaceStack

      • strokingColorSpaceStack

        protected final Deque<PDColorSpace> strokingColorSpaceStack

    • Constructor Detail

      • PDAppearanceContentStream

        public PDAppearanceContentStream​(PDAppearanceStream appearance)
                          throws IOException
        Create a new appearance stream.
        Parameters:
        appearance - The appearance stream to write to.
        Throws:
        IOException - If there is an error writing to the content stream.

      • PDAppearanceContentStream

        public PDAppearanceContentStream​(PDAppearanceStream appearance,
                                 boolean compress)
                          throws IOException
        Create a new appearance stream.
        Parameters:
        appearance - The appearance stream to write to.
        compress - whether the content stream is to be compressed. Set this to true when creating long content streams.
        Throws:
        IOException - If there is an error writing to the content stream.

      • PDAppearanceContentStream

        public PDAppearanceContentStream​(PDAppearanceStream appearance,
                                 OutputStream outputStream)
        Create a new appearance stream.
        Parameters:
        appearance - The appearance stream to add to.
        outputStream - The appearances output stream to write to.

    • Method Detail

      • setStrokingColorOnDemand

        public boolean setStrokingColorOnDemand​(PDColor color)
                                 throws IOException
        Set the stroking color.

        The command is only emitted if the color is not null and the number of components is > 0.

        Parameters:
        color - The colorspace to write.
        Throws:
        IOException - If there is an error writing to the content stream.
        See Also:
        PDAbstractContentStream.setStrokingColor(PDColor)

      • setStrokingColor

        public void setStrokingColor​(float[] components)
                      throws IOException
        Set the stroking color.
        Parameters:
        components - the color components dependent on the color space being used.
        Throws:
        IOException - If there is an error writing to the content stream.
        See Also:
        PDAbstractContentStream.setStrokingColor(com.tom_roush.harmony.awt.AWTColor)

      • setNonStrokingColorOnDemand

        public boolean setNonStrokingColorOnDemand​(PDColor color)
                                    throws IOException
        Set the non stroking color.

        The command is only emitted if the color is not null and the number of components is > 0.

        Parameters:
        color - The colorspace to write.
        Throws:
        IOException - If there is an error writing to the content stream.
        See Also:
        PDAbstractContentStream.setNonStrokingColor(PDColor)

      • setNonStrokingColor

        public void setNonStrokingColor​(float[] components)
                         throws IOException
        Set the non stroking color.
        Parameters:
        components - the color components dependent on the color space being used.
        Throws:
        IOException - If there is an error writing to the content stream.
        See Also:
        PDAbstractContentStream.setNonStrokingColor(com.tom_roush.harmony.awt.AWTColor)

      • setBorderLine

        public void setBorderLine​(float lineWidth,
                          PDBorderStyleDictionary bs,
                          COSArray border)
                   throws IOException
        Convenience method for annotations: sets the line with and dash style.
        Parameters:
        lineWidth - The line width.
        bs - The border style, may be null.
        border - The border array, must have at least three entries. This is only used if the border style is null.
        Throws:
        IOException - If there is an error writing to the content stream.

      • setLineWidthOnDemand

        public void setLineWidthOnDemand​(float lineWidth)
                          throws IOException
        Sets the line width. The command is only emitted if the lineWidth is different to 1.
        Parameters:
        lineWidth - the line width of the path.
        Throws:
        IOException - If there is an error writing to the content stream.
        See Also:
        PDAbstractContentStream.setLineWidth(float)

      • drawShape

        public void drawShape​(float lineWidth,
                      boolean hasStroke,
                      boolean hasFill)
               throws IOException
        Draw a shape.

        Dependent on the lineWidth and whether or not there is a background to be generated there are different commands to be used for draw a shape.

        Parameters:
        lineWidth - the line width of the path.
        hasStroke - shall there be a stroking color.
        hasFill - shall there be a fill color.
        Throws:
        IOException - If there is an error writing to the content stream.

      • setMaximumFractionDigits

        protected void setMaximumFractionDigits​(int fractionDigitsNumber)
        Sets the maximum number of digits allowed for fractional numbers.
        Parameters:
        fractionDigitsNumber -
        See Also:
        NumberFormat.setMaximumFractionDigits(int)

      • 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.

      • showTextWithPositioning

        public void showTextWithPositioning​(Object[] textWithPositioningArray)
                             throws IOException
        Shows the given text at the location specified by the current text matrix with the given interspersed positioning. This allows the user to efficiently position each glyph or sequence of glyphs.
        Parameters:
        textWithPositioningArray - An array consisting of String and Float types. Each String is output to the page using the current text matrix. Using the default coordinate system, each interspersed number adjusts the current text matrix by translating to the left or down for horizontal and vertical text respectively. The number is expressed in thousands of a text space unit, and may be negative.
        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.
        IllegalArgumentException - if a character isn't supported by the current font

      • showTextInternal

        protected void showTextInternal​(String text)
                         throws IOException
        Outputs a string using the correct encoding and subsetting as required.
        Parameters:
        text - The Unicode text to show.
        Throws:
        IOException - If an io exception occurs.

      • setLeading

        public void setLeading​(float 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(float)) to have been set.
        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

        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.

      • 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.

      • 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.

      • 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.

      • 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.

      • transform

        public void transform​(Matrix matrix)
               throws IOException
        The cm operator. Concatenates the given matrix with the current transformation matrix (CTM), which maps user space coordinates used within a PDF content stream into output device coordinates. More details on coordinates can be found in the PDF 32000 specification, 8.3.2 Coordinate Spaces.
        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.

      • 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​(AWTColor 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

        public void setStrokingColor​(float r,
                             float g,
                             float b)
                      throws IOException
        Set the stroking color in the DeviceRGB color space. Range is 0..1.
        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

        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

        public void setStrokingColor​(float 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​(AWTColor 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

        public void setNonStrokingColor​(float r,
                                float g,
                                float 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​(float c,
                                float m,
                                float y,
                                float k)
                         throws IOException
        Set the non-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.

      • setNonStrokingColor

        public void setNonStrokingColor​(int g)
                         throws IOException
        Deprecated.
        use setNonStrokingColor(g/255f)
        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​(float 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.

      • 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.

      • 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.

      • 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.

      • 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

        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.

      • 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.

      • 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 drawing.
        Throws:
        IOException - If the content stream could not be written

      • 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.
        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.
        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.

      • 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.
        IllegalArgumentException - If the parameter is ≤ 0.

      • 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

      • 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

      • endMarkedContent

        public void endMarkedContent()
                      throws IOException
        End a marked content sequence.
        Throws:
        IOException - If the content stream could not be written

      • 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​(int integer)
                     throws IOException
        Writes an integer number to the content stream.
        Parameters:
        integer -
        Throws:
        IOException

      • writeOperand

        protected void writeOperand​(COSName name)
                     throws IOException
        Writes a COSName to the content stream.
        Parameters:
        name -
        Throws:
        IOException

      • writeOperator

        protected void writeOperator​(String text)
                      throws IOException
        Writes a string to the content stream as ASCII.
        Parameters:
        text -
        Throws:
        IOException

      • write

        protected void write​(String text)
              throws IOException
        Writes a string to the content stream as ASCII.
        Parameters:
        text -
        Throws:
        IOException

      • write

        protected void write​(byte[] data)
              throws IOException
        Writes a byte[] to the content stream.
        Parameters:
        data -
        Throws:
        IOException

      • writeLine

        protected void writeLine()
                  throws IOException
        Writes a newline to the content stream as ASCII.
        Throws:
        IOException

      • writeBytes

        protected void writeBytes​(byte[] data)
                   throws IOException
        Writes binary data to the content stream.
        Parameters:
        data -
        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 AutoCloseable
        Specified by:
        close in interface Closeable
        Throws:
        IOException - If the underlying stream has a problem being written to.

      • isOutside255Interval

        protected boolean isOutside255Interval​(int val)

      • setStrokingColorSpaceStack

        protected void setStrokingColorSpaceStack​(PDColorSpace colorSpace)

      • setNonStrokingColorSpaceStack

        protected void setNonStrokingColorSpaceStack​(PDColorSpace colorSpace)

      • 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.

        This will have an effect only with Type1 and TrueType fonts, not with Type0 fonts. The PDF specification tells why: "Word spacing shall be applied to every occurrence of the single-byte character code 32 in a string when using a simple font or a composite font that defines code 32 as a single-byte code. It shall not apply to occurrences of the byte value 32 in multiple-byte codes."

        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.

      • 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.

      • setTextRise

        public void setTextRise​(float rise)
                 throws IOException
        Set the text rise value, i.e. move the baseline up or down. This is useful for drawing superscripts or subscripts.
        Parameters:
        rise - Specifies the distance, in unscaled text space units, to move the baseline up or down from its default location. 0 restores the default location.
        Throws:
        IOException