Package org.apache.pdfbox.pdmodel.font

Class PDCIDFontType2

java.lang.Object
org.apache.pdfbox.pdmodel.font.PDCIDFont
org.apache.pdfbox.pdmodel.font.PDCIDFontType2
All Implemented Interfaces:
COSObjectable, PDFontLike, PDVectorFont
public class PDCIDFontType2 extends PDCIDFont
Type 2 CIDFont (TrueType).
Author:
Ben Litchfield

  • Constructor Details

    • PDCIDFontType2

      public PDCIDFontType2(COSDictionary fontDictionary, PDType0Font parent) throws IOException
      Constructor.
      Parameters:
      fontDictionary - The font dictionary according to the PDF specification.
      parent - The parent font.
      Throws:
      IOException - if the font could not be read

    • PDCIDFontType2

      public PDCIDFontType2(COSDictionary fontDictionary, PDType0Font parent, org.apache.fontbox.ttf.TrueTypeFont trueTypeFont) throws IOException
      Constructor.
      Parameters:
      fontDictionary - The font dictionary according to the PDF specification.
      parent - The parent font.
      trueTypeFont - The true type font used to create the parent font
      Throws:
      IOException - if the font could not be read

  • Method Details

    • getFontMatrix

      public Matrix getFontMatrix()
      Description copied from interface: PDFontLike
      Returns the font matrix, which represents the transformation from glyph space to text space.
      Returns:
      the font matrix

    • getBoundingBox

      public org.apache.fontbox.util.BoundingBox getBoundingBox() throws IOException
      Description copied from interface: PDFontLike
      Returns the font's bounding box.
      Returns:
      the bounding box
      Throws:
      IOException - if the bounding box could not be read

    • codeToCID

      public int codeToCID(int code)
      Description copied from class: PDCIDFont
      Returns the CID for the given character code. If not found then CID 0 is returned.
      Specified by:
      codeToCID in class PDCIDFont
      Parameters:
      code - character code
      Returns:
      CID

    • codeToGID

      public int codeToGID(int code) throws IOException
      Returns the GID for the given character code.
      Specified by:
      codeToGID in class PDCIDFont
      Parameters:
      code - character code
      Returns:
      GID
      Throws:
      IOException - if the mapping could not be read

    • getHeight

      public float getHeight(int code) throws IOException
      Description copied from interface: PDFontLike
      Returns the height of the given character, in glyph space. This can be expensive to calculate. Results are only approximate.

      Warning: This method is deprecated in PDFBox 2.0 because there is no meaningful value which it can return. The PDFontLike.getWidth(int) method returns the advance width of a glyph, but there is no corresponding advance height. The logical height of a character is the same for every character in a font, so if you want that, retrieve the font bbox's height. Otherwise if you want the visual bounds of the glyph then call getPath(..) on the appropriate PDFont subclass to retrieve the glyph outline as a GeneralPath. See the cyan rectangles in the DrawPrintTextLocations.java example to see this in action.

      Parameters:
      code - character code
      Returns:
      the height of the given character
      Throws:
      IOException - if the height could not be read

    • getWidthFromFont

      public float getWidthFromFont(int code) throws IOException
      Description copied from interface: PDFontLike
      Returns the width of a glyph in the embedded font file.
      Parameters:
      code - character code
      Returns:
      width in glyph space
      Throws:
      IOException - if the font could not be read

    • encode

      public byte[] encode(int unicode)
      Description copied from class: PDCIDFont
      Encodes the given Unicode code point for use in a PDF content stream. Content streams use a multi-byte encoding with 1 to 4 bytes.

      This method is called when embedding text in PDFs and when filling in fields.

      Specified by:
      encode in class PDCIDFont
      Parameters:
      unicode - Unicode code point.
      Returns:
      Array of 1 to 4 PDF content stream bytes.

    • encodeGlyphId

      public byte[] encodeGlyphId(int glyphId)
      Specified by:
      encodeGlyphId in class PDCIDFont

    • isEmbedded

      public boolean isEmbedded()
      Description copied from interface: PDFontLike
      Returns true if the font file is embedded in the PDF.
      Returns:
      true if the font file is embedded in the PDF

    • isDamaged

      public boolean isDamaged()
      Description copied from interface: PDFontLike
      Returns true if the embedded font file is damaged.
      Returns:
      true if the embedded font file is damaged

    • getTrueTypeFont

      public org.apache.fontbox.ttf.TrueTypeFont getTrueTypeFont()
      Returns the embedded or substituted TrueType font. May be an OpenType font if the font is not embedded.
      Returns:
      the embedded or substituted TrueType font

    • getPath

      public GeneralPath getPath(int code) throws IOException
      Description copied from interface: PDVectorFont
      Returns the glyph path for the given character code.
      Parameters:
      code - character code in a PDF. Not to be confused with unicode.
      Returns:
      the glyph path for the given character code
      Throws:
      IOException - if the font could not be read

    • getNormalizedPath

      public GeneralPath getNormalizedPath(int code) throws IOException
      Description copied from interface: PDVectorFont
      Returns the normalized glyph path for the given character code in a PDF. The resulting path is normalized to the PostScript 1000 unit square, and fallback glyphs are returned where appropriate, e.g. for missing glyphs.
      Parameters:
      code - character code in a PDF. Not to be confused with unicode.
      Returns:
      the normalized glyph path for the given character code
      Throws:
      IOException - if the font could not be read

    • hasGlyph

      public boolean hasGlyph(int code) throws IOException
      Description copied from interface: PDVectorFont
      Returns true if this font contains a glyph for the given character code in a PDF.
      Parameters:
      code - character code in a PDF. Not to be confused with unicode.
      Returns:
      true if this font contains a glyph for the given character code
      Throws:
      IOException - if the font could not be read