Apache PDFBox 3.0.4 · org.apache.pdfbox.pdmodel.font.PDTrueTypeFont

Modifier and Type	Field and Description
private boolean	cmapInitialized
private CmapSubtable	cmapMacRoman
private CmapSubtable	cmapWinSymbol
private CmapSubtable	cmapWinUnicode
private BoundingBox	fontBBox
private Map<Integer, Integer>	gidToCode
private static final Map<String, Integer>	INVERTED_MACOS_ROMAN
private final boolean	isDamaged
private final boolean	isEmbedded
private static final Log	LOG Hides org.apache.pdfbox.pdmodel.font.PDSimpleFont.LOG.
private final OpenTypeFont	otf
private static final int	START_RANGE_F000
private static final int	START_RANGE_F100
private static final int	START_RANGE_F200
private final TrueTypeFont	ttf

Access	Constructor and Description
public	PDTrueTypeFont(COSDictionary The font dictionary according to the PDF specification. 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

Modifier and Type	Method and Description
public int	Returns: GID (glyph index) codeToGID(int character code code) Returns the GID for the given character code.
protected byte[]	encode(int Unicode code point. unicode) Implements abstract org.apache.pdfbox.pdmodel.font.PDFont.encode. Encodes the given Unicode code point for use in a PDF content stream.
private void	extractCmapTable() extract all useful "cmap" subtables.
private BoundingBox	generateBoundingBox()
public final String	Returns: the PostScript name of the font getBaseFont() Returns the PostScript name of the font.
public BoundingBox	getBoundingBox() Implements org.apache.pdfbox.pdmodel.font.PDFontLike.getBoundingBox. Returns the font's bounding box.
public FontBoxFont	getFontBoxFont() Implements abstract org.apache.pdfbox.pdmodel.font.PDSimpleFont.getFontBoxFont. Returns the embedded or system font used for rendering.
protected Map<Integer, Integer>	Returns: the GID for the given code getGIDToCode() Inverts the font's code -> GID mapping.
public float	getHeight(int character code code) Implements org.apache.pdfbox.pdmodel.font.PDFontLike.getHeight. Returns the height of the given character, in glyph space.
public String	getName() Implements org.apache.pdfbox.pdmodel.font.PDFontLike.getName. Returns the name of this font, either the PostScript "BaseName" or the Type 3 "Name".
public GeneralPath	getNormalizedPath(int character code in a PDF. Not to be confused with unicode. code) Implements org.apache.pdfbox.pdmodel.font.PDVectorFont.getNormalizedPath. Returns the normalized glyph path for the given character code in a PDF.
private TTFParser	getParser(RandomAccessRead randomAccessRead, boolean isEmbedded)
public GeneralPath	getPath(int character code in a PDF. Not to be confused with unicode. code) Implements org.apache.pdfbox.pdmodel.font.PDVectorFont.getPath. Returns the glyph path for the given character code.
public GeneralPath	getPath(String glyph name name) Implements abstract org.apache.pdfbox.pdmodel.font.PDSimpleFont.getPath. Returns the path for the character with the given name.
private GeneralPath	getPathFromOutlines(int code)
public TrueTypeFont	Returns: the embedded or substituted TrueType font getTrueTypeFont() Returns the embedded or substituted TrueType font.
public float	getWidthFromFont(int character code code) Implements org.apache.pdfbox.pdmodel.font.PDFontLike.getWidthFromFont. Returns the width of a glyph in the embedded font file.
public boolean	hasGlyph(String glyph name name) Implements abstract org.apache.pdfbox.pdmodel.font.PDSimpleFont.hasGlyph. Returns true if the font contains the character with the given name.
public boolean	hasGlyph(int character code in a PDF. Not to be confused with unicode. code) Implements org.apache.pdfbox.pdmodel.font.PDVectorFont.hasGlyph. Returns true if this font contains a glyph for the given character code in a PDF.
public boolean	isDamaged() Implements org.apache.pdfbox.pdmodel.font.PDFontLike.isDamaged. Returns true if the embedded font file is damaged.
public boolean	isEmbedded() Implements org.apache.pdfbox.pdmodel.font.PDFontLike.isEmbedded. Returns true if the font file is embedded in the PDF.
public static PDTrueTypeFont	Returns: a PDTrueTypeFont instance. load(PDDocument The PDF document that will hold the embedded font. doc, File A TTF file. file, Encoding The PostScript encoding vector to be used for embedding. encoding) Loads a TTF to be embedded into a document as a simple font.
public static PDTrueTypeFont	Returns: a PDTrueTypeFont instance. load(PDDocument The PDF document that will hold the embedded font. doc, InputStream A TTF file stream input, Encoding The PostScript encoding vector to be used for embedding. encoding) Loads a TTF to be embedded into a document as a simple font.
public static PDTrueTypeFont	Returns: a PDTrueTypeFont instance. load(PDDocument The PDF document that will hold the embedded font. doc, TrueTypeFont A true type font ttf, Encoding The PostScript encoding vector to be used for embedding. encoding) Loads a TTF to be embedded into a document as a simple font.
public static PDTrueTypeFont	Returns: a PDTrueTypeFont instance. load(PDDocument The PDF document that will hold the embedded font. doc, RandomAccessRead the source of the TTF. randomAccessRead, Encoding The PostScript encoding vector to be used for embedding. encoding) Loads a TTF to be embedded into a document as a simple font.
public int	readCode(InputStream string stream in) Implements abstract org.apache.pdfbox.pdmodel.font.PDFont.readCode. Reads a character code from a content stream string.
protected Encoding	readEncodingFromFont() Implements abstract org.apache.pdfbox.pdmodel.font.PDSimpleFont.readEncodingFromFont. Called by readEncoding() if the encoding needs to be extracted from the font file.

Inherited from org.apache.pdfbox.pdmodel.font.PDSimpleFont:: addToSubset getEncoding getGlyphList getStandard14Width getSymbolicFlag hasExplicitWidth isFontSymbolic isNonZeroBoundingBox isStandard14 isSymbolic isVertical readEncoding subset toUnicode toUnicode willBeSubset

cmapInitialized	back to summary
private boolean cmapInitialized

cmapMacRoman	back to summary
private CmapSubtable cmapMacRoman

cmapWinSymbol	back to summary
private CmapSubtable cmapWinSymbol

cmapWinUnicode	back to summary
private CmapSubtable cmapWinUnicode

fontBBox	back to summary
private BoundingBox fontBBox

gidToCode	back to summary
private Map<Integer, Integer> gidToCode

INVERTED_MACOS_ROMAN	back to summary
private static final Map<String, Integer> INVERTED_MACOS_ROMAN

isDamaged	back to summary
private final boolean isDamaged

isEmbedded	back to summary
private final boolean isEmbedded

LOG	back to summary
private static final Log LOG Hides org.apache.pdfbox.pdmodel.font.PDSimpleFont.LOG.

otf	back to summary
private final OpenTypeFont otf

START_RANGE_F000	back to summary
private static final int START_RANGE_F000

START_RANGE_F100	back to summary
private static final int START_RANGE_F100

START_RANGE_F200	back to summary
private static final int START_RANGE_F200

ttf	back to summary
private final TrueTypeFont ttf

PDTrueTypeFont	back to summary
public PDTrueTypeFont(COSDictionary fontDictionary) throws IOException Creates a new TrueType font from a Font dictionary. Parameters fontDictionary:COSDictionary The font dictionary according to the PDF specification. Exceptions IOException: if the font could not be created

PDTrueTypeFont	back to summary
private PDTrueTypeFont(PDDocument document, TrueTypeFont ttf, Encoding encoding, boolean closeTTF) throws IOException Creates a new TrueType font for embedding.

Method Detail

codeToGID	back to summary
public int codeToGID(int code) throws IOException Returns the GID for the given character code. Parameters code:int character code Returns:int GID (glyph index) Exceptions IOException: if the data could not be read

codeToGID

back to summary

public int codeToGID(int code) throws IOException

Returns the GID for the given character code.

Parameters

code:int: character code

Returns:int

GID (glyph index)

Exceptions

IOException:: if the data could not be read

encode	back to summary
protected byte[] encode(int unicode) throws IOException Implements abstract org.apache.pdfbox.pdmodel.font.PDFont.encode. Doc from org.apache.pdfbox.pdmodel.font.PDFont.encode. 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. Parameters unicode:int Unicode code point. Returns:byte[] Array of 1 to 4 PDF content stream bytes. Annotations @Override Exceptions IOException: If the text could not be encoded.

encode

back to summary

protected byte[] encode(int unicode) throws IOException

Implements abstract org.apache.pdfbox.pdmodel.font.PDFont.encode.

Doc from org.apache.pdfbox.pdmodel.font.PDFont.encode.

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.

Parameters

unicode:int: Unicode code point.

Returns:byte[]

Array of 1 to 4 PDF content stream bytes.

Annotations

@Override

Exceptions

IOException:: If the text could not be encoded.

extractCmapTable	back to summary
private void extractCmapTable() throws IOException extract all useful "cmap" subtables.

generateBoundingBox	back to summary
private BoundingBox generateBoundingBox() throws IOException

getBaseFont	back to summary
public final String getBaseFont() Returns the PostScript name of the font. Returns:String the PostScript name of the font

getBaseFont

back to summary

public final String getBaseFont()

Returns the PostScript name of the font.

Returns:String: the PostScript name of the font

getBoundingBox	back to summary
public BoundingBox getBoundingBox() throws IOException Implements org.apache.pdfbox.pdmodel.font.PDFontLike.getBoundingBox. Doc from org.apache.pdfbox.pdmodel.font.PDFontLike.getBoundingBox. Returns the font's bounding box. Returns:BoundingBox the bounding box Annotations @Override Exceptions IOException: if the bounding box could not be read

getBoundingBox

back to summary

public BoundingBox getBoundingBox() throws IOException

Implements org.apache.pdfbox.pdmodel.font.PDFontLike.getBoundingBox.

Doc from org.apache.pdfbox.pdmodel.font.PDFontLike.getBoundingBox.

Returns the font's bounding box.

Returns:BoundingBox

the bounding box

Annotations

@Override

Exceptions

IOException:: if the bounding box could not be read

getFontBoxFont	back to summary
public FontBoxFont getFontBoxFont() Implements abstract org.apache.pdfbox.pdmodel.font.PDSimpleFont.getFontBoxFont. Doc from org.apache.pdfbox.pdmodel.font.PDSimpleFont.getFontBoxFont. Returns the embedded or system font used for rendering. This is never null. Returns:FontBoxFont the embedded or system font used for rendering Annotations @Override

getFontBoxFont

back to summary

public FontBoxFont getFontBoxFont()

Implements abstract org.apache.pdfbox.pdmodel.font.PDSimpleFont.getFontBoxFont.

Doc from org.apache.pdfbox.pdmodel.font.PDSimpleFont.getFontBoxFont.

Returns the embedded or system font used for rendering. This is never null.

Returns:FontBoxFont

the embedded or system font used for rendering

Annotations

@Override

getGIDToCode	back to summary
protected Map<Integer, Integer> getGIDToCode() throws IOException Inverts the font's code -> GID mapping. Any duplicate (GID -> code) mappings will be lost. Returns:Map<Integer, Integer> the GID for the given code Exceptions IOException: if the data could not be read

getGIDToCode

back to summary

protected Map<Integer, Integer> getGIDToCode() throws IOException

Inverts the font's code -> GID mapping. Any duplicate (GID -> code) mappings will be lost.

Returns:Map<Integer, Integer>

the GID for the given code

Exceptions

IOException:: if the data could not be read

getHeight back to summary

getHeight	back to summary
public float getHeight(int code) throws IOException Implements org.apache.pdfbox.pdmodel.font.PDFontLike.getHeight. Doc from org.apache.pdfbox.pdmodel.font.PDFontLike.getHeight. 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 `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:int character code Returns:float the height of the given character Annotations @Override Exceptions IOException: if the height could not be read

public float getHeight(int code) throws IOException

Implements org.apache.pdfbox.pdmodel.font.PDFontLike.getHeight.

Doc from org.apache.pdfbox.pdmodel.font.PDFontLike.getHeight.

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 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:int: character code

Returns:float

the height of the given character

Annotations

@Override

Exceptions

IOException:: if the height could not be read

getName	back to summary
public String getName() Implements org.apache.pdfbox.pdmodel.font.PDFontLike.getName. Doc from org.apache.pdfbox.pdmodel.font.PDFontLike.getName. Returns the name of this font, either the PostScript "BaseName" or the Type 3 "Name". Returns:String the name of the font Annotations @Override

getName

back to summary

public String getName()

Implements org.apache.pdfbox.pdmodel.font.PDFontLike.getName.

Doc from org.apache.pdfbox.pdmodel.font.PDFontLike.getName.

Returns the name of this font, either the PostScript "BaseName" or the Type 3 "Name".

Returns:String

the name of the font

Annotations

@Override

getNormalizedPath	back to summary
public GeneralPath getNormalizedPath(int code) throws IOException Implements org.apache.pdfbox.pdmodel.font.PDVectorFont.getNormalizedPath. Doc from org.apache.pdfbox.pdmodel.font.PDVectorFont.getNormalizedPath. Returns the normalized glyph path for the given character code in a PDF. The resulting path is normalized to the PostScript 1000 unit square, and fallback glyphs are returned where appropriate, e.g. for missing glyphs. Parameters code:int character code in a PDF. Not to be confused with unicode. Returns:GeneralPath the normalized glyph path for the given character code Annotations @Override Exceptions IOException: if the font could not be read

getNormalizedPath

back to summary

public GeneralPath getNormalizedPath(int code) throws IOException

Implements org.apache.pdfbox.pdmodel.font.PDVectorFont.getNormalizedPath.

Doc from org.apache.pdfbox.pdmodel.font.PDVectorFont.getNormalizedPath.

Returns the normalized glyph path for the given character code in a PDF. The resulting path is normalized to the PostScript 1000 unit square, and fallback glyphs are returned where appropriate, e.g. for missing glyphs.

Parameters

code:int: character code in a PDF. Not to be confused with unicode.

Returns:GeneralPath

the normalized glyph path for the given character code

Annotations

@Override

Exceptions

IOException:: if the font could not be read

getParser	back to summary
private TTFParser getParser(RandomAccessRead randomAccessRead, boolean isEmbedded) throws IOException

getPath	back to summary
public GeneralPath getPath(int code) throws IOException Implements org.apache.pdfbox.pdmodel.font.PDVectorFont.getPath. Doc from org.apache.pdfbox.pdmodel.font.PDVectorFont.getPath. Returns the glyph path for the given character code. Parameters code:int character code in a PDF. Not to be confused with unicode. Returns:GeneralPath the glyph path for the given character code Annotations @Override Exceptions IOException: if the font could not be read

getPath

back to summary

public GeneralPath getPath(int code) throws IOException

Implements org.apache.pdfbox.pdmodel.font.PDVectorFont.getPath.

Doc from org.apache.pdfbox.pdmodel.font.PDVectorFont.getPath.

Returns the glyph path for the given character code.

Parameters

code:int: character code in a PDF. Not to be confused with unicode.

Returns:GeneralPath

the glyph path for the given character code

Annotations

@Override

Exceptions

IOException:: if the font could not be read

getPath	back to summary
public GeneralPath getPath(String name) throws IOException Implements abstract org.apache.pdfbox.pdmodel.font.PDSimpleFont.getPath. Doc from org.apache.pdfbox.pdmodel.font.PDSimpleFont.getPath. Returns the path for the character with the given name. For some fonts, GIDs may be used instead of names when calling this method. * Parameters name:String glyph name Returns:GeneralPath glyph path of the character with the given name Annotations @Override Exceptions IOException: if the path could not be read

getPath

back to summary

public GeneralPath getPath(String name) throws IOException

Implements abstract org.apache.pdfbox.pdmodel.font.PDSimpleFont.getPath.

Doc from org.apache.pdfbox.pdmodel.font.PDSimpleFont.getPath.

Returns the path for the character with the given name. For some fonts, GIDs may be used instead of names when calling this method. *

Parameters

name:String: glyph name

Returns:GeneralPath

glyph path of the character with the given name

Annotations

@Override

Exceptions

IOException:: if the path could not be read

getPathFromOutlines	back to summary
private GeneralPath getPathFromOutlines(int code) throws IOException

getTrueTypeFont	back to summary
public TrueTypeFont getTrueTypeFont() Returns the embedded or substituted TrueType font. Returns:TrueTypeFont the embedded or substituted TrueType font

getTrueTypeFont

back to summary

public TrueTypeFont getTrueTypeFont()

Returns the embedded or substituted TrueType font.

Returns:TrueTypeFont: the embedded or substituted TrueType font

getWidthFromFont	back to summary
public float getWidthFromFont(int code) throws IOException Implements org.apache.pdfbox.pdmodel.font.PDFontLike.getWidthFromFont. Doc from org.apache.pdfbox.pdmodel.font.PDFontLike.getWidthFromFont. Returns the width of a glyph in the embedded font file. Parameters code:int character code Returns:float width in glyph space Annotations @Override Exceptions IOException: if the font could not be read

getWidthFromFont

back to summary

public float getWidthFromFont(int code) throws IOException

Implements org.apache.pdfbox.pdmodel.font.PDFontLike.getWidthFromFont.

Doc from org.apache.pdfbox.pdmodel.font.PDFontLike.getWidthFromFont.

Returns the width of a glyph in the embedded font file.

Parameters

code:int: character code

Returns:float

width in glyph space

Annotations

@Override

Exceptions

IOException:: if the font could not be read

hasGlyph	back to summary
public boolean hasGlyph(String name) throws IOException Implements abstract org.apache.pdfbox.pdmodel.font.PDSimpleFont.hasGlyph. Doc from org.apache.pdfbox.pdmodel.font.PDSimpleFont.hasGlyph. Returns true if the font contains the character with the given name. Parameters name:String glyph name Returns:boolean true if the font contains the character with the given name Annotations @Override Exceptions IOException: if the path could not be read

hasGlyph

back to summary

public boolean hasGlyph(String name) throws IOException

Implements abstract org.apache.pdfbox.pdmodel.font.PDSimpleFont.hasGlyph.

Doc from org.apache.pdfbox.pdmodel.font.PDSimpleFont.hasGlyph.

Returns true if the font contains the character with the given name.

Parameters

name:String: glyph name

Returns:boolean

true if the font contains the character with the given name

Annotations

@Override

Exceptions

IOException:: if the path could not be read

hasGlyph	back to summary
public boolean hasGlyph(int code) throws IOException Implements org.apache.pdfbox.pdmodel.font.PDVectorFont.hasGlyph. Doc from org.apache.pdfbox.pdmodel.font.PDVectorFont.hasGlyph. Returns true if this font contains a glyph for the given character code in a PDF. Parameters code:int character code in a PDF. Not to be confused with unicode. Returns:boolean true if this font contains a glyph for the given character code Annotations @Override Exceptions IOException: if the font could not be read

hasGlyph

back to summary

public boolean hasGlyph(int code) throws IOException

Implements org.apache.pdfbox.pdmodel.font.PDVectorFont.hasGlyph.

Doc from org.apache.pdfbox.pdmodel.font.PDVectorFont.hasGlyph.

Returns true if this font contains a glyph for the given character code in a PDF.

Parameters

code:int: character code in a PDF. Not to be confused with unicode.

Returns:boolean

true if this font contains a glyph for the given character code

Annotations

@Override

Exceptions

IOException:: if the font could not be read

isDamaged	back to summary
public boolean isDamaged() Implements org.apache.pdfbox.pdmodel.font.PDFontLike.isDamaged. Doc from org.apache.pdfbox.pdmodel.font.PDFontLike.isDamaged. Returns true if the embedded font file is damaged. Returns:boolean true if the embedded font file is damaged Annotations @Override

isDamaged

back to summary

public boolean isDamaged()

Implements org.apache.pdfbox.pdmodel.font.PDFontLike.isDamaged.

Doc from org.apache.pdfbox.pdmodel.font.PDFontLike.isDamaged.

Returns true if the embedded font file is damaged.

Returns:boolean

true if the embedded font file is damaged

Annotations

@Override

isEmbedded	back to summary
public boolean isEmbedded() Implements org.apache.pdfbox.pdmodel.font.PDFontLike.isEmbedded. Doc from org.apache.pdfbox.pdmodel.font.PDFontLike.isEmbedded. Returns true if the font file is embedded in the PDF. Returns:boolean true if the font file is embedded in the PDF Annotations @Override

isEmbedded

back to summary

public boolean isEmbedded()

Implements org.apache.pdfbox.pdmodel.font.PDFontLike.isEmbedded.

Doc from org.apache.pdfbox.pdmodel.font.PDFontLike.isEmbedded.

Returns true if the font file is embedded in the PDF.

Returns:boolean

true if the font file is embedded in the PDF

Annotations

@Override

load back to summary

load	back to summary
public static PDTrueTypeFont load(PDDocument doc, File file, Encoding encoding) throws 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:PDDocument The PDF document that will hold the embedded font. file:File A TTF file. encoding:Encoding The PostScript encoding vector to be used for embedding. Returns:PDTrueTypeFont a PDTrueTypeFont instance. Exceptions IOException: If there is an error loading the data.

public static PDTrueTypeFont load(PDDocument doc, File file, Encoding encoding) throws 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:PDDocument: The PDF document that will hold the embedded font.
file:File: A TTF file.
encoding:Encoding: The PostScript encoding vector to be used for embedding.

Returns:PDTrueTypeFont

a PDTrueTypeFont instance.

Exceptions

IOException:: If there is an error loading the data.

load back to summary

load	back to summary
public static PDTrueTypeFont load(PDDocument doc, InputStream input, Encoding encoding) throws 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:PDDocument The PDF document that will hold the embedded font. input:InputStream A TTF file stream encoding:Encoding The PostScript encoding vector to be used for embedding. Returns:PDTrueTypeFont a PDTrueTypeFont instance. Exceptions IOException: If there is an error loading the data.

public static PDTrueTypeFont load(PDDocument doc, InputStream input, Encoding encoding) throws 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:PDDocument: The PDF document that will hold the embedded font.
input:InputStream: A TTF file stream
encoding:Encoding: The PostScript encoding vector to be used for embedding.

Returns:PDTrueTypeFont

a PDTrueTypeFont instance.

Exceptions

IOException:: If there is an error loading the data.

load back to summary

load	back to summary
public static PDTrueTypeFont load(PDDocument doc, TrueTypeFont ttf, Encoding encoding) throws 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:PDDocument The PDF document that will hold the embedded font. ttf:TrueTypeFont A true type font encoding:Encoding The PostScript encoding vector to be used for embedding. Returns:PDTrueTypeFont a PDTrueTypeFont instance. Exceptions IOException: If there is an error loading the data.

public static PDTrueTypeFont load(PDDocument doc, TrueTypeFont ttf, Encoding encoding) throws 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:PDDocument: The PDF document that will hold the embedded font.
ttf:TrueTypeFont: A true type font
encoding:Encoding: The PostScript encoding vector to be used for embedding.

Returns:PDTrueTypeFont

a PDTrueTypeFont instance.

Exceptions

IOException:: If there is an error loading the data.

load back to summary

load	back to summary
public static PDTrueTypeFont load(PDDocument doc, RandomAccessRead randomAccessRead, Encoding encoding) throws 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:PDDocument The PDF document that will hold the embedded font. randomAccessRead:RandomAccessRead the source of the TTF. encoding:Encoding The PostScript encoding vector to be used for embedding. Returns:PDTrueTypeFont a PDTrueTypeFont instance. Exceptions IOException: If there is an error loading the data.

public static PDTrueTypeFont load(PDDocument doc, RandomAccessRead randomAccessRead, Encoding encoding) throws 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:PDDocument: The PDF document that will hold the embedded font.
randomAccessRead:RandomAccessRead: the source of the TTF.
encoding:Encoding: The PostScript encoding vector to be used for embedding.

Returns:PDTrueTypeFont

a PDTrueTypeFont instance.

Exceptions

IOException:: If there is an error loading the data.

readCode	back to summary
public int readCode(InputStream in) throws IOException Implements abstract org.apache.pdfbox.pdmodel.font.PDFont.readCode. Doc from org.apache.pdfbox.pdmodel.font.PDFont.readCode. Reads a character code from a content stream string. Codes may be up to 4 bytes long. Parameters in:InputStream string stream Returns:int character code Annotations @Override Exceptions IOException: if the CMap or stream cannot be read

readCode

back to summary

public int readCode(InputStream in) throws IOException

Implements abstract org.apache.pdfbox.pdmodel.font.PDFont.readCode.

Doc from org.apache.pdfbox.pdmodel.font.PDFont.readCode.

Reads a character code from a content stream string. Codes may be up to 4 bytes long.

Parameters

in:InputStream: string stream

Returns:int

character code

Annotations

@Override

Exceptions

IOException:: if the CMap or stream cannot be read

readEncodingFromFont	back to summary
protected Encoding readEncodingFromFont() throws IOException Implements abstract org.apache.pdfbox.pdmodel.font.PDSimpleFont.readEncodingFromFont. Doc from org.apache.pdfbox.pdmodel.font.PDSimpleFont.readEncodingFromFont. Called by readEncoding() if the encoding needs to be extracted from the font file. Returns:Encoding encoding of the font Annotations @Override Exceptions IOException: if the font file could not be read.

readEncodingFromFont

back to summary

protected Encoding readEncodingFromFont() throws IOException

Implements abstract org.apache.pdfbox.pdmodel.font.PDSimpleFont.readEncodingFromFont.

Doc from org.apache.pdfbox.pdmodel.font.PDSimpleFont.readEncodingFromFont.

Called by readEncoding() if the encoding needs to be extracted from the font file.

Returns:Encoding

encoding of the font

Annotations

@Override

Exceptions

IOException:: if the font file could not be read.

public Class PDTrueTypeFont

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail