com.itextpdf.kernel.font

Class PdfSimpleFont<T extends FontProgram>

java.lang.Object

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

com.itextpdf.kernel.font.PdfFont

com.itextpdf.kernel.font.PdfSimpleFont<T>

Direct Known Subclasses:

PdfTrueTypeFont, PdfType1Font, PdfType3Font

public abstract class PdfSimpleFont<T extends FontProgram>
extends PdfFont

Field Summary

Fields

Modifier and Type	Field and Description
protected FontEncoding	fontEncoding
protected boolean	forceWidthsOutput Forces the output of the width array.
protected CMapToUnicode	toUnicode Currently only exists for the fonts that are parsed from the document.
protected byte[]	usedGlyphs The array used with single byte encodings.

Fields inherited from class com.itextpdf.kernel.font.PdfFont

embedded, EMPTY_BYTES, fontProgram, newFont, notdefGlyphs, SIMPLE_FONT_MAX_CHAR_CODE_VALUE, subset, subsetRanges

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected abstract void	addFontStream(PdfDictionary fontDescriptor)
int	appendAnyGlyph(String text, int from, List<Glyph> glyphs) Append any single glyph, even notdef.
boolean	appendDecodedCodesToGlyphsList(List<Glyph> list, PdfString characterCodes) Decodes sequence of character codes (e.g.
int	appendGlyphs(String text, int from, int to, List<Glyph> glyphs) Append all supported glyphs and return number of processed chars.
protected PdfArray	buildWidthsArray(int firstChar, int lastChar)
byte[]	convertToBytes(Glyph glyph)
byte[]	convertToBytes(GlyphLine glyphLine)
byte[]	convertToBytes(String text) Converts the text into bytes to be placed in the document.
GlyphLine	createGlyphLine(String content)
String	decode(PdfString content)
GlyphLine	decodeIntoGlyphLine(PdfString content) Decodes sequence of character codes (e.g.
protected void	flushFontData(String fontName, PdfName subtype)
float	getContentWidth(PdfString content)
protected PdfDictionary	getFontDescriptor(String fontName) Generates the font descriptor for this font or null if it is one of the 14 built in fonts.
FontEncoding	getFontEncoding() Get the font encoding.
CMapToUnicode	getToUnicode() Get the mapping of character codes to unicode values based on /ToUnicode entry of font dictionary.
protected boolean	isBuiltInFont() Indicates that the font is built in, i.e.
boolean	isBuiltWith(String fontProgram, String encoding) Checks whether the PdfFont was built with corresponding fontProgram and encoding or CMAP.
boolean	isForceWidthsOutput() Gets the state of the property.
protected void	setFontProgram(T fontProgram)
void	setForceWidthsOutput(boolean forceWidthsOutput) Set to true to force the generation of the widths array.
void	writeText(GlyphLine text, int from, int to, PdfOutputStream stream)
void	writeText(String text, PdfOutputStream stream)

Methods inherited from class com.itextpdf.kernel.font.PdfFont

addSubsetRange, containsGlyph, flush, getAscent, getAscent, getDescent, getDescent, getFontProgram, getGlyph, getPdfFontStream, getWidth, getWidth, getWidth, getWidth, isEmbedded, isSubset, isWrappedObjectMustBeIndirect, setSubset, splitString, toString, updateSubsetPrefix

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

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

Methods inherited from class java.lang.Object

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

Field Detail

fontEncoding

protected FontEncoding fontEncoding

forceWidthsOutput

protected boolean forceWidthsOutput

Forces the output of the width array. Only matters for the 14 built-in fonts.

usedGlyphs

protected byte[] usedGlyphs

The array used with single byte encodings.

toUnicode

protected CMapToUnicode toUnicode

Currently only exists for the fonts that are parsed from the document. In the future, we might provide possibility to add custom mappings after a font has been created from a font file.

Constructor Detail

PdfSimpleFont

protected PdfSimpleFont(PdfDictionary fontDictionary)

PdfSimpleFont

protected PdfSimpleFont()

Method Detail

isBuiltWith

public boolean isBuiltWith(String fontProgram,
                           String encoding)

Description copied from class: PdfFont

Checks whether the PdfFont was built with corresponding fontProgram and encoding or CMAP. Default value is false unless overridden.

Overrides:

isBuiltWith in class PdfFont

Parameters:

fontProgram - a font name or path to a font program

encoding - an encoding or CMAP

Returns:

true, if the PdfFont was built with the fontProgram and encoding. Otherwise false.

See Also:

PdfDocument.findFont(String, String), FontProgram.isBuiltWith(String), FontEncoding.isBuiltWith(String), CMapEncoding.isBuiltWith(String)

createGlyphLine

public GlyphLine createGlyphLine(String content)

Specified by:

createGlyphLine in class PdfFont

appendGlyphs

public int appendGlyphs(String text,
                        int from,
                        int to,
                        List<Glyph> glyphs)

Description copied from class: PdfFont

Append all supported glyphs and return number of processed chars. Composite font supports surrogate pairs.

Specified by:

appendGlyphs in class PdfFont

Parameters:

text - String to convert to glyphs.

from - from index of the text.

to - to index of the text.

glyphs - array for a new glyphs, shall not be null.

Returns:

number of processed chars from text.

appendAnyGlyph

public int appendAnyGlyph(String text,
                          int from,
                          List<Glyph> glyphs)

Description copied from class: PdfFont

Append any single glyph, even notdef. Returns number of processed chars: 2 in case surrogate pair, otherwise 1.

Specified by:

appendAnyGlyph in class PdfFont

Parameters:

text - String to convert to glyphs.

from - from index of the text.

glyphs - array for a new glyph, shall not be null.

Returns:

number of processed chars: 2 in case surrogate pair, otherwise 1

getFontEncoding

public FontEncoding getFontEncoding()

Get the font encoding.

Returns:

the FontEncoding

getToUnicode

public CMapToUnicode getToUnicode()

Get the mapping of character codes to unicode values based on /ToUnicode entry of font dictionary.

Returns:

the CMapToUnicode built based on /ToUnicode, or null if /ToUnicode is not available

convertToBytes

public byte[] convertToBytes(String text)

Description copied from class: PdfFont

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.

Specified by:

convertToBytes in class PdfFont

Parameters:

text - the text to convert

Returns:

the conversion

convertToBytes

public byte[] convertToBytes(GlyphLine glyphLine)

Specified by:

convertToBytes in class PdfFont

convertToBytes

public byte[] convertToBytes(Glyph glyph)

Specified by:

convertToBytes in class PdfFont

writeText

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

Specified by:

writeText in class PdfFont

writeText

public void writeText(String text,
                      PdfOutputStream stream)

Specified by:

writeText in class PdfFont

decode

public String decode(PdfString content)

Specified by:

decode in class PdfFont

decodeIntoGlyphLine

public GlyphLine decodeIntoGlyphLine(PdfString content)

Decodes sequence of character codes (e.g. from content stream) into a GlyphLine

Specified by:

decodeIntoGlyphLine in class PdfFont

Parameters:

content - the string which is interpreted as a sequence of character codes. Note, that PdfString acts as a storage for char code values specific to given font, therefore individual character codes must not be interpreted as code units of the UTF-16 encoding

Returns:

the GlyphLine containing the glyphs encoded by the passed string

appendDecodedCodesToGlyphsList

public boolean appendDecodedCodesToGlyphsList(List<Glyph> list,
                                              PdfString characterCodes)

Decodes sequence of character codes (e.g. from content stream) to sequence of glyphs and appends them to the passed list.

Overrides:

appendDecodedCodesToGlyphsList in class PdfFont

Parameters:

list - the list to the end of which decoded glyphs are to be added

characterCodes - the string which is interpreted as a sequence of character codes. Note, that PdfString acts as a storage for char code values specific to given font, therefore individual character codes must not be interpreted as code units of the UTF-16 encoding

Returns:

true if all codes where successfully decoded, false otherwise

getContentWidth

public float getContentWidth(PdfString content)

Specified by:

getContentWidth in class PdfFont

isForceWidthsOutput

public boolean isForceWidthsOutput()

Gets the state of the property.

Returns:

value of property forceWidthsOutput

setForceWidthsOutput

public void setForceWidthsOutput(boolean forceWidthsOutput)

Set to true to force the generation of the widths array.

Parameters:

forceWidthsOutput - true to force the generation of the widths array

flushFontData

protected void flushFontData(String fontName,
                             PdfName subtype)

isBuiltInFont

protected boolean isBuiltInFont()

Indicates that the font is built in, i.e. it is one of the 14 Standard fonts

Returns:

true in case the font is a Standard font and false otherwise

getFontDescriptor

protected PdfDictionary getFontDescriptor(String fontName)

Generates the font descriptor for this font or null if it is one of the 14 built in fonts.

Specified by:

getFontDescriptor in class PdfFont

Returns:

the PdfDictionary containing the font descriptor or null.

buildWidthsArray

protected PdfArray buildWidthsArray(int firstChar,
                                    int lastChar)

addFontStream

protected abstract void addFontStream(PdfDictionary fontDescriptor)

setFontProgram

protected void setFontProgram(T fontProgram)