Package org.apache.pdfbox.pdmodel.font

Class PDType1Font

    • Field Detail

      • LOG

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

      • ALT_NAMES

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

      • type1font

        private final Type1Font type1font
        embedded font.

      • genericFont

        private final FontBoxFont genericFont
        embedded or system font for rendering.

      • isEmbedded

        private final boolean isEmbedded

      • isDamaged

        private final boolean isDamaged

      • fontMatrixTransform

        private final java.awt.geom.AffineTransform fontMatrixTransform

      • codeToBytesMap

        private final java.util.Map<java.lang.Integer,​byte[]> codeToBytesMap
        to improve encoding speed.

      • fontMatrix

        private Matrix fontMatrix

    • Constructor Detail

      • PDType1Font

        public PDType1Font​(PDDocument doc,
                   java.io.InputStream pfbIn)
            throws java.io.IOException
        Creates a new Type 1 font for embedding.
        Parameters:
        doc - PDF document to write to
        pfbIn - PFB file stream
        Throws:
        java.io.IOException - if the font could not be read

      • PDType1Font

        public PDType1Font​(PDDocument doc,
                   java.io.InputStream pfbIn,
                   Encoding encoding)
            throws java.io.IOException
        Creates a new Type 1 font for embedding.
        Parameters:
        doc - PDF document to write to
        pfbIn - PFB file stream
        encoding - encoding to be used for the font
        Throws:
        java.io.IOException - if the font could not be read

      • PDType1Font

        public PDType1Font​(COSDictionary fontDictionary)
            throws java.io.IOException
        Creates a Type 1 font from a Font dictionary in a PDF.
        Parameters:
        fontDictionary - font dictionary.
        Throws:
        java.io.IOException - if there was an error initializing the font.
        java.lang.IllegalArgumentException - if /FontFile3 was used.

    • Method Detail

      • repairLength1

        private int repairLength1​(byte[] bytes,
                          int length1)
        Some Type 1 fonts have an invalid Length1, which causes the binary segment of the font to be truncated, see PDFBOX-2350, PDFBOX-3677.
        Parameters:
        bytes - Type 1 stream bytes
        length1 - Length1 from the Type 1 stream
        Returns:
        repaired Length1 value

      • findBinaryOffsetAfterExec

        private static int findBinaryOffsetAfterExec​(byte[] bytes,
                                             int startOffset)

      • repairLength2

        private int repairLength2​(byte[] bytes,
                          int length1,
                          int length2)
        Some Type 1 fonts have an invalid Length2, see PDFBOX-3475. A negative /Length2 brings an IllegalArgumentException in Arrays.copyOfRange(), a huge value eats up memory because of padding.
        Parameters:
        bytes - Type 1 stream bytes
        length1 - Length1 from the Type 1 stream
        length2 - Length2 from the Type 1 stream
        Returns:
        repaired Length2 value

      • getBaseFont

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

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

      • 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

      • 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

      • getAverageFontWidth

        public float getAverageFontWidth()
        Description copied from class: PDFont
        This will get the average font width for all characters.
        Specified by:
        getAverageFontWidth in interface PDFontLike
        Overrides:
        getAverageFontWidth in class PDFont
        Returns:
        The width is in 1000 unit of text space, ie 333 or 777

      • 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

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

      • getType1Font

        public Type1Font getType1Font()
        Returns the embedded or substituted Type 1 font, or null if there is none.
        Returns:
        the embedded or substituted Type 1 font or null

      • 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

      • 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

      • codeToName

        public java.lang.String codeToName​(int code)
                            throws java.io.IOException
        Throws:
        java.io.IOException

      • getNameInFont

        private java.lang.String getNameInFont​(java.lang.String name)
                                throws java.io.IOException
        Maps a PostScript glyph name to the name in the underlying font, for example when using a TTF font we might map "W" to "uni0057".
        Throws:
        java.io.IOException

      • 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

      • 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

      • 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

      • 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

      • 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

      • getFontMatrix

        public final Matrix getFontMatrix()
        Description copied from interface: PDFontLike
        Returns the font matrix, which represents the transformation from glyph space to text space.
        Specified by:
        getFontMatrix in interface PDFontLike
        Overrides:
        getFontMatrix in class PDFont
        Returns:
        the font matrix

      • 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