Module org.sejda.sambox
Package org.sejda.sambox.pdmodel.font

Class PDTrueTypeFont

java.lang.Object
org.sejda.sambox.pdmodel.font.PDFont
org.sejda.sambox.pdmodel.font.PDSimpleFont
org.sejda.sambox.pdmodel.font.PDTrueTypeFont
All Implemented Interfaces:
COSObjectable, PDFontLike, PDVectorFont, Subsettable
public class PDTrueTypeFont extends PDSimpleFont implements PDVectorFont
TrueType font.
Author:
Ben Litchfield

  • Constructor Details

    • PDTrueTypeFont

      public PDTrueTypeFont(COSDictionary fontDictionary) throws IOException
      Creates a new TrueType font from a Font dictionary.
      Parameters:
      fontDictionary - The font dictionary according to the PDF specification.
      Throws:
      IOException

    • PDTrueTypeFont

      public PDTrueTypeFont(COSDictionary fontDictionary, org.apache.fontbox.ttf.TrueTypeFont ttf) throws IOException
      Throws:
      IOException

  • Method Details

    • load

      public static PDTrueTypeFont load(File file, Encoding encoding) throws IOException
      Loads a TTF to be embedded into a document as a simple font.

      Note: Simple fonts only support 256 characters. For Unicode support, use PDType0Font.load(PDDocument, File) instead.

      Parameters:
      file - A TTF file.
      encoding - The PostScript encoding vector to be used for embedding.
      Returns:
      a PDTrueTypeFont instance.
      Throws:
      IOException - If there is an error loading the data.

    • load

      public static PDTrueTypeFont load(InputStream input, Encoding encoding) throws IOException
      Loads a TTF to be embedded into a document as a simple font.

      Note: Simple fonts only support 256 characters. For Unicode support, use PDType0Font.load(PDDocument, InputStream) instead.

      Parameters:
      input - A TTF file stream
      encoding - The PostScript encoding vector to be used for embedding.
      Returns:
      a PDTrueTypeFont instance.
      Throws:
      IOException - If there is an error loading the data.

    • load

      public static PDTrueTypeFont load(PDDocument doc, org.apache.fontbox.ttf.TrueTypeFont ttf, Encoding encoding) throws IOException
      Loads a TTF to be embedded into a document as a simple font.

      Note: Simple fonts only support 256 characters. For Unicode support, use PDType0Font.load(PDDocument, InputStream) instead.

      Parameters:
      ttf - A true type font
      encoding - The PostScript encoding vector to be used for embedding.
      Returns:
      a PDTrueTypeFont instance.
      Throws:
      IOException - If there is an error loading the data.

    • getBaseFont

      public final String getBaseFont()
      Returns the PostScript name of the font.

    • readEncodingFromFont

      protected Encoding readEncodingFromFont() throws IOException
      Description copied from class: PDSimpleFont
      Called by readEncoding() if the encoding needs to be extracted from the font file.
      Specified by:
      readEncodingFromFont in class PDSimpleFont
      Throws:
      IOException - if the font file could not be read.

    • readCode

      public int readCode(InputStream in) throws IOException
      Description copied from class: PDFont
      Reads a character code from a content stream string. Codes may be up to 4 bytes long.
      Specified by:
      readCode in class PDFont
      Parameters:
      in - string stream
      Returns:
      character code
      Throws:
      IOException - if the CMap or stream cannot be read

    • getName

      public String getName()
      Description copied from interface: PDFontLike
      Returns the name of this font, either the PostScript "BaseName" or the Type 3 "Name".
      Specified by:
      getName in interface PDFontLike

    • getBoundingBox

      public org.apache.fontbox.util.BoundingBox getBoundingBox() throws IOException
      Description copied from interface: PDFontLike
      Returns the font's bounding box.
      Specified by:
      getBoundingBox in interface PDFontLike
      Throws:
      IOException

    • isDamaged

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

    • getTrueTypeFont

      public org.apache.fontbox.ttf.TrueTypeFont getTrueTypeFont()
      Returns the embedded or substituted TrueType font.

    • getWidthFromFont

      public float getWidthFromFont(int code) throws IOException
      Description copied from interface: PDFontLike
      Returns the width of a glyph in the embedded font file.
      Specified by:
      getWidthFromFont in interface PDFontLike
      Parameters:
      code - character code
      Returns:
      width in glyph space
      Throws:
      IOException - if the font 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.
      Specified by:
      getHeight in interface PDFontLike
      Parameters:
      code - character code
      Throws:
      IOException

    • encode

      protected byte[] encode(int unicode) throws IOException
      Description copied from class: PDFont
      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 PDFont
      Parameters:
      unicode - Unicode code point.
      Returns:
      Array of 1 to 4 PDF content stream bytes.
      Throws:
      IOException - If the text could not be encoded.

    • getGIDToCode

      protected Map<Integer,Integer> getGIDToCode() throws IOException
      Inverts the font's code -> GID mapping. Any duplicate (GID -> code) mappings will be lost.
      Throws:
      IOException

    • isEmbedded

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

    • getPath

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

    • getPath

      public GeneralPath getPath(String name) throws IOException
      Description copied from class: PDSimpleFont
      Returns the path for the character with the given name. For some fonts, GIDs may be used instead of names when calling this method.
      Specified by:
      getPath in class PDSimpleFont
      Returns:
      glyph path
      Throws:
      IOException - if the path could not be read

    • hasGlyph

      public boolean hasGlyph(String name) throws IOException
      Description copied from class: PDSimpleFont
      Returns true if the font contains the character with the given name.
      Specified by:
      hasGlyph in class PDSimpleFont
      Throws:
      IOException - if the path could not be read

    • getFontBoxFont

      public org.apache.fontbox.FontBoxFont getFontBoxFont()
      Description copied from class: PDSimpleFont
      Returns the embedded or system font used for rendering. This is never null.
      Specified by:
      getFontBoxFont in class PDSimpleFont

    • 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.
      Specified by:
      hasGlyph in interface PDVectorFont
      Parameters:
      code - character code in a PDF. Not to be confused with unicode.
      Throws:
      IOException

    • codeToGID

      public int codeToGID(int code) throws IOException
      Returns the GID for the given character code.
      Parameters:
      code - character code
      Returns:
      GID (glyph index)
      Throws:
      IOException

    • isOriginalEmbeddedMissing

      public boolean isOriginalEmbeddedMissing()
      Description copied from interface: PDFontLike
      Returns true if the font file that was supposed to be embedded in the PDF is missing.
      Specified by:
      isOriginalEmbeddedMissing in interface PDFontLike

    • isMappingFallbackUsed

      public boolean isMappingFallbackUsed()
      Description copied from interface: PDFontLike
      Returns true if a substitute font was searched via font mappings, but an exact match was not found, and a fallback was used
      Specified by:
      isMappingFallbackUsed in interface PDFontLike