Package org.apache.pdfbox.pdmodel.font

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

public class PDTrueTypeFont
extends PDSimpleFont

This is the TrueType implementation of fonts.

Author:

Ben Litchfield

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	UNKNOWN_FONT	This is the key to a property in the PDFBox_External_Fonts.properties file to load a Font when a mapping does not exist for the current font.

Fields inherited from class org.apache.pdfbox.pdmodel.font.PDFont

cmap, cmapObjects, font, fontMatrix, resourceRootCMAP, toUnicodeCmap

Constructor Summary

Constructors

Constructor	Description
PDTrueTypeFont()	Constructor.
PDTrueTypeFont(COSDictionary fontDictionary)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	clear()	Calling this will release all cached information.
java.awt.Font	getawtFont()	Looks up, creates, returns the AWT Font.
float	getFontWidth(int charCode)	Determines the width of the given character.
org.apache.fontbox.ttf.TrueTypeFont	getTTFFont()	Return the TTF font as TrueTypeFont.
static PDTrueTypeFont	loadTTF(PDStream fontStream, Encoding enc)	This will load a TTF to be embedded into a document.
static PDTrueTypeFont	loadTTF(PDDocument doc, java.io.File file)	This will load a TTF to be embedded into a document.
static PDTrueTypeFont	loadTTF(PDDocument doc, java.io.InputStream stream)	This will load a TTF to be embedded into a document.
static PDTrueTypeFont	loadTTF(PDDocument doc, java.io.InputStream stream, Encoding enc)	This will load a TTF to be embedded into a document.
static PDTrueTypeFont	loadTTF(PDDocument doc, java.lang.String file)	This will load a TTF font from a font file.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class org.apache.pdfbox.pdmodel.font.PDFont

clearResources, cmapEncoding, drawString, encode, encodeToCID, equals, getAFM, getAverageFontWidthFromAFMFile, getBaseFont, getCodeFromArray, getCOSObject, getEncoding, getFirstChar, getFontDescriptor, getFontEncoding, getFontMatrix, getFontWidthFromAFMFile, getLastChar, getStringFromArray, getStringWidth, getSubType, getToUnicodeCMap, getType, getWidths, hashCode, hasToUnicode, isSymbolicFont, isType0Font, isType1Font, isType3Font, parseCmap, setBaseFont, setEncoding, setFirstChar, setFontDescriptor, setFontEncoding, setHasToUnicode, setLastChar, setWidths

Methods inherited from class org.apache.pdfbox.pdmodel.font.PDSimpleFont

determineEncoding, drawString, getAverageFontWidth, getFontBoundingBox, getFontHeight, getFontWidth, getSpaceWidth, getToUnicode, isFontSubstituted, setIsFontSubstituted, setToUnicode, writeFont

Field Detail

UNKNOWN_FONT

public static final java.lang.String UNKNOWN_FONT

This is the key to a property in the PDFBox_External_Fonts.properties file to load a Font when a mapping does not exist for the current font.

See Also:

Constant Field Values

Constructor Detail

PDTrueTypeFont

public PDTrueTypeFont()

Constructor.

PDTrueTypeFont

public PDTrueTypeFont(COSDictionary fontDictionary)
               throws java.io.IOException

Constructor.

Parameters:

fontDictionary - The font dictionary according to the PDF specification.

Throws:

java.io.IOException - exception if something went wrong when loading the font.

Method Detail

loadTTF

public static PDTrueTypeFont loadTTF(PDDocument doc,
                                     java.lang.String file)
                              throws java.io.IOException

This will load a TTF font from a font file.

Parameters:

doc - The PDF document that will hold the embedded font.

file - The file on the filesystem that holds the font file.

Returns:

A true type font.

Throws:

java.io.IOException - If there is an error loading the file data.

loadTTF

public static PDTrueTypeFont loadTTF(PDDocument doc,
                                     java.io.File file)
                              throws java.io.IOException

This will load a TTF to be embedded into a document.

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

public static PDTrueTypeFont loadTTF(PDDocument doc,
                                     java.io.InputStream stream)
                              throws java.io.IOException

This will load a TTF to be embedded into a document.

Parameters:

doc - The PDF document that will hold the embedded font.

stream - a ttf input stream.

Returns:

a PDTrueTypeFont instance.

Throws:

java.io.IOException - If there is an error loading the data.

loadTTF

public static PDTrueTypeFont loadTTF(PDDocument doc,
                                     java.io.InputStream stream,
                                     Encoding enc)
                              throws java.io.IOException

This will load a TTF to be embedded into a document.

Parameters:

doc - The PDF document that will hold the embedded font.

stream - a ttf input stream.

enc - The font encoding.

Returns:

a PDTrueTypeFont instance.

Throws:

java.io.IOException - If there is an error loading the data.

loadTTF

public static PDTrueTypeFont loadTTF(PDStream fontStream,
                                     Encoding enc)
                              throws java.io.IOException

This will load a TTF to be embedded into a document.

Parameters:

fontStream - a ttf input stream.

enc - The font encoding.

Returns:

a PDTrueTypeFont instance.

Throws:

java.io.IOException - If there is an error loading the data.

getawtFont

public java.awt.Font getawtFont()
                         throws java.io.IOException

Looks up, creates, returns the AWT Font.

Overrides:

getawtFont in class PDSimpleFont

Returns:

returns the awt font to bes used for rendering

Throws:

java.io.IOException - if something went wrong.

getTTFFont

public org.apache.fontbox.ttf.TrueTypeFont getTTFFont()
                                               throws java.io.IOException

Return the TTF font as TrueTypeFont.

Returns:

the TTF font

Throws:

java.io.IOException - If there is an error loading the data

clear

public void clear()

Description copied from class: PDFont

Calling this will release all cached information.

Overrides:

clear in class PDFont

getFontWidth

public float getFontWidth(int charCode)

Description copied from class: PDFont

Determines the width of the given character.

Overrides:

getFontWidth in class PDFont

Parameters:

charCode - the code of the given character

Returns:

the width of the character