com.itextpdf.kernel.font

Class PdfType0Font

java.lang.Object

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

com.itextpdf.kernel.font.PdfFont

com.itextpdf.kernel.font.PdfType0Font

All Implemented Interfaces:

Serializable

public class PdfType0Font
extends PdfFont

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	CID_FONT_TYPE_0 CIDFont Type0 (Type1 outlines).
protected static int	CID_FONT_TYPE_2 CIDFont Type2 (TrueType outlines).
protected int	cidFontType
protected CMapEncoding	cmapEncoding
protected Set<Integer>	longTag
protected char[]	specificUnicodeDifferences
protected boolean	vertical

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

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

Method Summary

Modifier and Type	Method and Description
protected void	addRangeUni(TrueTypeFont ttf, Map<Integer,int[]> longTag, boolean includeMetrics) Deprecated. will be removed in 7.2
protected void	addRangeUni(TrueTypeFont ttf, Set<Integer> longTag) Deprecated. use TrueTypeFont.updateUsedGlyphs(SortedSet, boolean, List) instead.
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.
boolean	containsGlyph(int unicode) Check whether font contains glyph with specified unicode.
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 characterCodes) Decodes sequence of character codes (e.g.
void	flush() To manually flush a PdfObject behind this wrapper, you have to ensure that this object is added to the document, i.e.
protected PdfDictionary	getCidFont(PdfDictionary fontDescriptor, String fontName, boolean isType2) Generates the CIDFontType2 dictionary.
protected PdfDictionary	getCidFontType2(TrueTypeFont ttf, PdfDictionary fontDescriptor, String fontName, int[] glyphIds) Deprecated. use getCidFont(PdfDictionary, String, boolean) instead.
protected PdfDictionary	getCidFontType2(TrueTypeFont ttf, PdfDictionary fontDescriptor, String fontName, int[][] metrics) Deprecated. will be removed in 7.2
CMapEncoding	getCmap() Gets CMAP associated with the Pdf Font.
float	getContentWidth(PdfString content)
protected PdfDictionary	getFontDescriptor(String fontName)
Glyph	getGlyph(int unicode) Get glyph by unicode
PdfStream	getToUnicode() Creates a ToUnicode CMap to allow copy and paste from Acrobat.
PdfStream	getToUnicode(Object[] metrics) Deprecated. will be removed in 7.2. Use getToUnicode() instead
static String	getUniMapFromOrdering(String ordering)
boolean	isBuiltWith(String fontProgram, String encoding) Checks whether the PdfFont was built with corresponding fontProgram and encoding or CMAP.
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, compactRanges, getAscent, getAscent, getDescent, getDescent, getFontMatrix, getFontProgram, 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

CID_FONT_TYPE_0

protected static final int CID_FONT_TYPE_0

CIDFont Type0 (Type1 outlines).

See Also:

Constant Field Values

CID_FONT_TYPE_2

protected static final int CID_FONT_TYPE_2

CIDFont Type2 (TrueType outlines).

See Also:

Constant Field Values

vertical

protected boolean vertical

cmapEncoding

protected CMapEncoding cmapEncoding

longTag

protected Set<Integer> longTag

cidFontType

protected int cidFontType

specificUnicodeDifferences

protected char[] specificUnicodeDifferences

Method Detail

getUniMapFromOrdering

public static String getUniMapFromOrdering(String ordering)

getGlyph

public Glyph getGlyph(int unicode)

Description copied from class: PdfFont

Get glyph by unicode

Specified by:

getGlyph in class PdfFont

Parameters:

unicode - a unicode code point

Returns:

Glyph if it exists or .NOTDEF if supported, otherwise null.

containsGlyph

public boolean containsGlyph(int unicode)

Description copied from class: PdfFont

Check whether font contains glyph with specified unicode.

Overrides:

containsGlyph in class PdfFont

Parameters:

unicode - a unicode code point

Returns:

true if font contains glyph, represented with the unicode code point, otherwise false.

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

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

decode

public String decode(PdfString content)

Specified by:

decode in class PdfFont

decodeIntoGlyphLine

public GlyphLine decodeIntoGlyphLine(PdfString characterCodes)

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

Specified by:

decodeIntoGlyphLine in class PdfFont

Parameters:

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:

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

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)

flush

public void flush()

Description copied from class: PdfFont

To manually flush a PdfObject behind this wrapper, you have to ensure that this object is added to the document, i.e. it has an indirect reference. Basically this means that before flushing you need to explicitly call PdfObjectWrapper.makeIndirect(PdfDocument). For example: wrapperInstance.makeIndirect(document).flush(); Note that not every wrapper require this, only those that have such warning in documentation.

Overrides:

flush in class PdfFont

getCmap

public CMapEncoding getCmap()

Gets CMAP associated with the Pdf Font.

Returns:

CMAP

See Also:

CMapEncoding

getToUnicode

@Deprecated
public PdfStream getToUnicode(Object[] metrics)

Deprecated. will be removed in 7.2. Use getToUnicode() instead

Creates a ToUnicode CMap to allow copy and paste from Acrobat.

Parameters:

metrics - metrics[0] contains the glyph index and metrics[2] contains the Unicode code

Returns:

the stream representing this CMap or null

getFontDescriptor

protected PdfDictionary getFontDescriptor(String fontName)

Specified by:

getFontDescriptor in class PdfFont

getCidFontType2

@Deprecated
protected PdfDictionary getCidFontType2(TrueTypeFont ttf,
                                                    PdfDictionary fontDescriptor,
                                                    String fontName,
                                                    int[][] metrics)

Deprecated. will be removed in 7.2

Generates the CIDFontType2 dictionary.

Parameters:

ttf - a font program of this font instance

fontDescriptor - the font descriptor dictionary

fontName - a name of the font

metrics - the horizontal width metrics

Returns:

fully initialized CIDFont

addRangeUni

@Deprecated
protected void addRangeUni(TrueTypeFont ttf,
                                       Map<Integer,int[]> longTag,
                                       boolean includeMetrics)

Deprecated. will be removed in 7.2

The method will update set of used glyphs with range used in subset or with all glyphs if there is no subset. This set of used glyphs is required for building width array and ToUnicode CMAP.

Parameters:

ttf - a font program of this font instance.

longTag - a set of integers, which are glyph ids that denote used glyphs. This set is updated inside of the method if needed.

includeMetrics - used to define whether longTag map is populated with glyph metrics. Deprecated and is not used right now.

getCidFontType2

@Deprecated
protected PdfDictionary getCidFontType2(TrueTypeFont ttf,
                                                    PdfDictionary fontDescriptor,
                                                    String fontName,
                                                    int[] glyphIds)

Deprecated. use getCidFont(PdfDictionary, String, boolean) instead.

Generates the CIDFontType2 dictionary.

Parameters:

ttf - a font program of this font instance

fontDescriptor - the indirect reference to the font descriptor

fontName - a name of the font

glyphIds - glyph ids used in from the font

Returns:

fully initialized CIDFont

getCidFont

protected PdfDictionary getCidFont(PdfDictionary fontDescriptor,
                                   String fontName,
                                   boolean isType2)

Generates the CIDFontType2 dictionary.

Parameters:

fontDescriptor - the font descriptor dictionary

fontName - a name of the font

isType2 - true, if the font is CIDFontType2 (TrueType glyphs), otherwise false, i.e. CIDFontType0 (Type1/CFF glyphs)

Returns:

fully initialized CIDFont

getToUnicode

public PdfStream getToUnicode()

Creates a ToUnicode CMap to allow copy and paste from Acrobat.

Returns:

the stream representing this CMap or null

addRangeUni

@Deprecated
protected void addRangeUni(TrueTypeFont ttf,
                                       Set<Integer> longTag)

Deprecated. use TrueTypeFont.updateUsedGlyphs(SortedSet, boolean, List) instead.

The method will update set of used glyphs with range used in subset or with all glyphs if there is no subset. This set of used glyphs is required for building width array and ToUnicode CMAP.

Parameters:

ttf - a font program of this font instance.

longTag - a set of integers, which are glyph ids that denote used glyphs. This set is updated inside of the method if needed.