Package org.apache.pdfbox.pdmodel.font

Class PDTrueTypeFont

    • Field Detail

      • LOG

        private static final org.apache.commons.logging.Log LOG

      • INVERTED_MACOS_ROMAN

        private static final java.util.Map<java.lang.String,​java.lang.Integer> INVERTED_MACOS_ROMAN

      • isEmbedded

        private final boolean isEmbedded

      • isDamaged

        private final boolean isDamaged

      • cmapInitialized

        private boolean cmapInitialized

      • gidToCode

        private final java.util.Map<java.lang.Integer,​java.lang.Integer> gidToCode

    • Constructor Detail

      • PDTrueTypeFont

        public PDTrueTypeFont​(COSDictionary fontDictionary)
               throws java.io.IOException
        Creates a new TrueType font from a Font dictionary.
        Parameters:
        fontDictionary - The font dictionary according to the PDF specification.
        Throws:
        java.io.IOException - if the font could not be created

      • PDTrueTypeFont

        private PDTrueTypeFont​(PDDocument document,
                       TrueTypeFont ttf,
                       Encoding encoding,
                       boolean closeTTF)
                throws java.io.IOException
        Creates a new TrueType font for embedding.
        Throws:
        java.io.IOException

    • Method Detail

      • load

        public static PDTrueTypeFont load​(PDDocument doc,
                                  java.io.File file,
                                  Encoding encoding)
                           throws java.io.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:
        doc - The PDF document that will hold the embedded font.
        file - A TTF file.
        encoding - The PostScript encoding vector to be used for embedding.
        Returns:
        a PDTrueTypeFont instance.
        Throws:
        java.io.IOException - If there is an error loading the data.

      • load

        public static PDTrueTypeFont load​(PDDocument doc,
                                  java.io.InputStream input,
                                  Encoding encoding)
                           throws java.io.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:
        doc - The PDF document that will hold the embedded font.
        input - A TTF file stream. It will be closed before returning.
        encoding - The PostScript encoding vector to be used for embedding.
        Returns:
        a PDTrueTypeFont instance.
        Throws:
        java.io.IOException - If there is an error loading the data.

      • load

        public static PDTrueTypeFont load​(PDDocument doc,
                                  TrueTypeFont ttf,
                                  Encoding encoding)
                           throws java.io.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:
        doc - The PDF document that will hold the embedded font.
        ttf - A true type font
        encoding - The PostScript encoding vector to be used for embedding.
        Returns:
        a PDTrueTypeFont instance.
        Throws:
        java.io.IOException - If there is an error loading the data.

      • load

        public static PDTrueTypeFont load​(PDDocument doc,
                                  RandomAccessRead randomAccessRead,
                                  Encoding encoding)
                           throws java.io.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:
        doc - The PDF document that will hold the embedded font.
        randomAccessRead - the source of the TTF.
        encoding - The PostScript encoding vector to be used for embedding.
        Returns:
        a PDTrueTypeFont instance.
        Throws:
        java.io.IOException - If there is an error loading the data.

      • getBaseFont

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

      • readEncodingFromFont

        protected Encoding readEncodingFromFont()
                                 throws java.io.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
        Returns:
        encoding of the font
        Throws:
        java.io.IOException - if the font file could not be read.

      • readCode

        public int readCode​(java.io.InputStream in)
             throws java.io.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:
        java.io.IOException - if the CMap or stream cannot be read

      • getName

        public java.lang.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
        Returns:
        the name of the font

      • getBoundingBox

        public BoundingBox getBoundingBox()
                           throws java.io.IOException
        Description copied from interface: PDFontLike
        Returns the font's bounding box.
        Specified by:
        getBoundingBox in interface PDFontLike
        Returns:
        the bounding box
        Throws:
        java.io.IOException - if the bounding box could not be read

      • generateBoundingBox

        private BoundingBox generateBoundingBox()
                                 throws java.io.IOException
        Throws:
        java.io.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
        Returns:
        true if the embedded font file is damaged

      • getTrueTypeFont

        public TrueTypeFont getTrueTypeFont()
        Returns the embedded or substituted TrueType font.
        Returns:
        the embedded or substituted TrueType font

      • getWidthFromFont

        public float getWidthFromFont​(int code)
                       throws java.io.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:
        java.io.IOException - if the font could not be read

      • getHeight

        public float getHeight​(int code)
                throws java.io.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.

        Specified by:
        getHeight in interface PDFontLike
        Parameters:
        code - character code
        Returns:
        the height of the given character
        Throws:
        java.io.IOException - if the height could not be read

      • encode

        protected byte[] encode​(int unicode)
                 throws java.io.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:
        java.io.IOException - If the text could not be encoded.

      • getGIDToCode

        protected java.util.Map<java.lang.Integer,​java.lang.Integer> getGIDToCode()
                                                                         throws java.io.IOException
        Inverts the font's code -> GID mapping. Any duplicate (GID -> code) mappings will be lost.
        Returns:
        the GID for the given code
        Throws:
        java.io.IOException - if the data could not be read

      • 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
        Returns:
        true if the font file is embedded in the PDF

      • getPath

        public java.awt.geom.GeneralPath getPath​(int code)
                                  throws java.io.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.
        Returns:
        the glyph path for the given character code
        Throws:
        java.io.IOException - if the font could not be read

      • getPath

        public java.awt.geom.GeneralPath getPath​(java.lang.String name)
                                  throws java.io.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
        Parameters:
        name - glyph name
        Returns:
        glyph path of the character with the given name
        Throws:
        java.io.IOException - if the path could not be read

      • getNormalizedPath

        public java.awt.geom.GeneralPath getNormalizedPath​(int code)
                                            throws java.io.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.
        Specified by:
        getNormalizedPath in interface PDVectorFont
        Parameters:
        code - character code in a PDF. Not to be confused with unicode.
        Returns:
        the normalized glyph path for the given character code
        Throws:
        java.io.IOException - if the font could not be read

      • getPathFromOutlines

        private java.awt.geom.GeneralPath getPathFromOutlines​(int code)
                                               throws java.io.IOException
        Throws:
        java.io.IOException

      • hasGlyph

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

      • getFontBoxFont

        public 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
        Returns:
        the embedded or system font used for rendering

      • hasGlyph

        public boolean hasGlyph​(int code)
                 throws java.io.IOException
        Description copied from interface: PDVectorFont
        Returns true if this font contains a glyph for the given character code in a PDF.
        Specified by:
        hasGlyph in interface PDVectorFont
        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:
        java.io.IOException - if the font could not be read

      • codeToGID

        public int codeToGID​(int code)
              throws java.io.IOException
        Returns the GID for the given character code.
        Parameters:
        code - character code
        Returns:
        GID (glyph index)
        Throws:
        java.io.IOException - if the data could not be read

      • extractCmapTable

        private void extractCmapTable()
                       throws java.io.IOException
        extract all useful "cmap" subtables.
        Throws:
        java.io.IOException

      • getParser

        private TTFParser getParser​(RandomAccessRead randomAccessRead,
                            boolean isEmbedded)
                     throws java.io.IOException
        Throws:
        java.io.IOException