Package com.tom_roush.pdfbox.pdmodel.font

Class PDCIDFontType0

java.lang.Object

com.tom_roush.pdfbox.pdmodel.font.PDCIDFont

com.tom_roush.pdfbox.pdmodel.font.PDCIDFontType0

All Implemented Interfaces:

COSObjectable, PDFontLike, PDVectorFont

public class PDCIDFontType0
extends PDCIDFont

Type 0 CIDFont (CFF).

Field Summary

Fields inherited from class com.tom_roush.pdfbox.pdmodel.font.PDCIDFont

dict, parent

Constructor Summary

Constructors

Constructor	Description
PDCIDFontType0(COSDictionary fontDictionary, PDType0Font parent)	Constructor.

Method Summary

Modifier and Type	Method	Description
int	codeToCID(int code)	Returns the CID for the given character code.
int	codeToGID(int code)	Returns the GID for the given character code.
byte[]	encode(int unicode)	Encodes the given Unicode code point for use in a PDF content stream.
float	getAverageFontWidth()	This will get the average font width for all characters.
BoundingBox	getBoundingBox()	Returns the font's bounding box.
CFFFont	getCFFFont()	Returns the embedded CFF CIDFont, or null if the substitute is not a CFF font.
FontBoxFont	getFontBoxFont()	Returns the embedded or substituted font.
Matrix	getFontMatrix()	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.
android.graphics.Path	getPath(int code)	Returns the glyph path for the given character code.
Type2CharString	getType2CharString(int cid)	Returns the Type 2 charstring for the given CID, or null if the substituted font does not contain Type 2 charstrings.
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.
boolean	isDamaged()	Returns true if the embedded font file is damaged.
boolean	isEmbedded()	Returns true if the font file is embedded in the PDF.

Methods inherited from class java.lang.Object

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

Methods inherited from class com.tom_roush.pdfbox.pdmodel.font.PDCIDFont

getBaseFont, getCIDSystemInfo, getCOSObject, getFontDescriptor, getName, getParent, getPositionVector, getVerticalDisplacementVectorY, getWidth

Constructor Detail

PDCIDFontType0

public PDCIDFontType0(COSDictionary fontDictionary,
                      PDType0Font parent)
               throws IOException

Constructor.

Parameters:

fontDictionary - The font dictionary according to the PDF specification.

parent - The parent font.

Throws:

IOException

Method Detail

getFontMatrix

public final Matrix getFontMatrix()

Description copied from interface: PDFontLike

Returns the font matrix, which represents the transformation from glyph space to text space.

Specified by:

getFontMatrix in interface PDFontLike

Specified by:

getFontMatrix in class PDCIDFont

getBoundingBox

public BoundingBox getBoundingBox()

Description copied from interface: PDFontLike

Returns the font's bounding box.

Specified by:

getBoundingBox in interface PDFontLike

Specified by:

getBoundingBox in class PDCIDFont

getCFFFont

public CFFFont getCFFFont()

Returns the embedded CFF CIDFont, or null if the substitute is not a CFF font.

getFontBoxFont

public FontBoxFont getFontBoxFont()

Returns the embedded or substituted font.

getType2CharString

public Type2CharString getType2CharString(int cid)
                                   throws IOException

Returns the Type 2 charstring for the given CID, or null if the substituted font does not contain Type 2 charstrings.

Parameters:

cid - CID

Throws:

IOException - if the charstring could not be read

getPath

public android.graphics.Path getPath(int code)
                              throws IOException

Description copied from interface: PDVectorFont

Returns the glyph path for the given character code.

Parameters:

code - character code

Throws:

IOException - if the font could not be read

hasGlyph

public boolean hasGlyph(int code)
                 throws IOException

Description copied from interface: PDVectorFont

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

Parameters:

code - character code

Throws:

IOException

codeToCID

public int codeToCID(int code)

Returns the CID for the given character code. If not found then CID 0 is returned.

Specified by:

codeToCID in class PDCIDFont

Parameters:

code - character code

Returns:

CID

codeToGID

public int codeToGID(int code)

Description copied from class: PDCIDFont

Returns the GID for the given character code.

Specified by:

codeToGID in class PDCIDFont

Parameters:

code - character code

Returns:

GID

encode

public byte[] encode(int unicode)

Description copied from class: PDCIDFont

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 class PDCIDFont

Parameters:

unicode - Unicode code point.

Returns:

Array of 1 to 4 PDF content stream bytes.

getWidthFromFont

public float getWidthFromFont(int code)
                       throws IOException

Description copied from interface: PDFontLike

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

Specified by:

getWidthFromFont in interface PDFontLike

Specified by:

getWidthFromFont in class PDCIDFont

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.

Specified by:

isEmbedded in interface PDFontLike

Specified by:

isEmbedded in class PDCIDFont

isDamaged

public boolean isDamaged()

Description copied from interface: PDFontLike

Returns true if the embedded font file is damaged.

getHeight

public float getHeight(int code)
                throws 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.

Specified by:

getHeight in interface PDFontLike

Specified by:

getHeight in class PDCIDFont

Parameters:

code - character code

Throws:

IOException

getAverageFontWidth

public float getAverageFontWidth()

Description copied from interface: PDFontLike

This will get the average font width for all characters.

Specified by:

getAverageFontWidth in interface PDFontLike

Overrides:

getAverageFontWidth in class PDCIDFont

Returns:

The width is in 1000 unit of text space, ie 333 or 777