java.lang.Object
org.sejda.sambox.pdmodel.font.PDFont
org.sejda.sambox.pdmodel.font.PDSimpleFont
org.sejda.sambox.pdmodel.font.PDType1CFont
- All Implemented Interfaces:
COSObjectable,PDFontLike,Subsettable
Type 1-equivalent CFF font.
- Author:
- Villu Ruusmann, John Hewson
-
Field Summary
Fields inherited from class org.sejda.sambox.pdmodel.font.PDSimpleFont
encoding, glyphListFields inherited from class org.sejda.sambox.pdmodel.font.PDFont
DEFAULT_FONT_MATRIX, dict -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncodeToName(int code) protected byte[]encode(int unicode) Encodes the given Unicode code point for use in a PDF content stream.floatThis will get the average font width for all characters.final StringReturns the PostScript name of the font.org.apache.fontbox.util.BoundingBoxReturns the font's bounding box.org.apache.fontbox.cff.CFFType1FontReturns the embedded Type 1-equivalent CFF font.org.apache.fontbox.FontBoxFontReturns the embedded or system font used for rendering.final MatrixReturns the font matrix, which represents the transformation from glyph space to text space.floatgetHeight(int code) Returns the height of the given character, in glyph space.final StringgetName()Returns the name of this font, either the PostScript "BaseName" or the Type 3 "Name".Returns the path for the character with the given name.floatgetStringWidth(String string) Returns the width of the given Unicode string.floatgetWidthFromFont(int code) Returns the width of a glyph in the embedded font file.booleanReturns true if the font contains the character with the given name.booleanReturns true if the embedded font file is damaged.booleanReturns true if the font file is embedded in the PDF.booleanReturns true if a substitute font was searched via font mappings, but an exact match was not found, and a fallback was usedbooleanReturns true if the font file that was supposed to be embedded in the PDF is missing.intreadCode(InputStream in) Reads a character code from a content stream string.protected EncodingCalled by readEncoding() if the encoding needs to be extracted from the font file.Methods inherited from class org.sejda.sambox.pdmodel.font.PDSimpleFont
addToSubset, getEncoding, getGlyphList, getStandard14Width, getSymbolicFlag, hasExplicitWidth, isFontSymbolic, isStandard14, isSymbolic, isVertical, readEncoding, subset, toUnicode, toUnicode, willBeSubsetMethods inherited from class org.sejda.sambox.pdmodel.font.PDFont
encode, encodeLeniently, equals, getCOSObject, getDisplacement, getFontDescriptor, getPositionVector, getSpaceWidth, getStandard14AFM, getStringWidthLeniently, getSubType, getToUnicodeCMap, getTransientMetadata, getType, getWidth, getWidths, hashCode, readCMap, setFontDescriptor, toString
-
Constructor Details
-
PDType1CFont
Constructor.- Parameters:
fontDictionary- the corresponding dictionary- Throws:
IOException- it something went wrong
-
-
Method Details
-
getFontBoxFont
public org.apache.fontbox.FontBoxFont getFontBoxFont()Description copied from class:PDSimpleFontReturns the embedded or system font used for rendering. This is never null.- Specified by:
getFontBoxFontin classPDSimpleFont
-
getBaseFont
Returns the PostScript name of the font. -
getPath
Description copied from class:PDSimpleFontReturns 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:
getPathin classPDSimpleFont- Returns:
- glyph path
- Throws:
IOException- if the path could not be read
-
hasGlyph
Description copied from class:PDSimpleFontReturns true if the font contains the character with the given name.- Specified by:
hasGlyphin classPDSimpleFont- Throws:
IOException- if the path could not be read
-
getName
Description copied from interface:PDFontLikeReturns the name of this font, either the PostScript "BaseName" or the Type 3 "Name". -
getBoundingBox
Description copied from interface:PDFontLikeReturns the font's bounding box.- Throws:
IOException
-
codeToName
-
readEncodingFromFont
Description copied from class:PDSimpleFontCalled by readEncoding() if the encoding needs to be extracted from the font file.- Specified by:
readEncodingFromFontin classPDSimpleFont- Throws:
IOException- if the font file could not be read.
-
readCode
Description copied from class:PDFontReads a character code from a content stream string. Codes may be up to 4 bytes long.- Specified by:
readCodein classPDFont- Parameters:
in- string stream- Returns:
- character code
- Throws:
IOException- if the CMap or stream cannot be read
-
getFontMatrix
Description copied from interface:PDFontLikeReturns the font matrix, which represents the transformation from glyph space to text space.- Specified by:
getFontMatrixin interfacePDFontLike- Overrides:
getFontMatrixin classPDFont
-
isDamaged
public boolean isDamaged()Description copied from interface:PDFontLikeReturns true if the embedded font file is damaged. -
getWidthFromFont
Description copied from interface:PDFontLikeReturns 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:PDFontLikeReturns true if the font file is embedded in the PDF. -
getHeight
Description copied from interface:PDFontLikeReturns 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. ThePDFontLike.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
-
encode
Description copied from class:PDFontEncodes 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:
encodein classPDFont- Parameters:
unicode- Unicode code point.- Returns:
- Array of 1 to 4 PDF content stream bytes.
- Throws:
IOException- If the text could not be encoded.
-
getStringWidth
Description copied from class:PDFontReturns the width of the given Unicode string.- Overrides:
getStringWidthin classPDFont- Parameters:
string- The text to get the width of.- Returns:
- The width of the string in 1/1000 units of text space.
- Throws:
IOException- If there is an error getting the width information.
-
getAverageFontWidth
public float getAverageFontWidth()Description copied from class:PDFontThis will get the average font width for all characters.- Specified by:
getAverageFontWidthin interfacePDFontLike- Overrides:
getAverageFontWidthin classPDFont- Returns:
- The width is in 1000 unit of text space, ie 333 or 777
-
getCFFType1Font
public org.apache.fontbox.cff.CFFType1Font getCFFType1Font()Returns the embedded Type 1-equivalent CFF font.- Returns:
- the cffFont
-
isOriginalEmbeddedMissing
public boolean isOriginalEmbeddedMissing()Description copied from interface:PDFontLikeReturns true if the font file that was supposed to be embedded in the PDF is missing. -
isMappingFallbackUsed
public boolean isMappingFallbackUsed()Description copied from interface:PDFontLikeReturns true if a substitute font was searched via font mappings, but an exact match was not found, and a fallback was used
-