com.itextpdf.kernel.font

Class PdfFont

java.lang.Object

com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfDictionary>

com.itextpdf.kernel.font.PdfFont

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

PdfSimpleFont, PdfType0Font

public abstract class PdfFont
extends PdfObjectWrapper<PdfDictionary>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	embedded true if the font is to be embedded in the PDF.
protected static byte[]	emptyBytes
protected FontProgram	fontProgram
protected boolean	newFont false, if the font comes from PdfDocument.
protected Map<Integer,Glyph>	notdefGlyphs
protected boolean	subset Indicates if all the glyphs and widths for that particular encoding should be included in the document.
protected List<int[]>	subsetRanges

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PdfFont()
protected	PdfFont(PdfDictionary fontDictionary)

Method Summary

Modifier and Type	Method and Description
void	addSubsetRange(int[] range) Adds a character range when subsetting.
protected boolean	checkFontDictionary(PdfDictionary fontDic, PdfName fontType)
protected boolean	checkTrueTypeFontDictionary(PdfDictionary fontDic)
protected boolean	checkTrueTypeFontDictionary(PdfDictionary fontDic, boolean isException)
protected static int[]	compactRanges(List<int[]> ranges)
boolean	containsGlyph(char unicode)
abstract byte[]	convertToBytes(Glyph glyph)
abstract byte[]	convertToBytes(GlyphLine glyphLine)
abstract byte[]	convertToBytes(String text) Converts the text into bytes to be placed in the document.
abstract GlyphLine	createGlyphLine(String content)
protected static String	createSubsetPrefix() Creates a unique subset prefix to be added to the font name when the font is embedded and subset.
abstract String	decode(PdfString content)
int	getAscent(int unicode, float fontSize) Gets the ascent of a char code in normalized 1000 units.
int	getAscent(String text, float fontSize) Gets the ascent of a String in points.
abstract float	getContentWidth(PdfString content)
int	getDescent(int unicode, float fontSize) Gets the descent of a char code in points.
int	getDescent(String text, float fontSize) Gets the descent of a String in points.
protected abstract PdfDictionary	getFontDescriptor(String fontName)
double[]	getFontMatrix()
FontProgram	getFontProgram()
abstract Glyph	getGlyph(int unicode)
protected PdfStream	getPdfFontStream(byte[] fontStreamBytes, int[] fontStreamLengths) Create PdfStream based on fontStreamBytes.
int	getWidth(int unicode) Returns the width of a certain character of this font in 1000 normalized units.
float	getWidth(int unicode, float fontSize) Returns the width of a certain character of this font in points.
int	getWidth(String text) Returns the width of a string of this font in 1000 normalized units.
float	getWidth(String text, float fontSize) Gets the width of a String in points.
boolean	isEmbedded()
boolean	isSubset() Indicates if all the glyphs and widths for that particular encoding should be included in the document.
protected boolean	isWrappedObjectMustBeIndirect() Defines if the object behind this wrapper must be an indirect object in the resultant document.
void	setSubset(boolean subset) Indicates if all the glyphs and widths for that particular encoding should be included in the document.
List<String>	splitString(String text, int fontSize, float maxWidth)
abstract void	writeText(GlyphLine text, int from, int to, PdfOutputStream stream)
void	writeText(GlyphLine text, PdfOutputStream stream)
abstract void	writeText(String text, PdfOutputStream stream)

Methods inherited from class com.itextpdf.kernel.pdf.PdfObjectWrapper

ensureObjectIsAddedToDocument, flush, getPdfObject, isFlushed, makeIndirect, makeIndirect, markObjectAsIndirect, setForbidRelease, setModified, setPdfObject, unsetForbidRelease

Methods inherited from class java.lang.Object

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

Field Detail

fontProgram

protected FontProgram fontProgram

emptyBytes

protected static final byte[] emptyBytes

notdefGlyphs

protected Map<Integer,Glyph> notdefGlyphs

newFont

protected boolean newFont

false, if the font comes from PdfDocument.

embedded

protected boolean embedded

true if the font is to be embedded in the PDF.

subset

protected boolean subset

Indicates if all the glyphs and widths for that particular encoding should be included in the document.

subsetRanges

protected List<int[]> subsetRanges

Constructor Detail

PdfFont

protected PdfFont(PdfDictionary fontDictionary)

PdfFont

protected PdfFont()

Method Detail

getGlyph

public abstract Glyph getGlyph(int unicode)

containsGlyph

public boolean containsGlyph(char unicode)

createGlyphLine

public abstract GlyphLine createGlyphLine(String content)

convertToBytes

public abstract byte[] convertToBytes(String text)

Converts the text into bytes to be placed in the document. The conversion is done according to the font and the encoding and the characters used are stored.

Parameters:

text - the text to convert

Returns:

the conversion

convertToBytes

public abstract byte[] convertToBytes(GlyphLine glyphLine)

decode

public abstract String decode(PdfString content)

getContentWidth

public abstract float getContentWidth(PdfString content)

convertToBytes

public abstract byte[] convertToBytes(Glyph glyph)

writeText

public abstract void writeText(GlyphLine text,
                               int from,
                               int to,
                               PdfOutputStream stream)

writeText

public abstract void writeText(String text,
                               PdfOutputStream stream)

writeText

public void writeText(GlyphLine text,
                      PdfOutputStream stream)

getFontMatrix

public double[] getFontMatrix()

getWidth

public int getWidth(int unicode)

Returns the width of a certain character of this font in 1000 normalized units.

Parameters:

unicode - a certain character.

Returns:

a width in Text Space.

getWidth

public float getWidth(int unicode,
                      float fontSize)

Returns the width of a certain character of this font in points.

Parameters:

unicode - a certain character.

fontSize - the font size.

Returns:

a width in points.

getWidth

public int getWidth(String text)

Returns the width of a string of this font in 1000 normalized units.

Parameters:

text - a string content.

Returns:

a width of string in Text Space.

getWidth

public float getWidth(String text,
                      float fontSize)

Gets the width of a String in points.

Parameters:

text - the String to get the width of

fontSize - the font size

Returns:

the width in points

getDescent

public int getDescent(String text,
                      float fontSize)

Gets the descent of a String in points. The descent will always be less than or equal to zero even if all the characters have an higher descent.

Parameters:

text - the String to get the descent of

fontSize - the font size

Returns:

the descent in points

getDescent

public int getDescent(int unicode,
                      float fontSize)

Gets the descent of a char code in points. The descent will always be less than or equal to zero even if all the characters have an higher descent.

Parameters:

unicode - the char code to get the descent of

fontSize - the font size

Returns:

the descent in points

getAscent

public int getAscent(String text,
                     float fontSize)

Gets the ascent of a String in points. The ascent will always be greater than or equal to zero even if all the characters have a lower ascent.

Parameters:

text - the String to get the ascent of

fontSize - the font size

Returns:

the ascent in points

getAscent

public int getAscent(int unicode,
                     float fontSize)

Gets the ascent of a char code in normalized 1000 units. The ascent will always be greater than or equal to zero even if all the characters have a lower ascent.

Parameters:

unicode - the char code to get the ascent of

fontSize - the font size

Returns:

the ascent in points

getFontProgram

public FontProgram getFontProgram()

isEmbedded

public boolean isEmbedded()

isSubset

public boolean isSubset()

Indicates if all the glyphs and widths for that particular encoding should be included in the document.

Returns:

false to include all the glyphs and widths.

setSubset

public void setSubset(boolean subset)

Indicates if all the glyphs and widths for that particular encoding should be included in the document. When set to true only the glyphs used will be included in the font. When set to false and addSubsetRange(int[]) was not called the full font will be included otherwise just the characters ranges will be included.

Parameters:

subset - new value of property subset

addSubsetRange

public void addSubsetRange(int[] range)

Adds a character range when subsetting. The range is an int array where the first element is the start range inclusive and the second element is the end range inclusive. Several ranges are allowed in the same array.

Parameters:

range - the character range

splitString

public List<String> splitString(String text,
                                int fontSize,
                                float maxWidth)

getFontDescriptor

protected abstract PdfDictionary getFontDescriptor(String fontName)

isWrappedObjectMustBeIndirect

protected boolean isWrappedObjectMustBeIndirect()

Description copied from class: PdfObjectWrapper

Defines if the object behind this wrapper must be an indirect object in the resultant document.

If this method returns true it doesn't necessarily mean that object must be in the indirect state at any moment, but rather defines that when the object will be written to the document it will be transformed into indirect object if it's not indirect yet.

Return value of this method shouldn't depend on any logic, it should return always true or false.

Specified by:

isWrappedObjectMustBeIndirect in class PdfObjectWrapper<PdfDictionary>

Returns:

true if in the resultant document the object behind the wrapper must be indirect, otherwise false.

checkFontDictionary

protected boolean checkFontDictionary(PdfDictionary fontDic,
                                      PdfName fontType)

checkTrueTypeFontDictionary

protected boolean checkTrueTypeFontDictionary(PdfDictionary fontDic)

checkTrueTypeFontDictionary

protected boolean checkTrueTypeFontDictionary(PdfDictionary fontDic,
                                              boolean isException)

createSubsetPrefix

protected static String createSubsetPrefix()

Creates a unique subset prefix to be added to the font name when the font is embedded and subset.

Returns:

the subset prefix

getPdfFontStream

protected PdfStream getPdfFontStream(byte[] fontStreamBytes,
                                     int[] fontStreamLengths)

Create PdfStream based on fontStreamBytes.

Parameters:

fontStreamBytes - original font data, must be not null.

fontStreamLengths - array to generate Length* keys, must be not null.

Returns:

the PdfStream containing the font or null, if there is an error reading the font.

Throws:

PdfException - Method will throw exception if fontStreamBytes is null.

compactRanges

protected static int[] compactRanges(List<int[]> ranges)