Class PDTrueTypeFont
- java.lang.Object
-
- org.apache.pdfbox.pdmodel.font.PDFont
-
- org.apache.pdfbox.pdmodel.font.PDSimpleFont
-
- org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
-
- All Implemented Interfaces:
COSObjectable
,PDFontLike
,PDVectorFont
public class PDTrueTypeFont extends PDSimpleFont implements PDVectorFont
TrueType font.
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
cmapInitialized
private CmapSubtable
cmapMacRoman
private CmapSubtable
cmapWinSymbol
private CmapSubtable
cmapWinUnicode
private BoundingBox
fontBBox
private java.util.Map<java.lang.Integer,java.lang.Integer>
gidToCode
private static java.util.Map<java.lang.String,java.lang.Integer>
INVERTED_MACOS_ROMAN
private boolean
isDamaged
private boolean
isEmbedded
private static org.apache.commons.logging.Log
LOG
private static int
START_RANGE_F000
private static int
START_RANGE_F100
private static int
START_RANGE_F200
private TrueTypeFont
ttf
-
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 Modifier Constructor Description PDTrueTypeFont(COSDictionary fontDictionary)
Creates a new TrueType font from a Font dictionary.private
PDTrueTypeFont(PDDocument document, TrueTypeFont ttf, Encoding encoding, boolean closeTTF)
Creates a new TrueType font for embedding.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description int
codeToGID(int code)
Returns the GID for the given character code.protected byte[]
encode(int unicode)
Encodes the given Unicode code point for use in a PDF content stream.private void
extractCmapTable()
extract all useful "cmap" subtables.private BoundingBox
generateBoundingBox()
java.lang.String
getBaseFont()
Returns the PostScript name of the font.BoundingBox
getBoundingBox()
Returns the font's bounding box.FontBoxFont
getFontBoxFont()
Returns the embedded or system font used for rendering.protected java.util.Map<java.lang.Integer,java.lang.Integer>
getGIDToCode()
Inverts the font's code -> GID mapping.float
getHeight(int code)
Returns the height of the given character, in glyph space.java.lang.String
getName()
Returns the name of this font, either the PostScript "BaseName" or the Type 3 "Name".java.awt.geom.GeneralPath
getPath(int code)
Returns the glyph path for the given character code in a PDF.java.awt.geom.GeneralPath
getPath(java.lang.String name)
Returns the path for the character with the given name.TrueTypeFont
getTrueTypeFont()
Returns the embedded or substituted TrueType font.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
hasGlyph(java.lang.String name)
Returns true if the font contains the character with the given name.boolean
isDamaged()
Returns true if the embedded font file is damaged.boolean
isEmbedded()
Returns true if the font file is embedded in the PDF.static PDTrueTypeFont
load(PDDocument doc, java.io.File file, Encoding encoding)
Loads a TTF to be embedded into a document as a simple font.static PDTrueTypeFont
load(PDDocument doc, java.io.InputStream input, Encoding encoding)
Loads a TTF to be embedded into a document as a simple font.static PDTrueTypeFont
load(PDDocument doc, TrueTypeFont ttf, Encoding encoding)
Loads a TTF to be embedded into a document as a simple font.static PDTrueTypeFont
loadTTF(PDDocument doc, java.io.File file)
Deprecated.UsePDType0Font.load(PDDocument, File)
instead.static PDTrueTypeFont
loadTTF(PDDocument doc, java.io.InputStream input)
Deprecated.UsePDType0Font.load(PDDocument, InputStream)
instead.int
readCode(java.io.InputStream in)
Reads a character code from a content stream string.protected Encoding
readEncodingFromFont()
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, getAverageFontWidth, getCOSObject, getDisplacement, getFontDescriptor, getFontMatrix, getPositionVector, getSpaceWidth, getStandard14AFM, getStringWidth, getSubType, getToUnicodeCMap, getType, getWidth, getWidths, hashCode, readCMap, setFontDescriptor, toString
-
-
-
-
Field Detail
-
LOG
private static final org.apache.commons.logging.Log LOG
-
START_RANGE_F000
private static final int START_RANGE_F000
- See Also:
- Constant Field Values
-
START_RANGE_F100
private static final int START_RANGE_F100
- See Also:
- Constant Field Values
-
START_RANGE_F200
private static final int START_RANGE_F200
- See Also:
- Constant Field Values
-
INVERTED_MACOS_ROMAN
private static final java.util.Map<java.lang.String,java.lang.Integer> INVERTED_MACOS_ROMAN
-
cmapWinUnicode
private CmapSubtable cmapWinUnicode
-
cmapWinSymbol
private CmapSubtable cmapWinSymbol
-
cmapMacRoman
private CmapSubtable cmapMacRoman
-
cmapInitialized
private boolean cmapInitialized
-
gidToCode
private java.util.Map<java.lang.Integer,java.lang.Integer> gidToCode
-
ttf
private final TrueTypeFont ttf
-
isEmbedded
private final boolean isEmbedded
-
isDamaged
private final boolean isDamaged
-
fontBBox
private BoundingBox fontBBox
-
-
Constructor Detail
-
PDTrueTypeFont
public PDTrueTypeFont(COSDictionary fontDictionary) throws java.io.IOException
Creates a new TrueType font from a Font dictionary.- Parameters:
fontDictionary
- The font dictionary according to the PDF specification.- Throws:
java.io.IOException
-
PDTrueTypeFont
private PDTrueTypeFont(PDDocument document, TrueTypeFont ttf, Encoding encoding, boolean closeTTF) throws java.io.IOException
Creates a new TrueType font for embedding.- Throws:
java.io.IOException
-
-
Method Detail
-
load
public static PDTrueTypeFont load(PDDocument doc, java.io.File file, Encoding encoding) throws java.io.IOException
Loads a TTF to be embedded into a document as a simple font.Note: Simple fonts only support 256 characters. For Unicode support, use
PDType0Font.load(PDDocument, File)
instead.- Parameters:
doc
- The PDF document that will hold the embedded font.file
- A TTF file.encoding
- The PostScript encoding vector to be used for embedding.- Returns:
- a PDTrueTypeFont instance.
- Throws:
java.io.IOException
- If there is an error loading the data.
-
load
public static PDTrueTypeFont load(PDDocument doc, java.io.InputStream input, Encoding encoding) throws java.io.IOException
Loads a TTF to be embedded into a document as a simple font.Note: Simple fonts only support 256 characters. For Unicode support, use
PDType0Font.load(PDDocument, InputStream)
instead.- Parameters:
doc
- The PDF document that will hold the embedded font.input
- A TTF file streamencoding
- The PostScript encoding vector to be used for embedding.- Returns:
- a PDTrueTypeFont instance.
- Throws:
java.io.IOException
- If there is an error loading the data.
-
load
public static PDTrueTypeFont load(PDDocument doc, TrueTypeFont ttf, Encoding encoding) throws java.io.IOException
Loads a TTF to be embedded into a document as a simple font.Note: Simple fonts only support 256 characters. For Unicode support, use
PDType0Font.load(PDDocument, InputStream)
instead.- Parameters:
doc
- The PDF document that will hold the embedded font.ttf
- A true type fontencoding
- The PostScript encoding vector to be used for embedding.- Returns:
- a PDTrueTypeFont instance.
- Throws:
java.io.IOException
- If there is an error loading the data.
-
loadTTF
@Deprecated public static PDTrueTypeFont loadTTF(PDDocument doc, java.io.File file) throws java.io.IOException
Deprecated.UsePDType0Font.load(PDDocument, File)
instead.Loads a TTF to be embedded into a document as a simple font. Only supports WinAnsiEncoding.- Parameters:
doc
- The PDF document that will hold the embedded font.file
- A TTF file.- Returns:
- a PDTrueTypeFont instance.
- Throws:
java.io.IOException
- If there is an error loading the data.
-
loadTTF
@Deprecated public static PDTrueTypeFont loadTTF(PDDocument doc, java.io.InputStream input) throws java.io.IOException
Deprecated.UsePDType0Font.load(PDDocument, InputStream)
instead.Loads a TTF to be embedded into a document as a simple font. Only supports WinAnsiEncoding.- Parameters:
doc
- The PDF document that will hold the embedded font.input
- A TTF file stream- Returns:
- a PDTrueTypeFont instance.
- Throws:
java.io.IOException
- If there is an error loading the data.
-
getBaseFont
public final java.lang.String getBaseFont()
Returns the PostScript name of the font.
-
readEncodingFromFont
protected Encoding readEncodingFromFont() throws java.io.IOException
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:
java.io.IOException
- if the font file could not be read.
-
readCode
public int readCode(java.io.InputStream in) throws java.io.IOException
Description copied from class:PDFont
Reads a character code from a content stream string. Codes may be up to 4 bytes long.
-
getName
public java.lang.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 interfacePDFontLike
-
getBoundingBox
public BoundingBox getBoundingBox() throws java.io.IOException
Description copied from interface:PDFontLike
Returns the font's bounding box.- Specified by:
getBoundingBox
in interfacePDFontLike
- Throws:
java.io.IOException
-
generateBoundingBox
private BoundingBox generateBoundingBox() throws java.io.IOException
- Throws:
java.io.IOException
-
isDamaged
public boolean isDamaged()
Description copied from interface:PDFontLike
Returns true if the embedded font file is damaged.- Specified by:
isDamaged
in interfacePDFontLike
-
getTrueTypeFont
public TrueTypeFont getTrueTypeFont()
Returns the embedded or substituted TrueType font.
-
getWidthFromFont
public float getWidthFromFont(int code) throws java.io.IOException
Description copied from interface:PDFontLike
Returns the width of a glyph in the embedded font file.- Specified by:
getWidthFromFont
in interfacePDFontLike
- Parameters:
code
- character code- Returns:
- width in glyph space
- Throws:
java.io.IOException
- if the font could not be read
-
getHeight
public float getHeight(int code) throws java.io.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 interfacePDFontLike
- Parameters:
code
- character code- Throws:
java.io.IOException
-
encode
protected byte[] encode(int unicode) throws java.io.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.
-
getGIDToCode
protected java.util.Map<java.lang.Integer,java.lang.Integer> getGIDToCode() throws java.io.IOException
Inverts the font's code -> GID mapping. Any duplicate (GID -> code) mappings will be lost.- Throws:
java.io.IOException
-
isEmbedded
public boolean isEmbedded()
Description copied from interface:PDFontLike
Returns true if the font file is embedded in the PDF.- Specified by:
isEmbedded
in interfacePDFontLike
-
getPath
public java.awt.geom.GeneralPath getPath(int code) throws java.io.IOException
Description copied from interface:PDVectorFont
Returns the glyph path for the given character code in a PDF.- Specified by:
getPath
in interfacePDVectorFont
- Parameters:
code
- character code in a PDF. Not to be confused with unicode.- Throws:
java.io.IOException
- if the font could not be read
-
getPath
public java.awt.geom.GeneralPath getPath(java.lang.String name) throws java.io.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 classPDSimpleFont
- Returns:
- glyph path
- Throws:
java.io.IOException
- if the path could not be read
-
hasGlyph
public boolean hasGlyph(java.lang.String name) throws java.io.IOException
Description copied from class:PDSimpleFont
Returns true if the font contains the character with the given name.- Specified by:
hasGlyph
in classPDSimpleFont
- Throws:
java.io.IOException
- if the path could not be read
-
getFontBoxFont
public FontBoxFont getFontBoxFont()
Description copied from class:PDSimpleFont
Returns the embedded or system font used for rendering. This is never null.- Specified by:
getFontBoxFont
in classPDSimpleFont
-
hasGlyph
public boolean hasGlyph(int code) throws java.io.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 interfacePDVectorFont
- Parameters:
code
- character code in a PDF. Not to be confused with unicode.- Throws:
java.io.IOException
-
codeToGID
public int codeToGID(int code) throws java.io.IOException
Returns the GID for the given character code.- Parameters:
code
- character code- Returns:
- GID (glyph index)
- Throws:
java.io.IOException
-
extractCmapTable
private void extractCmapTable() throws java.io.IOException
extract all useful "cmap" subtables.- Throws:
java.io.IOException
-
-