Package org.apache.pdfbox.pdmodel.font
Class PDType1CFont
java.lang.Object
org.apache.pdfbox.pdmodel.font.PDFont
org.apache.pdfbox.pdmodel.font.PDSimpleFont
org.apache.pdfbox.pdmodel.font.PDType1CFont
- All Implemented Interfaces:
COSObjectable
,PDFontLike
Type 1-equivalent CFF font.
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Float
private final CFFType1Font
private BoundingBox
private Matrix
private final AffineTransform
private final FontBoxFont
private final boolean
private final boolean
private static final org.apache.commons.logging.Log
Fields inherited from class org.apache.pdfbox.pdmodel.font.PDSimpleFont
encoding, glyphList
Fields inherited from class org.apache.pdfbox.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.private BoundingBox
private float
float
This will get the average font width for all characters.final String
Returns the PostScript name of the font.Returns the font's bounding box.Returns the embedded Type 1-equivalent CFF font.Returns the embedded or system font used for rendering.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.final String
getName()
Returns the name of this font, either the PostScript "BaseName" or the Type 3 "Name".private String
getNameInFont
(String name) 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".Returns the path for the character with the given name.float
getStringWidth
(String string) Returns the width of the given Unicode string.float
getWidthFromFont
(int code) Returns the width of a glyph in the embedded font file.boolean
Returns true if the font contains the character with the given name.boolean
Returns true if the embedded font file is damaged.boolean
Returns true if the font file is embedded in the PDF.int
readCode
(InputStream in) Reads a character code from a content stream string.protected Encoding
Called by readEncoding() if the encoding needs to be extracted from the font file.Methods inherited from class org.apache.pdfbox.pdmodel.font.PDSimpleFont
addToSubset, getEncoding, getGlyphList, getStandard14Width, getSymbolicFlag, hasExplicitWidth, isFontSymbolic, isStandard14, isSymbolic, isVertical, readEncoding, subset, toUnicode, toUnicode, willBeSubset
Methods inherited from class org.apache.pdfbox.pdmodel.font.PDFont
encode, equals, getCOSObject, getDisplacement, getFontDescriptor, getPositionVector, getSpaceWidth, getStandard14AFM, getSubType, getToUnicodeCMap, getType, getWidth, getWidths, hashCode, readCMap, setFontDescriptor, toString
-
Field Details
-
LOG
private static final org.apache.commons.logging.Log LOG -
glyphHeights
-
avgWidth
-
fontMatrix
-
fontMatrixTransform
-
cffFont
-
genericFont
-
isEmbedded
private final boolean isEmbedded -
isDamaged
private final boolean isDamaged -
fontBBox
-
-
Constructor Details
-
PDType1CFont
Constructor.- Parameters:
fontDictionary
- the corresponding dictionary- Throws:
IOException
- it something went wrong
-
-
Method Details
-
getFontBoxFont
Description copied from class:PDSimpleFont
Returns the embedded or system font used for rendering. This is never null.- Specified by:
getFontBoxFont
in classPDSimpleFont
-
getBaseFont
Returns the PostScript name of the font. -
getPath
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 classPDSimpleFont
- Returns:
- glyph path
- Throws:
IOException
- if the path could not be read
-
hasGlyph
Description copied from class:PDSimpleFont
Returns true if the font contains the character with the given name.- Specified by:
hasGlyph
in classPDSimpleFont
- Throws:
IOException
- if the path could not be read
-
getName
Description copied from interface:PDFontLike
Returns the name of this font, either the PostScript "BaseName" or the Type 3 "Name". -
getBoundingBox
Description copied from interface:PDFontLike
Returns the font's bounding box.- Throws:
IOException
-
generateBoundingBox
- Throws:
IOException
-
codeToName
-
readEncodingFromFont
Description copied from class:PDSimpleFont
Called by readEncoding() if the encoding needs to be extracted from the font file.- Specified by:
readEncodingFromFont
in classPDSimpleFont
- Throws:
IOException
- if the font file could not be read.
-
readCode
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 classPDFont
- Parameters:
in
- string stream- Returns:
- character code
- Throws:
IOException
- if the CMap or stream cannot be read
-
getFontMatrix
Description copied from interface:PDFontLike
Returns the font matrix, which represents the transformation from glyph space to text space.- Specified by:
getFontMatrix
in interfacePDFontLike
- Overrides:
getFontMatrix
in classPDFont
-
isDamaged
public boolean isDamaged()Description copied from interface:PDFontLike
Returns true if the embedded font file is damaged. -
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. -
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
-
encode
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 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:PDFont
Returns the width of the given Unicode string.- Overrides:
getStringWidth
in 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:PDFont
This will get the average font width for all characters.- Specified by:
getAverageFontWidth
in interfacePDFontLike
- Overrides:
getAverageFontWidth
in classPDFont
- Returns:
- The width is in 1000 unit of text space, ie 333 or 777
-
getCFFType1Font
Returns the embedded Type 1-equivalent CFF font.- Returns:
- the cffFont
-
getAverageCharacterWidth
private float getAverageCharacterWidth() -
getNameInFont
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:
IOException
-