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

Class PDCIDFontType0

java.lang.Object
org.sejda.sambox.pdmodel.font.PDCIDFont
org.sejda.sambox.pdmodel.font.PDCIDFontType0
All Implemented Interfaces:
COSObjectable, PDFontLike, PDVectorFont
public class PDCIDFontType0 extends PDCIDFont
Type 0 CIDFont (CFF).
Author:
Ben Litchfield, John Hewson

  • Constructor Details

    • PDCIDFontType0

      public PDCIDFontType0(COSDictionary fontDictionary, PDType0Font parent) throws IOException
      Constructor.
      Parameters:
      fontDictionary - The font dictionary according to the PDF specification.
      parent - The parent font.
      Throws:
      IOException

  • Method Details

    • getFontMatrix

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

    • getBoundingBox

      public org.apache.fontbox.util.BoundingBox getBoundingBox()
      Description copied from interface: PDFontLike
      Returns the font's bounding box.

    • getCFFFont

      public org.apache.fontbox.cff.CFFFont getCFFFont()
      Returns the embedded CFF CIDFont, or null if the substitute is not a CFF font.

    • getFontBoxFont

      public org.apache.fontbox.FontBoxFont getFontBoxFont()
      Returns the embedded or substituted font.

    • getType2CharString

      public org.apache.fontbox.cff.Type2CharString getType2CharString(int cid) throws IOException
      Returns the Type 2 charstring for the given CID, or null if the substituted font does not contain Type 2 charstrings.
      Parameters:
      cid - CID
      Throws:
      IOException - if the charstring 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.
      Parameters:
      code - character code in a PDF. Not to be confused with unicode.
      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.
      Parameters:
      code - character code in a PDF. Not to be confused with unicode.
      Throws:
      IOException

    • codeToCID

      public int codeToCID(int code)
      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)
      Description copied from class: PDCIDFont
      Returns the GID for the given character code.
      Specified by:
      codeToGID in class PDCIDFont
      Parameters:
      code - character code
      Returns:
      GID

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

    • 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

    • isEmbedded

      public boolean isEmbedded()
      Description copied from interface: PDFontLike
      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.

    • 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.
      Parameters:
      code - character code
      Throws:
      IOException

    • getAverageFontWidth

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

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

    • 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