Module itextpdf
Package com.itextpdf.text.pdf

Class PdfChunk

  • public class PdfChunk
extends java.lang.Object
    A PdfChunk is the PDF translation of a Chunk.

    A PdfChunk is a PdfString in a certain PdfFont and Color.

    See Also:
    PdfString, Chunk, Font

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.util.HashMap attributes
      Metric attributes.
      protected BaseFont baseFont  
      protected boolean changeLeading
      Indicates if the height and offset of the Image has to be taken into account
      protected java.lang.String encoding
      The encoding.
      protected com.itextpdf.text.pdf.PdfFont font
      The font for this PdfChunk.
      protected Image image
      The image in this PdfChunk, if it has one
      protected boolean newlineSplit
      true if the chunk split was cause by a newline.
      protected java.util.HashMap noStroke
      Non metric attributes.
      protected float offsetX
      The offset in the x direction for the image
      protected float offsetY
      The offset in the y direction for the image
      protected SplitCharacter splitCharacter  
      protected java.lang.String value
      The value of this object.

    • Field Detail

      • value

        protected java.lang.String value
        The value of this object.

      • encoding

        protected java.lang.String encoding
        The encoding.

      • font

        protected com.itextpdf.text.pdf.PdfFont font
        The font for this PdfChunk.

      • attributes

        protected java.util.HashMap attributes
        Metric attributes.

        This attributes require the measurement of characters widths when rendering such as underline.

      • noStroke

        protected java.util.HashMap noStroke
        Non metric attributes.

        This attributes do not require the measurement of characters widths when rendering such as Color.

      • newlineSplit

        protected boolean newlineSplit
        true if the chunk split was cause by a newline.

      • image

        protected Image image
        The image in this PdfChunk, if it has one

      • offsetX

        protected float offsetX
        The offset in the x direction for the image

      • offsetY

        protected float offsetY
        The offset in the y direction for the image

      • changeLeading

        protected boolean changeLeading
        Indicates if the height and offset of the Image has to be taken into account

    • Method Detail

      • getUnicodeEquivalent

        public int getUnicodeEquivalent​(int c)
        Gets the Unicode equivalent to a CID. The (inexistent) CID is translated as '\n'. It has only meaning with CJK fonts with Identity encoding.
        Parameters:
        c - the CID code
        Returns:
        the Unicode equivalent

      • getWord

        protected int getWord​(java.lang.String text,
                      int start)

      • isNewlineSplit

        public boolean isNewlineSplit()
        Checks if the PdfChunk split was caused by a newline.
        Returns:
        true if the PdfChunk split was caused by a newline.

      • getWidthCorrected

        public float getWidthCorrected​(float charSpacing,
                               float wordSpacing)
        Gets the width of the PdfChunk taking into account the extra character and word spacing.
        Parameters:
        charSpacing - the extra character spacing
        wordSpacing - the extra word spacing
        Returns:
        the calculated width

      • getTextRise

        public float getTextRise()
        Gets the text displacement relative to the baseline.
        Returns:
        a displacement in points

      • trimLastSpace

        public float trimLastSpace()
        Trims the last space.
        Returns:
        the width of the space trimmed, otherwise 0

      • trimFirstSpace

        public float trimFirstSpace()

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        See Also:
        Object.toString()

      • changeLeading

        public boolean changeLeading()

      • noPrint

        public static boolean noPrint​(int c)