Package org.apache.pdfbox.pdmodel.font

Class PDType1Font

java.lang.Object
org.apache.pdfbox.pdmodel.font.PDFont
org.apache.pdfbox.pdmodel.font.PDSimpleFont
org.apache.pdfbox.pdmodel.font.PDType1Font
All Implemented Interfaces:
COSObjectable, PDFontLike, PDVectorFont
Direct Known Subclasses:
PDMMType1Font
public class PDType1Font extends PDSimpleFont implements PDVectorFont
A PostScript Type 1 Font.
Author:
Ben Litchfield

  • Constructor Details

    • PDType1Font

      public PDType1Font(Standard14Fonts.FontName baseFont)
      Creates a Type 1 standard 14 font for embedding.
      Parameters:
      baseFont - One of the standard 14 PostScript names, e.g. Standard14Fonts.FontName.HELVETICA_BOLD.

    • PDType1Font

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

    • PDType1Font

      public PDType1Font(PDDocument doc, InputStream pfbIn, Encoding encoding) throws 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:
      IOException - if the font could not be read

    • PDType1Font

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

  • Method Details

    • getBaseFont

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

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

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

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

    • 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

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

    • 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
      Returns:
      encoding of the font
      Throws:
      IOException - if the font file could not be read.

    • getType1Font

      public org.apache.fontbox.type1.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 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
      Returns:
      the embedded or system font used for rendering

    • 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
      Returns:
      the name of the font

    • 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
      Returns:
      the bounding box
      Throws:
      IOException - if the bounding box could not be read

    • codeToName

      public String codeToName(int code) throws IOException
      Throws:
      IOException

    • 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
      Parameters:
      name - glyph name
      Returns:
      glyph path of the character with the given name
      Throws:
      IOException - if the path could not be read

    • 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.
      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.
      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:
      IOException - if the font 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
      Parameters:
      name - glyph name
      Returns:
      true if the font contains the character with the given name
      Throws:
      IOException - if the path 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.
      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:
      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