org.apache.pdfbox.pdmodel.font

Class PDCIDFont

java.lang.Object

org.apache.pdfbox.pdmodel.font.PDFont

org.apache.pdfbox.pdmodel.font.PDSimpleFont

org.apache.pdfbox.pdmodel.font.PDCIDFont

All Implemented Interfaces:

COSObjectable

Direct Known Subclasses:

PDCIDFontType0Font, PDCIDFontType2Font

public abstract class PDCIDFont
extends PDSimpleFont

This is implementation for the CIDFontType0/CIDFontType2 Fonts.

Version:

$Revision: 1.11 $

Author:

Ben Litchfield

Field Summary

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

cmap, cmapObjects, font, fontMatrix, resourceRootCMAP, toUnicodeCmap

Constructor Summary

Constructors

Constructor and Description
PDCIDFont() Constructor.
PDCIDFont(COSDictionary fontDictionary) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Calling this will release all cached information.
protected void	determineEncoding() Determines the encoding for the font.
String	encode(byte[] c, int offset, int length) This will perform the encoding of a character if needed.
float	getAverageFontWidth() This will get the average font width for all characters.
long	getDefaultWidth() This will get the default width.
PDRectangle	getFontBoundingBox() This will get the fonts bouding box.
float	getFontHeight(byte[] c, int offset, int length) This will get the font height for a character.
float	getFontWidth(byte[] c, int offset, int length) This will get the font width for a character.
float	getFontWidth(int charCode) Determines the width of the given character.
void	setDefaultWidth(long dw) This will set the default width for the glyphs of this font.

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

drawString, getawtFont, getSpaceWidth, getToUnicode, isFontSubstituted, setIsFontSubstituted, setToUnicode, writeFont

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

clearResources, cmapEncoding, drawString, 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 java.lang.Object

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

Constructor Detail

PDCIDFont

public PDCIDFont()

Constructor.

PDCIDFont

public PDCIDFont(COSDictionary fontDictionary)

Constructor.

Parameters:

fontDictionary - The font dictionary according to the PDF specification.

Method Detail

getFontBoundingBox

public PDRectangle getFontBoundingBox()
                               throws IOException

This will get the fonts bouding box.

Overrides:

getFontBoundingBox in class PDSimpleFont

Returns:

The fonts bouding box.

Throws:

IOException - If there is an error getting the font bounding box.

getDefaultWidth

public long getDefaultWidth()

This will get the default width. The default value for the default width is 1000.

Returns:

The default width for the glyphs in this font.

setDefaultWidth

public void setDefaultWidth(long dw)

This will set the default width for the glyphs of this font.

Parameters:

dw - The default width.

getFontWidth

public float getFontWidth(byte[] c,
                 int offset,
                 int length)
                   throws IOException

This will get the font width for a character.

Overrides:

getFontWidth in class PDSimpleFont

Parameters:

c - The character code to get the width for.

offset - The offset into the array.

length - The length of the data.

Returns:

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

Throws:

IOException - If an error occurs while parsing.

getFontHeight

public float getFontHeight(byte[] c,
                  int offset,
                  int length)
                    throws IOException

This will get the font height for a character.

Overrides:

getFontHeight in class PDSimpleFont

Parameters:

c - The character code to get the height for.

offset - The offset into the array.

length - The length of the data.

Returns:

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

Throws:

IOException - If an error occurs while parsing.

getAverageFontWidth

public float getAverageFontWidth()
                          throws IOException

This will get the average font width for all characters.

Overrides:

getAverageFontWidth in class PDSimpleFont

Returns:

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

Throws:

IOException - If an error occurs while parsing.

getFontWidth

public float getFontWidth(int charCode)

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

determineEncoding

protected void determineEncoding()

Description copied from class: PDSimpleFont

Determines the encoding for the font. This method as to be overwritten, as there are different possibilities to define a mapping.

Overrides:

determineEncoding in class PDSimpleFont

encode

public String encode(byte[] c,
            int offset,
            int length)
              throws IOException

Description copied from class: PDFont

This will perform the encoding of a character if needed.

Overrides:

encode in class PDFont

Parameters:

c - The character to encode.

offset - The offset into the array to get the data

length - The number of bytes to read.

Returns:

The value of the encoded character.

Throws:

IOException - If there is an error during the encoding.

clear

public void clear()

Description copied from class: PDFont

Calling this will release all cached information.

Overrides:

clear in class PDFont