Class BaseFont
- Direct Known Subclasses:
CJKFont
,DocumentFont
,TrueTypeFont
,Type1Font
,Type3Font
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static class
Generates the PDF stream with the Type1 and Truetype fonts returning a PdfStream. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
The maximum height above the baseline reached by glyphs in this font, excluding the height of glyphs for accented characters.static final int
java.awt.Font propertystatic final int
java.awt.Font propertystatic final int
java.awt.Font propertystatic final int
java.awt.Font propertystatic final int
The lower left x glyph coordinate.static final int
The lower left y glyph coordinate.static final int
The upper right x glyph coordinate.static final int
The upper right y glyph coordinate.list of the 14 built in fonts.static final boolean
if the font has to be cachedstatic final int
The y coordinate of the top of flat capital letters, measured from the baseline.static final int[]
static final int[]
static final int[]
static final int[]
protected int[][]
static final char
The fake CID code that represents a newline.protected int
The compression level for the font stream.static final String
This is a possible value of a base 14 type 1 fontstatic final String
This is a possible value of a base 14 type 1 fontstatic final String
This is a possible value of a base 14 type 1 fontstatic final String
This is a possible value of a base 14 type 1 fontstatic final String
A possible encoding.static final String
A possible encoding.static final String
A possible encoding.static final int
The maximum depth below the baseline reached by glyphs in this font.protected String[]
encoding namesprotected boolean
Convertschar
directly tobyte
by casting.protected boolean
true if the font is to be embedded in the PDFstatic final boolean
if the font has to be embeddedprotected String
encoding used with this fontprotected boolean
static final int
The font is CJK.static final int
A font already inside the document.static final int
The font is Type 1.static final int
A Type3 font.static final int
The font is True Type with a standard encoding.static final int
The font is True Type with a Unicode encoding.protected static ConcurrentHashMap
<String, BaseFont> cache for the fonts already used.protected boolean
true if the font must use its built in encoding.(package private) int
The font type.protected boolean
Forces the output of the width array.static final String
This is a possible value of a base 14 type 1 fontstatic final String
This is a possible value of a base 14 type 1 fontstatic final String
This is a possible value of a base 14 type 1 fontstatic final String
This is a possible value of a base 14 type 1 fontstatic final String
The Unicode encoding with horizontal writing.static final String
The Unicode encoding with vertical writing.protected boolean
Indicates if a CIDSet stream should be included in the document.static final int
The angle, expressed in degrees counterclockwise from the vertical, of the dominant vertical strokes of the font.static final String
A possible encoding.static final boolean
if the font doesn't have to be cachedstatic final boolean
if the font doesn't have to be embeddedstatic final String
a not defined character in a custom PDF encodingstatic final String
The path to the font resources.protected SecureRandom
Used to build a randomized prefix for a subset nameprotected IntHashtable
Custom encodings use this map to key the Unicode character to the single byte code.static final int
The strikethrough position.static final int
The strikethrough thickness.static final int
The recommended vertical offset from the baseline for subscripts for this font.static final int
The recommended vertical size for subscripts for this font.protected boolean
Indicates if all the glyphs and widths for that particular encoding should be included in the document.protected ArrayList
<int[]> static final int
The recommended vertical offset from the baseline for superscripts for this font.static final int
The recommended vertical size for superscripts for this font.static final String
This is a possible value of a base 14 type 1 fontstatic final String
This is a possible value of a base 14 type 1 fontstatic final String
This is a possible value of a base 14 type 1 fontstatic final String
This is a possible value of a base 14 type 1 fontstatic final String
This is a possible value of a base 14 type 1 fontstatic final int
The underline position.static final int
The underline thickness.protected char[]
same as differences but with the unicode codesprotected int[]
table of characters widths for this encodingstatic final String
A possible encoding.static final String
This is a possible value of a base 14 type 1 font -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate static void
addFont
(PRIndirectReference fontRef, IntHashtable hits, ArrayList<Object[]> fonts) void
addSubsetRange
(int[] range) Adds a character range when subsetting.boolean
charExists
(int c) Checks if a character exists in this font.(package private) byte[]
convertToBytes
(int char1) Converts achar
to abyte
array according to the font's encoding.(package private) byte[]
convertToBytes
(String text) Converts aString
to abyte
array according to the font's encoding.void
iText expects Arabic Diactrics (tashkeel) to have zero advance but some fonts, most notably those that come with Windows, like times.ttf, have non-zero advance for those characters.protected void
Creates thewidths
and thedifferences
arraysstatic BaseFont
Creates a new font.static BaseFont
createFont
(PRIndirectReference fontRef) Creates a font based on an existing document font.static BaseFont
createFont
(String name, String encoding, boolean embedded) Creates a new font.static BaseFont
createFont
(String name, String encoding, boolean embedded, boolean forceRead) Creates a new font.static BaseFont
createFont
(String name, String encoding, boolean embedded, boolean cached, byte[] ttfAfm, byte[] pfb) Creates a new font.static BaseFont
createFont
(String name, String encoding, boolean embedded, boolean cached, byte[] ttfAfm, byte[] pfb, boolean noThrow) Creates a new font.static BaseFont
createFont
(String name, String encoding, boolean embedded, boolean cached, byte[] ttfAfm, byte[] pfb, boolean noThrow, boolean forceRead) Creates a new font.protected String
Creates a unique subset prefix to be added to the font name when the font is embedded and subset.static String[]
enumerateTTCNames
(byte[] ttcArray) Enumerates the postscript font names present inside a True Type Collection.static String[]
enumerateTTCNames
(String ttcFile) Enumerates the postscript font names present inside a True Type Collection.static Object[]
getAllFontNames
(String name, String encoding, byte[] ttfAfm) Gets all the names from the font.abstract String[][]
Gets all the entries of the names-table.static String[][]
getAllNameEntries
(String name, String encoding, byte[] ttfAfm) Gets all the entries of the namestable from the font.int
Gets the ascent of aString
in normalized 1000 units.float
getAscentPoint
(String text, float fontSize) Gets the ascent of aString
in points.protected static String
getBaseName
(String name) Gets the name without the modifiers Bold, Italic or BoldItalic.int[]
getCharBBox
(int c) Gets the smallest box enclosing the character contours.int
getCidCode
(int c) Gets the CID code given an Unicode.String[]
Gets the code pages supported by the font.int
Returns the compression level used for the font streams.int
getDescent
(String text) Gets the descent of aString
in normalized 1000 units.float
getDescentPoint
(String text, float fontSize) Gets the descent of aString
in points.String[]
Gets the array with the names of the characters.getDocumentFonts
(PdfReader reader) Gets a list of all document fonts.getDocumentFonts
(PdfReader reader, int page) Gets a list of the document fonts in a particular page.Gets the encoding used to convertString
intobyte[]
.abstract String[][]
Gets the family name of the font.abstract float
getFontDescriptor
(int key, float fontSize) Gets the font parameter identified bykey
.int
Gets the font type.abstract String[][]
Gets the full name of the font.static String[][]
getFullFontName
(String name, String encoding, byte[] ttfAfm) Gets the full name of the font.(package private) abstract PdfStream
Returns a PdfStream object with the full font program (if possible).abstract int
getKerning
(int char1, int char2) Gets the kerning between two Unicode chars.abstract String
Gets the postscript font name.protected abstract int[]
getRawCharBBox
(int c, String name) (package private) abstract int
getRawWidth
(int c, String name) Gets the width from the font according to the Unicode charc
or thename
.static InputStream
getResourceStream
(String key) Gets the font resources.static InputStream
getResourceStream
(String key, ClassLoader loader) Gets the font resources.protected SecureRandom
Returns a defined SecureRandom implementation.char[]
Gets the array with the unicode characters.(package private) char
getUnicodeDifferences
(int index) Gets the Unicode character corresponding to the byte output to the pdf stream.int
getUnicodeEquivalent
(int c) Gets the Unicode equivalent to a CID.int
getWidth
(int char1) Gets the width of achar
in normalized 1000 units.int
Gets the width of aString
in normalized 1000 units.float
getWidthPoint
(int char1, float fontSize) Gets the width of achar
in points.float
getWidthPoint
(String text, float fontSize) Gets the width of aString
in points.float
getWidthPointKerned
(String text, float fontSize) Gets the width of aString
in points taking kerning into account.int[]
Gets the font width array.abstract boolean
Checks if the font has any kerning pairs.boolean
Gets the direct conversion ofchar
tobyte
.boolean
Gets the embedded flag.boolean
Gets the symbolic flag of the font.boolean
Gets the state of the property.boolean
Indicates if a CIDSet stream should be included in the document forTrueTypeFontUnicode
.boolean
isSubset()
Indicates if all the glyphs and widths for that particular encoding should be included in the document.protected static String
normalizeEncoding
(String enc) Normalize the encoding names.private static void
recourseFonts
(PdfDictionary page, IntHashtable hits, ArrayList<Object[]> fonts, int level) boolean
setCharAdvance
(int c, int advance) Sets the character advance.void
setCompressionLevel
(int compressionLevel) Sets the compression level to be used for the font streams.void
setDirectTextToByte
(boolean directTextToByte) Sets the conversion ofchar
directly tobyte
by casting.void
setForceWidthsOutput
(boolean forceWidthsOutput) Set totrue
to force the generation of the widths array.void
setIncludeCidSet
(boolean includeCidSet) Indicates if a CIDSet stream should be included in the document forTrueTypeFontUnicode
.abstract boolean
setKerning
(int char1, int char2, int kern) Sets the kerning between two Unicode chars.abstract void
setPostscriptFontName
(String name) Sets the font name that will appear in the pdf font dictionary.void
setSecureRandom
(SecureRandom secureRandom) Sets the SecureRandom instance to be used for a subset's prefix generationvoid
setSubset
(boolean subset) Indicates if all the glyphs and widths for that particular encoding should be included in the document.(package private) abstract void
writeFont
(PdfWriter writer, PdfIndirectReference ref, Object[] params) Outputs to the writer the font dictionaries and streams.
-
Field Details
-
COURIER
This is a possible value of a base 14 type 1 font- See Also:
-
COURIER_BOLD
This is a possible value of a base 14 type 1 font- See Also:
-
COURIER_OBLIQUE
This is a possible value of a base 14 type 1 font- See Also:
-
COURIER_BOLDOBLIQUE
This is a possible value of a base 14 type 1 font- See Also:
-
HELVETICA
This is a possible value of a base 14 type 1 font- See Also:
-
HELVETICA_BOLD
This is a possible value of a base 14 type 1 font- See Also:
-
HELVETICA_OBLIQUE
This is a possible value of a base 14 type 1 font- See Also:
-
HELVETICA_BOLDOBLIQUE
This is a possible value of a base 14 type 1 font- See Also:
-
SYMBOL
This is a possible value of a base 14 type 1 font- See Also:
-
TIMES_ROMAN
This is a possible value of a base 14 type 1 font- See Also:
-
TIMES_BOLD
This is a possible value of a base 14 type 1 font- See Also:
-
TIMES_ITALIC
This is a possible value of a base 14 type 1 font- See Also:
-
TIMES_BOLDITALIC
This is a possible value of a base 14 type 1 font- See Also:
-
ZAPFDINGBATS
This is a possible value of a base 14 type 1 font- See Also:
-
ASCENT
public static final int ASCENTThe maximum height above the baseline reached by glyphs in this font, excluding the height of glyphs for accented characters.- See Also:
-
CAPHEIGHT
public static final int CAPHEIGHTThe y coordinate of the top of flat capital letters, measured from the baseline.- See Also:
-
DESCENT
public static final int DESCENTThe maximum depth below the baseline reached by glyphs in this font. The value is a negative number.- See Also:
-
ITALICANGLE
public static final int ITALICANGLEThe angle, expressed in degrees counterclockwise from the vertical, of the dominant vertical strokes of the font. The value is negative for fonts that slope to the right, as almost all italic fonts do.- See Also:
-
BBOXLLX
public static final int BBOXLLXThe lower left x glyph coordinate.- See Also:
-
BBOXLLY
public static final int BBOXLLYThe lower left y glyph coordinate.- See Also:
-
BBOXURX
public static final int BBOXURXThe upper right x glyph coordinate.- See Also:
-
BBOXURY
public static final int BBOXURYThe upper right y glyph coordinate.- See Also:
-
AWT_ASCENT
public static final int AWT_ASCENTjava.awt.Font property- See Also:
-
AWT_DESCENT
public static final int AWT_DESCENTjava.awt.Font property- See Also:
-
AWT_LEADING
public static final int AWT_LEADINGjava.awt.Font property- See Also:
-
AWT_MAXADVANCE
public static final int AWT_MAXADVANCEjava.awt.Font property- See Also:
-
UNDERLINE_POSITION
public static final int UNDERLINE_POSITIONThe underline position. Usually a negative value.- See Also:
-
UNDERLINE_THICKNESS
public static final int UNDERLINE_THICKNESSThe underline thickness.- See Also:
-
STRIKETHROUGH_POSITION
public static final int STRIKETHROUGH_POSITIONThe strikethrough position.- See Also:
-
STRIKETHROUGH_THICKNESS
public static final int STRIKETHROUGH_THICKNESSThe strikethrough thickness.- See Also:
-
SUBSCRIPT_SIZE
public static final int SUBSCRIPT_SIZEThe recommended vertical size for subscripts for this font.- See Also:
-
SUBSCRIPT_OFFSET
public static final int SUBSCRIPT_OFFSETThe recommended vertical offset from the baseline for subscripts for this font. Usually a negative value.- See Also:
-
SUPERSCRIPT_SIZE
public static final int SUPERSCRIPT_SIZEThe recommended vertical size for superscripts for this font.- See Also:
-
SUPERSCRIPT_OFFSET
public static final int SUPERSCRIPT_OFFSETThe recommended vertical offset from the baseline for superscripts for this font.- See Also:
-
FONT_TYPE_T1
public static final int FONT_TYPE_T1The font is Type 1.- See Also:
-
FONT_TYPE_TT
public static final int FONT_TYPE_TTThe font is True Type with a standard encoding.- See Also:
-
FONT_TYPE_CJK
public static final int FONT_TYPE_CJKThe font is CJK.- See Also:
-
FONT_TYPE_TTUNI
public static final int FONT_TYPE_TTUNIThe font is True Type with a Unicode encoding.- See Also:
-
FONT_TYPE_DOCUMENT
public static final int FONT_TYPE_DOCUMENTA font already inside the document.- See Also:
-
FONT_TYPE_T3
public static final int FONT_TYPE_T3A Type3 font.- See Also:
-
IDENTITY_H
The Unicode encoding with horizontal writing.- See Also:
-
IDENTITY_V
The Unicode encoding with vertical writing.- See Also:
-
CP1250
A possible encoding.- See Also:
-
CP1252
A possible encoding.- See Also:
-
CP1257
A possible encoding.- See Also:
-
WINANSI
A possible encoding.- See Also:
-
MACROMAN
A possible encoding.- See Also:
-
CHAR_RANGE_LATIN
public static final int[] CHAR_RANGE_LATIN -
CHAR_RANGE_ARABIC
public static final int[] CHAR_RANGE_ARABIC -
CHAR_RANGE_HEBREW
public static final int[] CHAR_RANGE_HEBREW -
CHAR_RANGE_CYRILLIC
public static final int[] CHAR_RANGE_CYRILLIC -
EMBEDDED
public static final boolean EMBEDDEDif the font has to be embedded- See Also:
-
NOT_EMBEDDED
public static final boolean NOT_EMBEDDEDif the font doesn't have to be embedded- See Also:
-
CACHED
public static final boolean CACHEDif the font has to be cached- See Also:
-
NOT_CACHED
public static final boolean NOT_CACHEDif the font doesn't have to be cached- See Also:
-
RESOURCE_PATH
The path to the font resources.- See Also:
-
CID_NEWLINE
public static final char CID_NEWLINEThe fake CID code that represents a newline.- See Also:
-
notdef
a not defined character in a custom PDF encoding- See Also:
-
BuiltinFonts14
list of the 14 built in fonts. -
fontCache
cache for the fonts already used. -
subsetRanges
-
widths
protected int[] widthstable of characters widths for this encoding -
differences
encoding names -
unicodeDifferences
protected char[] unicodeDifferencessame as differences but with the unicode codes -
charBBoxes
protected int[][] charBBoxes -
encoding
encoding used with this font -
embedded
protected boolean embeddedtrue if the font is to be embedded in the PDF -
compressionLevel
protected int compressionLevelThe compression level for the font stream.- Since:
- 2.1.3
-
fontSpecific
protected boolean fontSpecifictrue if the font must use its built in encoding. In that case theencoding
is only used to map a char to the position inside the font, not to the expected char name. -
forceWidthsOutput
protected boolean forceWidthsOutputForces the output of the width array. Only matters for the 14 built-in fonts. -
directTextToByte
protected boolean directTextToByteConvertschar
directly tobyte
by casting. -
subset
protected boolean subsetIndicates if all the glyphs and widths for that particular encoding should be included in the document. -
fastWinansi
protected boolean fastWinansi -
specialMap
Custom encodings use this map to key the Unicode character to the single byte code. -
secureRandom
Used to build a randomized prefix for a subset name -
includeCidSet
protected boolean includeCidSetIndicates if a CIDSet stream should be included in the document. -
fontType
int fontTypeThe font type.
-
-
Constructor Details
-
BaseFont
protected BaseFont()Creates new BaseFont
-
-
Method Details
-
createFont
Creates a new font. This will always be the default Helvetica font (not embedded). This method is introduced because Helvetica is used in many examples.- Returns:
- a BaseFont object (Helvetica, Winansi, not embedded)
- Throws:
IOException
- This shouldn't occur everDocumentException
- This shouldn't occur ever- Since:
- 2.1.1
-
createFont
public static BaseFont createFont(String name, String encoding, boolean embedded) throws DocumentException, IOException Creates a new font. This font can be one of the 14 built in types, a Type1 font referred to by an AFM or PFM file, a TrueType font (simple or collection) or a CJK font from the Adobe Asian Font Pack. TrueType fonts and CJK fonts can have an optional style modifier appended to the name. These modifiers are: Bold, Italic and BoldItalic. An example would be "STSong-Light,Bold". Note that this modifiers do not work if the font is embedded. Fonts in TrueType collections are addressed by index such as "msgothic.ttc,1". This would get the second font (indexes start at 0), in this case "MS PGothic".The fonts are cached and if they already exist they are extracted from the cache, not parsed again.
Besides the common encodings described by name, custom encodings can also be made. These encodings will only work for the single byte fonts Type1 and TrueType. The encoding string starts with a '#' followed by "simple" or "full". If "simple" there is a decimal for the first character position and then a list of hex values representing the Unicode codes that compose that encoding.
The "simple" encoding is recommended for TrueType fonts as the "full" encoding risks not matching the character with the right glyph if not done with care.
The "full" encoding is specially aimed at Type1 fonts where the glyphs have to be described by non standard names like the Tex math fonts. Each group of three elements compose a code position: the one byte code order in decimal or as 'x' (x cannot be the space), the name and the Unicode character used to access the glyph. The space must be assigned to character position 32 otherwise text justification will not work.Example for a "simple" encoding that includes the Unicode character space, A, B and ecyrillic:
"# simple 32 0020 0041 0042 0454"
Example for a "full" encoding for a Type1 Tex font:
"# full 'A' nottriangeqlleft 0041 'B' dividemultiply 0042 32 space 0020"
This method calls:
createFont(name, encoding, embedded, true, null, null);
- Parameters:
name
- the name of the font or its location on fileencoding
- the encoding to be applied to this fontembedded
- true if the font is to be embedded in the PDF- Returns:
- returns a new font. This font may come from the cache
- Throws:
DocumentException
- the font is invalidIOException
- the font file could not be read
-
createFont
public static BaseFont createFont(String name, String encoding, boolean embedded, boolean forceRead) throws DocumentException, IOException Creates a new font. This font can be one of the 14 built in types, a Type1 font referred to by an AFM or PFM file, a TrueType font (simple or collection) or a CJK font from the Adobe Asian Font Pack. TrueType fonts and CJK fonts can have an optional style modifier appended to the name. These modifiers are: Bold, Italic and BoldItalic. An example would be "STSong-Light,Bold". Note that this modifiers do not work if the font is embedded. Fonts in TrueType collections are addressed by index such as "msgothic.ttc,1". This would get the second font (indexes start at 0), in this case "MS PGothic".The fonts are cached and if they already exist they are extracted from the cache, not parsed again.
Besides the common encodings described by name, custom encodings can also be made. These encodings will only work for the single byte fonts Type1 and TrueType. The encoding string starts with a '#' followed by "simple" or "full". If "simple" there is a decimal for the first character position and then a list of hex values representing the Unicode codes that compose that encoding.
The "simple" encoding is recommended for TrueType fonts as the "full" encoding risks not matching the character with the right glyph if not done with care.
The "full" encoding is specially aimed at Type1 fonts where the glyphs have to be described by non standard names like the Tex math fonts. Each group of three elements compose a code position: the one byte code order in decimal or as 'x' (x cannot be the space), the name and the Unicode character used to access the glyph. The space must be assigned to character position 32 otherwise text justification will not work.Example for a "simple" encoding that includes the Unicode character space, A, B and ecyrillic:
"# simple 32 0020 0041 0042 0454"
Example for a "full" encoding for a Type1 Tex font:
"# full 'A' nottriangeqlleft 0041 'B' dividemultiply 0042 32 space 0020"
This method calls:
createFont(name, encoding, embedded, true, null, null);
- Parameters:
name
- the name of the font or its location on fileencoding
- the encoding to be applied to this fontembedded
- true if the font is to be embedded in the PDFforceRead
- in some cases (TrueTypeFont, Type1Font), the full font file will be read and kept in memory if forceRead is true- Returns:
- returns a new font. This font may come from the cache
- Throws:
DocumentException
- the font is invalidIOException
- the font file could not be read- Since:
- 2.1.5
-
createFont
public static BaseFont createFont(String name, String encoding, boolean embedded, boolean cached, byte[] ttfAfm, byte[] pfb) throws DocumentException, IOException Creates a new font. This font can be one of the 14 built in types, a Type1 font referred to by an AFM or PFM file, a TrueType font (simple or collection) or a CJK font from the Adobe Asian Font Pack. TrueType fonts and CJK fonts can have an optional style modifier appended to the name. These modifiers are: Bold, Italic and BoldItalic. An example would be "STSong-Light,Bold". Note that this modifiers do not work if the font is embedded. Fonts in TrueType collections are addressed by index such as "msgothic.ttc,1". This would get the second font (indexes start at 0), in this case "MS PGothic".The fonts may or may not be cached depending on the flag
cached
. If thebyte
arrays are present the font will be read from them instead of the name. A name is still required to identify the font type.Besides the common encodings described by name, custom encodings can also be made. These encodings will only work for the single byte fonts Type1 and TrueType. The encoding string starts with a '#' followed by "simple" or "full". If "simple" there is a decimal for the first character position and then a list of hex values representing the Unicode codes that compose that encoding.
The "simple" encoding is recommended for TrueType fonts as the "full" encoding risks not matching the character with the right glyph if not done with care.
The "full" encoding is specially aimed at Type1 fonts where the glyphs have to be described by non standard names like the Tex math fonts. Each group of three elements compose a code position: the one byte code order in decimal or as 'x' (x cannot be the space), the name and the Unicode character used to access the glyph. The space must be assigned to character position 32 otherwise text justification will not work.Example for a "simple" encoding that includes the Unicode character space, A, B and ecyrillic:
"# simple 32 0020 0041 0042 0454"
Example for a "full" encoding for a Type1 Tex font:
"# full 'A' nottriangeqlleft 0041 'B' dividemultiply 0042 32 space 0020"
- Parameters:
name
- the name of the font or its location on fileencoding
- the encoding to be applied to this fontembedded
- true if the font is to be embedded in the PDFcached
- true if the font comes from the cache or is added to the cache if new, false if the font is always created newttfAfm
- the true type font or the afm in a byte arraypfb
- the pfb in a byte array- Returns:
- returns a new font. This font may come from the cache but only if cached is true, otherwise it will always be created new
- Throws:
DocumentException
- the font is invalidIOException
- the font file could not be read- Since:
- iText 0.80
-
createFont
public static BaseFont createFont(String name, String encoding, boolean embedded, boolean cached, byte[] ttfAfm, byte[] pfb, boolean noThrow) throws DocumentException, IOException Creates a new font. This font can be one of the 14 built in types, a Type1 font referred to by an AFM or PFM file, a TrueType font (simple or collection) or a CJK font from the Adobe Asian Font Pack. TrueType fonts and CJK fonts can have an optional style modifier appended to the name. These modifiers are: Bold, Italic and BoldItalic. An example would be "STSong-Light,Bold". Note that this modifiers do not work if the font is embedded. Fonts in TrueType collections are addressed by index such as "msgothic.ttc,1". This would get the second font (indexes start at 0), in this case "MS PGothic".The fonts may or may not be cached depending on the flag
cached
. If thebyte
arrays are present the font will be read from them instead of the name. A name is still required to identify the font type.Besides the common encodings described by name, custom encodings can also be made. These encodings will only work for the single byte fonts Type1 and TrueType. The encoding string starts with a '#' followed by "simple" or "full". If "simple" there is a decimal for the first character position and then a list of hex values representing the Unicode codes that compose that encoding.
The "simple" encoding is recommended for TrueType fonts as the "full" encoding risks not matching the character with the right glyph if not done with care.
The "full" encoding is specially aimed at Type1 fonts where the glyphs have to be described by non standard names like the Tex math fonts. Each group of three elements compose a code position: the one byte code order in decimal or as 'x' (x cannot be the space), the name and the Unicode character used to access the glyph. The space must be assigned to character position 32 otherwise text justification will not work.Example for a "simple" encoding that includes the Unicode character space, A, B and ecyrillic:
"# simple 32 0020 0041 0042 0454"
Example for a "full" encoding for a Type1 Tex font:
"# full 'A' nottriangeqlleft 0041 'B' dividemultiply 0042 32 space 0020"
- Parameters:
name
- the name of the font or its location on fileencoding
- the encoding to be applied to this fontembedded
- true if the font is to be embedded in the PDFcached
- true if the font comes from the cache or is added to the cache if new, false if the font is always created newttfAfm
- the true type font or the afm in a byte arraypfb
- the pfb in a byte arraynoThrow
- if true will not throw an exception if the font is not recognized and will return null, if false will throw an exception if the font is not recognized. Note that even if true an exception may be thrown in some circumstances. This parameter is useful for FontFactory that may have to check many invalid font names before finding the right one- Returns:
- returns a new font. This font may come from the cache but only if cached is true, otherwise it will always be created new
- Throws:
DocumentException
- the font is invalidIOException
- the font file could not be read- Since:
- 2.0.3
-
createFont
public static BaseFont createFont(String name, String encoding, boolean embedded, boolean cached, byte[] ttfAfm, byte[] pfb, boolean noThrow, boolean forceRead) throws DocumentException, IOException Creates a new font. This font can be one of the 14 built in types, a Type1 font referred to by an AFM or PFM file, a TrueType font (simple or collection) or a CJK font from the Adobe Asian Font Pack. TrueType fonts and CJK fonts can have an optional style modifier appended to the name. These modifiers are: Bold, Italic and BoldItalic. An example would be "STSong-Light,Bold". Note that this modifiers do not work if the font is embedded. Fonts in TrueType collections are addressed by index such as "msgothic.ttc,1". This would get the second font (indexes start at 0), in this case "MS PGothic".The fonts may or may not be cached depending on the flag
cached
. If thebyte
arrays are present the font will be read from them instead of the name. A name is still required to identify the font type.Besides the common encodings described by name, custom encodings can also be made. These encodings will only work for the single byte fonts Type1 and TrueType. The encoding string starts with a '#' followed by "simple" or "full". If "simple" there is a decimal for the first character position and then a list of hex values representing the Unicode codes that compose that encoding.
The "simple" encoding is recommended for TrueType fonts as the "full" encoding risks not matching the character with the right glyph if not done with care.
The "full" encoding is specially aimed at Type1 fonts where the glyphs have to be described by non standard names like the Tex math fonts. Each group of three elements compose a code position: the one byte code order in decimal or as 'x' (x cannot be the space), the name and the Unicode character used to access the glyph. The space must be assigned to character position 32 otherwise text justification will not work.Example for a "simple" encoding that includes the Unicode character space, A, B and ecyrillic:
"# simple 32 0020 0041 0042 0454"
Example for a "full" encoding for a Type1 Tex font:
"# full 'A' nottriangeqlleft 0041 'B' dividemultiply 0042 32 space 0020"
- Parameters:
name
- the name of the font or its location on fileencoding
- the encoding to be applied to this fontembedded
- true if the font is to be embedded in the PDFcached
- true if the font comes from the cache or is added to the cache if new, false if the font is always created newttfAfm
- the true type font or the afm in a byte arraypfb
- the pfb in a byte arraynoThrow
- if true will not throw an exception if the font is not recognized and will return null, if false will throw an exception if the font is not recognized. Note that even if true an exception may be thrown in some circumstances. This parameter is useful for FontFactory that may have to check many invalid font names before finding the right oneforceRead
- in some cases (TrueTypeFont, Type1Font), the full font file will be read and kept in memory if forceRead is true- Returns:
- returns a new font. This font may come from the cache but only if cached is true, otherwise it will always be created new
- Throws:
DocumentException
- the font is invalidIOException
- the font file could not be read- Since:
- 2.1.5
-
createFont
Creates a font based on an existing document font. The created font font may not behave as expected, depending on the encoding or subset.- Parameters:
fontRef
- the reference to the document font- Returns:
- the font
-
getBaseName
Gets the name without the modifiers Bold, Italic or BoldItalic.- Parameters:
name
- the full name of the font- Returns:
- the name without the modifiers Bold, Italic or BoldItalic
-
normalizeEncoding
Normalize the encoding names. "winansi" is changed to "Cp1252" and "macroman" is changed to "MacRoman".- Parameters:
enc
- the encoding to be normalized- Returns:
- the normalized encoding
-
getFullFontName
public static String[][] getFullFontName(String name, String encoding, byte[] ttfAfm) throws DocumentException, IOException Gets the full name of the font. If it is a True Type font each array element will have {Platform ID, Platform Encoding ID, Language ID, font name}. The interpretation of this values can be found in the Open Type specification, chapter 2, in the 'name' table.
For the other fonts the array has a single element with {"", "", "", font name}.- Parameters:
name
- the name of the fontencoding
- the encoding of the fontttfAfm
- the true type font or the afm in a byte array- Returns:
- the full name of the font
- Throws:
DocumentException
- on errorIOException
- on error
-
getAllFontNames
public static Object[] getAllFontNames(String name, String encoding, byte[] ttfAfm) throws DocumentException, IOException Gets all the names from the font. Only the required tables are read.- Parameters:
name
- the name of the fontencoding
- the encoding of the fontttfAfm
- the true type font or the afm in a byte array- Returns:
- an array of Object[] built with {getPostscriptFontName(), getFamilyFontName(), getFullFontName()}
- Throws:
DocumentException
- on errorIOException
- on error
-
getAllNameEntries
public static String[][] getAllNameEntries(String name, String encoding, byte[] ttfAfm) throws DocumentException, IOException Gets all the entries of the namestable from the font. Only the required tables are read.- Parameters:
name
- the name of the fontencoding
- the encoding of the fontttfAfm
- the true type font or the afm in a byte array- Returns:
- an array of Object[] built with {getPostscriptFontName(), getFamilyFontName(), getFullFontName()}
- Throws:
DocumentException
- on errorIOException
- on error- Since:
- 2.0.8
-
enumerateTTCNames
Enumerates the postscript font names present inside a True Type Collection.- Parameters:
ttcFile
- the file name of the font- Returns:
- the postscript font names
- Throws:
DocumentException
- on errorIOException
- on error
-
enumerateTTCNames
Enumerates the postscript font names present inside a True Type Collection.- Parameters:
ttcArray
- the font as abyte
array- Returns:
- the postscript font names
- Throws:
DocumentException
- on errorIOException
- on error
-
getResourceStream
Gets the font resources.- Parameters:
key
- the full name of the resource- Returns:
- the
InputStream
to get the resource ornull
if not found
-
getResourceStream
Gets the font resources.- Parameters:
key
- the full name of the resourceloader
- the ClassLoader to load the resource or null to try the ones available- Returns:
- the
InputStream
to get the resource ornull
if not found
-
addFont
private static void addFont(PRIndirectReference fontRef, IntHashtable hits, ArrayList<Object[]> fonts) -
recourseFonts
private static void recourseFonts(PdfDictionary page, IntHashtable hits, ArrayList<Object[]> fonts, int level) -
getDocumentFonts
Gets a list of all document fonts. Each element of theArrayList
contains aObject[]{String,PRIndirectReference}
with the font name and the indirect reference to it.- Parameters:
reader
- the document where the fonts are to be listed from- Returns:
- the list of fonts and references
-
getDocumentFonts
Gets a list of the document fonts in a particular page. Each element of theArrayList
contains aObject[]{String,PRIndirectReference}
with the font name and the indirect reference to it.- Parameters:
reader
- the document where the fonts are to be listed frompage
- the page to list the fonts from- Returns:
- the list of fonts and references
-
createEncoding
protected void createEncoding()Creates thewidths
and thedifferences
arrays -
getRawWidth
Gets the width from the font according to the Unicode charc
or thename
. If thename
is null it's a symbolic font.- Parameters:
c
- the unicode charname
- the glyph name- Returns:
- the width of the char
-
getKerning
public abstract int getKerning(int char1, int char2) Gets the kerning between two Unicode chars.- Parameters:
char1
- the first charchar2
- the second char- Returns:
- the kerning to be applied in normalized 1000 units
-
setKerning
public abstract boolean setKerning(int char1, int char2, int kern) Sets the kerning between two Unicode chars.- Parameters:
char1
- the first charchar2
- the second charkern
- the kerning to apply in normalized 1000 units- Returns:
true
if the kerning was applied,false
otherwise
-
getWidth
public int getWidth(int char1) Gets the width of achar
in normalized 1000 units.- Parameters:
char1
- the unicodechar
to get the width of- Returns:
- the width in normalized 1000 units
-
getWidth
Gets the width of aString
in normalized 1000 units.- Parameters:
text
- theString
to get the width of- Returns:
- the width in normalized 1000 units
-
getDescent
Gets the descent of aString
in normalized 1000 units. The descent will always be less than or equal to zero even if all the characters have an higher descent.- Parameters:
text
- theString
to get the descent of- Returns:
- the descent in normalized 1000 units
-
getAscent
Gets the ascent of aString
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:
text
- theString
to get the ascent of- Returns:
- the ascent in normalized 1000 units
-
getDescentPoint
Gets the descent of aString
in points. The descent will always be less than or equal to zero even if all the characters have an higher descent.- Parameters:
text
- theString
to get the descent offontSize
- the size of the font- Returns:
- the descent in points
-
getAscentPoint
Gets the ascent of aString
in points. The ascent will always be greater than or equal to zero even if all the characters have a lower ascent.- Parameters:
text
- theString
to get the ascent offontSize
- the size of the font- Returns:
- the ascent in points
-
getWidthPointKerned
Gets the width of aString
in points taking kerning into account.- Parameters:
text
- theString
to get the width offontSize
- the font size- Returns:
- the width in points
-
getWidthPoint
Gets the width of aString
in points.- Parameters:
text
- theString
to get the width offontSize
- the font size- Returns:
- the width in points
-
getWidthPoint
public float getWidthPoint(int char1, float fontSize) Gets the width of achar
in points.- Parameters:
char1
- thechar
to get the width offontSize
- the font size- Returns:
- the width in points
-
convertToBytes
Converts aString
to abyte
array according to the font's encoding.- Parameters:
text
- theString
to be converted- Returns:
- an array of
byte
representing the conversion according to the font's encoding
-
convertToBytes
byte[] convertToBytes(int char1) Converts achar
to abyte
array according to the font's encoding.- Parameters:
char1
- thechar
to be converted- Returns:
- an array of
byte
representing the conversion according to the font's encoding
-
writeFont
abstract void writeFont(PdfWriter writer, PdfIndirectReference ref, Object[] params) throws DocumentException, IOException Outputs to the writer the font dictionaries and streams.- Parameters:
writer
- the writer for this documentref
- the font indirect referenceparams
- several parameters that depend on the font type- Throws:
IOException
- on errorDocumentException
- error in generating the object
-
getFullFontStream
Returns a PdfStream object with the full font program (if possible). This method will return null for some types of fonts (CJKFont, Type3Font) or if there is no font program available (standard Type 1 fonts).- Returns:
- a PdfStream with the font program
- Throws:
IOException
- on errorDocumentException
- on error- Since:
- 2.1.3
-
getEncoding
Gets the encoding used to convertString
intobyte[]
.- Returns:
- the encoding name
-
getFontDescriptor
public abstract float getFontDescriptor(int key, float fontSize) Gets the font parameter identified bykey
. Valid values forkey
areASCENT
,AWT_ASCENT
,CAPHEIGHT
,DESCENT
,AWT_DESCENT
,ITALICANGLE
,BBOXLLX
,BBOXLLY
,BBOXURX
andBBOXURY
.- Parameters:
key
- the parameter to be extractedfontSize
- the font size in points- Returns:
- the parameter in points
-
getFontType
public int getFontType()Gets the font type. The font types can be: FONT_TYPE_T1, FONT_TYPE_TT, FONT_TYPE_CJK and FONT_TYPE_TTUNI.- Returns:
- the font type
-
isEmbedded
public boolean isEmbedded()Gets the embedded flag.- Returns:
true
if the font is embedded.
-
isFontSpecific
public boolean isFontSpecific()Gets the symbolic flag of the font.- Returns:
true
if the font is symbolic
-
createSubsetPrefix
Creates a unique subset prefix to be added to the font name when the font is embedded and subset.- Returns:
- the subset prefix
-
getSecureRandom
Returns a defined SecureRandom implementation. If nothing is set, returns a new- Returns:
SecureRandom
-
setSecureRandom
Sets the SecureRandom instance to be used for a subset's prefix generation- Parameters:
secureRandom
-SecureRandom
-
getUnicodeDifferences
char getUnicodeDifferences(int index) Gets the Unicode character corresponding to the byte output to the pdf stream.- Parameters:
index
- the byte index- Returns:
- the Unicode character
-
getPostscriptFontName
Gets the postscript font name.- Returns:
- the postscript font name
-
setPostscriptFontName
Sets the font name that will appear in the pdf font dictionary. Use with care as it can easily make a font unreadable if not embedded.- Parameters:
name
- the new font name
-
getFullFontName
Gets the full name of the font. If it is a True Type font each array element will have {Platform ID, Platform Encoding ID, Language ID, font name}. The interpretation of this values can be found in the Open Type specification, chapter 2, in the 'name' table.
For the other fonts the array has a single element with {"", "", "", font name}.- Returns:
- the full name of the font
-
getAllNameEntries
Gets all the entries of the names-table. If it is a True Type font each array element will have {Name ID, Platform ID, Platform Encoding ID, Language ID, font name}. The interpretation of this values can be found in the Open Type specification, chapter 2, in the 'name' table.
For the other fonts the array has a single element with {"4", "", "", "", font name}.- Returns:
- the full name of the font
- Since:
- 2.0.8
-
getFamilyFontName
Gets the family name of the font. If it is a True Type font each array element will have {Platform ID, Platform Encoding ID, Language ID, font name}. The interpretation of this values can be found in the Open Type specification, chapter 2, in the 'name' table.
For the other fonts the array has a single element with {"", "", "", font name}.- Returns:
- the family name of the font
-
getCodePagesSupported
Gets the code pages supported by the font. This has only meaning with True Type fonts.- Returns:
- the code pages supported by the font
-
getWidths
public int[] getWidths()Gets the font width array.- Returns:
- the font width array
-
getDifferences
Gets the array with the names of the characters.- Returns:
- the array with the names of the characters
-
getUnicodeDifferences
public char[] getUnicodeDifferences()Gets the array with the unicode characters.- Returns:
- the array with the unicode characters
-
isForceWidthsOutput
public boolean isForceWidthsOutput()Gets the state of the property.- Returns:
- value of property forceWidthsOutput
-
setForceWidthsOutput
public void setForceWidthsOutput(boolean forceWidthsOutput) Set totrue
to force the generation of the widths array.- Parameters:
forceWidthsOutput
-true
to force the generation of the widths array
-
isDirectTextToByte
public boolean isDirectTextToByte()Gets the direct conversion ofchar
tobyte
.- Returns:
- value of property directTextToByte.
- See Also:
-
setDirectTextToByte
public void setDirectTextToByte(boolean directTextToByte) Sets the conversion ofchar
directly tobyte
by casting. This is a low level feature to put the bytes directly in the content stream without passing through String.getBytes().- Parameters:
directTextToByte
- New value of property directTextToByte.
-
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 totrue
only the glyphs used will be included in the font. When set tofalse
andaddSubsetRange(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
-
getUnicodeEquivalent
public int getUnicodeEquivalent(int c) Gets the Unicode equivalent to a CID. The (nonexistent) CIDFF00
is translated as '\n'. It has only meaning with CJK fonts with Identity encoding.- Parameters:
c
- the CID code- Returns:
- the Unicode equivalent
-
getCidCode
public int getCidCode(int c) Gets the CID code given an Unicode. It has only meaning with CJK fonts.- Parameters:
c
- the Unicode- Returns:
- the CID equivalent
-
hasKernPairs
public abstract boolean hasKernPairs()Checks if the font has any kerning pairs.- Returns:
true
if the font has any kerning pairs
-
charExists
public boolean charExists(int c) Checks if a character exists in this font.- Parameters:
c
- the character to check- Returns:
true
if the character has a glyph,false
otherwise
-
setCharAdvance
public boolean setCharAdvance(int c, int advance) Sets the character advance.- Parameters:
c
- the characteradvance
- the character advance normalized to 1000 units- Returns:
true
if the advance was set,false
otherwise
-
getCharBBox
public int[] getCharBBox(int c) Gets the smallest box enclosing the character contours. It will returnnull
if the font has not the information or the character has no contours, as in the case of the space, for example. Characters with no contours may also return [0,0,0,0].- Parameters:
c
- the character to get the contour bounding box from- Returns:
- an array of four floats with the bounding box in the format [llx,lly,urx,ury] or
null
-
getRawCharBBox
-
correctArabicAdvance
public void correctArabicAdvance()iText expects Arabic Diactrics (tashkeel) to have zero advance but some fonts, most notably those that come with Windows, like times.ttf, have non-zero advance for those characters. This method makes those character to have zero width advance and work correctly in the iText Arabic shaping and reordering context. -
addSubsetRange
public void addSubsetRange(int[] range) Adds a character range when subsetting. The range is anint
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
-
getCompressionLevel
public int getCompressionLevel()Returns the compression level used for the font streams.- Returns:
- the compression level (0 = best speed, 9 = best compression, -1 is default)
- Since:
- 2.1.3
-
setCompressionLevel
public void setCompressionLevel(int compressionLevel) Sets the compression level to be used for the font streams.- Parameters:
compressionLevel
- a value between 0 (best speed) and 9 (best compression)- Since:
- 2.1.3
-
isIncludeCidSet
public boolean isIncludeCidSet()Indicates if a CIDSet stream should be included in the document forTrueTypeFontUnicode
.- Returns:
true
to include a CIDSet stream.
-
setIncludeCidSet
public void setIncludeCidSet(boolean includeCidSet) Indicates if a CIDSet stream should be included in the document forTrueTypeFontUnicode
. When set totrue
, a CIDSet stream will be included in the document. When set tofalse
, andPdfWriter.getPDFXConformance()
does not require it, no CIDSet stream will be included.- Parameters:
includeCidSet
- new value ofincludeCidSet
-