Package org.apache.pdfbox.pdmodel.font
Class PDCIDFontType0
java.lang.Object
org.apache.pdfbox.pdmodel.font.PDCIDFont
org.apache.pdfbox.pdmodel.font.PDCIDFontType0
- All Implemented Interfaces:
COSObjectable
,PDFontLike
,PDVectorFont
Type 0 CIDFont (CFF).
- Author:
- Ben Litchfield, John Hewson
-
Field Summary
-
Constructor Summary
ConstructorsConstructorDescriptionPDCIDFontType0
(COSDictionary fontDictionary, PDType0Font parent) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionint
codeToCID
(int code) Returns the CID for the given character code.int
codeToGID
(int code) Returns the GID for the given character code.byte[]
encode
(int unicode) Encodes the given Unicode code point for use in a PDF content stream.float
This will get the average font width for all characters.org.apache.fontbox.util.BoundingBox
Returns the font's bounding box.org.apache.fontbox.cff.CFFFont
Returns the embedded CFF CIDFont, or null if the substitute is not a CFF font.org.apache.fontbox.FontBoxFont
Returns the embedded or substituted font.final Matrix
Returns the font matrix, which represents the transformation from glyph space to text space.float
getHeight
(int code) Returns the height of the given character, in glyph space.getPath
(int code) Returns the glyph path for the given character code in a PDF.org.apache.fontbox.cff.Type2CharString
getType2CharString
(int cid) Returns the Type 2 charstring for the given CID, or null if the substituted font does not contain Type 2 charstrings.float
getWidthFromFont
(int code) Returns the width of a glyph in the embedded font file.boolean
hasGlyph
(int code) Returns true if this font contains a glyph for the given character code in a PDF.boolean
Returns true if the embedded font file is damaged.boolean
Returns true if the font file is embedded in the PDF.Methods inherited from class org.apache.pdfbox.pdmodel.font.PDCIDFont
getBaseFont, getCIDSystemInfo, getCOSObject, getFontDescriptor, getName, getParent, getPositionVector, getVerticalDisplacementVectorY, getWidth, hasExplicitWidth
-
Constructor Details
-
PDCIDFontType0
Constructor.- Parameters:
fontDictionary
- The font dictionary according to the PDF specification.parent
- The parent font.- Throws:
IOException
-
-
Method Details
-
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
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
Description copied from interface:PDVectorFont
Returns the glyph path for the given character code in a PDF.- Parameters:
code
- character code in a PDF. Not to be confused with unicode.- Throws:
IOException
- if the font could not be read
-
hasGlyph
Description copied from interface:PDVectorFont
Returns true if this font contains a glyph for the given character code in a PDF.- 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. -
codeToGID
public int codeToGID(int code) Description copied from class:PDCIDFont
Returns the GID for the given character code. -
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.
-
getWidthFromFont
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
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.- 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 interfacePDFontLike
- Overrides:
getAverageFontWidth
in classPDCIDFont
- Returns:
- The width is in 1000 unit of text space, ie 333 or 777
-