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, PDVectorFont

public class PDType1CFont
extends PDSimpleFont
implements PDVectorFont

Type 1-equivalent CFF font.

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.Float	avgWidth
private CFFType1Font	cffFont
private BoundingBox	fontBBox
private Matrix	fontMatrix
private java.awt.geom.AffineTransform	fontMatrixTransform
private FontBoxFont	genericFont
private java.util.Map<java.lang.String,java.lang.Float>	glyphHeights
private boolean	isDamaged
private boolean	isEmbedded
private static org.apache.commons.logging.Log	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

Constructor	Description
PDType1CFont(COSDictionary fontDictionary)	Constructor.

Method Summary

Modifier and Type	Method	Description
java.lang.String	codeToName(int code)
protected byte[]	encode(int unicode)	Encodes the given Unicode code point for use in a PDF content stream.
private BoundingBox	generateBoundingBox()
private float	getAverageCharacterWidth()
float	getAverageFontWidth()	This will get the average font width for all characters.
java.lang.String	getBaseFont()	Returns the PostScript name of the font.
BoundingBox	getBoundingBox()	Returns the font's bounding box.
CFFType1Font	getCFFType1Font()	Returns the embedded Type 1-equivalent CFF font.
FontBoxFont	getFontBoxFont()	Returns the embedded or system font used for rendering.
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.
java.lang.String	getName()	Returns the name of this font, either the PostScript "BaseName" or the Type 3 "Name".
private java.lang.String	getNameInFont(java.lang.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".
java.awt.geom.GeneralPath	getNormalizedPath(int code)	Returns the normalized glyph path for the given character code in a PDF.
java.awt.geom.GeneralPath	getPath(int code)	Returns the glyph path for the given character code.
java.awt.geom.GeneralPath	getPath(java.lang.String name)	Returns the path for the character with the given name.
float	getStringWidth(java.lang.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	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.
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, isNonZeroBoundingBox, 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

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.apache.commons.logging.Log LOG

glyphHeights

private final java.util.Map<java.lang.String,java.lang.Float> glyphHeights

fontMatrixTransform

private final java.awt.geom.AffineTransform fontMatrixTransform

cffFont

private final CFFType1Font cffFont

genericFont

private final FontBoxFont genericFont

isEmbedded

private final boolean isEmbedded

isDamaged

private final boolean isDamaged

avgWidth

private java.lang.Float avgWidth

fontMatrix

private Matrix fontMatrix

fontBBox

private BoundingBox fontBBox

Constructor Detail

PDType1CFont

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

Constructor.

Parameters:

fontDictionary - the corresponding dictionary

Throws:

java.io.IOException - it something went wrong

Method Detail

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

Returns:

the embedded or system font used for rendering

getBaseFont

public final java.lang.String getBaseFont()

Returns the PostScript name of the font.

Returns:

the PostScript name of the font

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

Parameters:

name - glyph name

Returns:

glyph path of the character with the given name

Throws:

java.io.IOException - if the path could not be read

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 interface PDVectorFont

Parameters:

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

Returns:

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

Throws:

java.io.IOException - if the font could not be read

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.

Specified by:

getPath in interface PDVectorFont

Parameters:

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

Returns:

the glyph path for the given character code

Throws:

java.io.IOException - if the font could not be read

getNormalizedPath

public java.awt.geom.GeneralPath getNormalizedPath(int code)
                                            throws java.io.IOException

Description copied from interface: PDVectorFont

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.

Specified by:

getNormalizedPath in interface PDVectorFont

Parameters:

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

Returns:

the normalized glyph path for the given character code

Throws:

java.io.IOException - if the font 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 class PDSimpleFont

Parameters:

name - glyph name

Returns:

true if the font contains the character with the given name

Throws:

java.io.IOException - if the path could not be read

getName

public final 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 interface PDFontLike

Returns:

the name of the font

getBoundingBox

public BoundingBox getBoundingBox()
                           throws java.io.IOException

Description copied from interface: PDFontLike

Returns the font's bounding box.

Specified by:

getBoundingBox in interface PDFontLike

Returns:

the bounding box

Throws:

java.io.IOException - if the bounding box could not be read

generateBoundingBox

private BoundingBox generateBoundingBox()
                                 throws java.io.IOException

Throws:

java.io.IOException

codeToName

public java.lang.String codeToName(int code)

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

Returns:

encoding of the font

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.

Specified by:

readCode in class PDFont

Parameters:

in - string stream

Returns:

character code

Throws:

java.io.IOException - if the CMap or stream cannot be read

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

Overrides:

getFontMatrix in class PDFont

Returns:

the font matrix

isDamaged

public boolean isDamaged()

Description copied from interface: PDFontLike

Returns true if the embedded font file is damaged.

Specified by:

isDamaged in interface PDFontLike

Returns:

true if the embedded font file is damaged

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 interface PDFontLike

Parameters:

code - character code

Returns:

width in glyph space

Throws:

java.io.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

Returns:

true if the font file is embedded in the PDF

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 interface PDFontLike

Parameters:

code - character code

Returns:

the height of the given character

Throws:

java.io.IOException - if the height could not be read

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.

Specified by:

encode in class PDFont

Parameters:

unicode - Unicode code point.

Returns:

Array of 1 to 4 PDF content stream bytes.

Throws:

java.io.IOException - If the text could not be encoded.

getStringWidth

public float getStringWidth(java.lang.String string)
                     throws java.io.IOException

Description copied from class: PDFont

Returns the width of the given Unicode string.

Overrides:

getStringWidth in class PDFont

Parameters:

string - The text to get the width of.

Returns:

The width of the string in 1/1000 units of text space.

Throws:

java.io.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 interface PDFontLike

Overrides:

getAverageFontWidth in class PDFont

Returns:

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

getCFFType1Font

public CFFType1Font getCFFType1Font()

Returns the embedded Type 1-equivalent CFF font.

Returns:

the cffFont

getAverageCharacterWidth

private float getAverageCharacterWidth()

getNameInFont

private java.lang.String getNameInFont(java.lang.String name)
                                throws java.io.IOException

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:

java.io.IOException