com.lowagie.text.pdf
public abstract class BaseFont extends Object
Nested Class Summary | |
---|---|
static class | BaseFont.StreamFont Generates the PDF stream with the Type1 and Truetype fonts returning
a PdfStream. |
Field Summary | |
---|---|
static int | ASCENT The maximum height above the baseline reached by glyphs in this
font, excluding the height of glyphs for accented characters. |
static int | AWT_ASCENT java.awt.Font property |
static int | AWT_DESCENT java.awt.Font property |
static int | AWT_LEADING java.awt.Font property |
static int | AWT_MAXADVANCE java.awt.Font property |
static int | BBOXLLX The lower left x glyph coordinate. |
static int | BBOXLLY The lower left y glyph coordinate. |
static int | BBOXURX The upper right x glyph coordinate. |
static int | BBOXURY The upper right y glyph coordinate. |
protected static HashMap | BuiltinFonts14 list of the 14 built in fonts. |
protected int[][] | charBBoxes |
protected int | compressionLevel
The compression level for the font stream. |
static boolean | CACHED if the font has to be cached |
static int | CAPHEIGHT The y coordinate of the top of flat capital letters, measured from
the baseline. |
static int[] | CHAR_RANGE_ARABIC |
static int[] | CHAR_RANGE_CYRILLIC |
static int[] | CHAR_RANGE_HEBREW |
static int[] | CHAR_RANGE_LATIN |
static char | CID_NEWLINE The fake CID code that represents a newline. |
static String | COURIER This is a possible value of a base 14 type 1 font |
static String | COURIER_BOLD This is a possible value of a base 14 type 1 font |
static String | COURIER_BOLDOBLIQUE This is a possible value of a base 14 type 1 font |
static String | COURIER_OBLIQUE This is a possible value of a base 14 type 1 font |
static String | CP1250 A possible encoding. |
static String | CP1252 A possible encoding. |
static String | CP1257 A possible encoding. |
protected String[] | differences encoding names |
protected boolean | directTextToByte Converts char directly to byte
by casting. |
static int | DESCENT The maximum depth below the baseline reached by glyphs in this
font. |
protected boolean | embedded true if the font is to be embedded in the PDF |
protected String | encoding encoding used with this font |
static boolean | EMBEDDED if the font has to be embedded |
protected boolean | fastWinansi |
protected static HashMap | fontCache cache for the fonts already used. |
protected boolean | fontSpecific
true if the font must use it's built in encoding. |
int | fontType The font type. |
protected boolean | forceWidthsOutput Forces the output of the width array. |
static int | FONT_TYPE_CJK The font is CJK. |
static int | FONT_TYPE_DOCUMENT A font already inside the document. |
static int | FONT_TYPE_T1 The font is Type 1. |
static int | FONT_TYPE_T3 A Type3 font. |
static int | FONT_TYPE_TT The font is True Type with a standard encoding. |
static int | FONT_TYPE_TTUNI The font is True Type with a Unicode encoding. |
static String | HELVETICA This is a possible value of a base 14 type 1 font |
static String | HELVETICA_BOLD This is a possible value of a base 14 type 1 font |
static String | HELVETICA_BOLDOBLIQUE This is a possible value of a base 14 type 1 font |
static String | HELVETICA_OBLIQUE This is a possible value of a base 14 type 1 font |
static String | IDENTITY_H The Unicode encoding with horizontal writing. |
static String | IDENTITY_V The Unicode encoding with vertical writing. |
static int | ITALICANGLE The angle, expressed in degrees counterclockwise from the vertical,
of the dominant vertical strokes of the font. |
static String | MACROMAN A possible encoding. |
static String | notdef a not defined character in a custom PDF encoding |
static boolean | NOT_CACHED if the font doesn't have to be cached |
static boolean | NOT_EMBEDDED if the font doesn't have to be embedded |
static String | RESOURCE_PATH The path to the font resources. |
protected IntHashtable | specialMap
Custom encodings use this map to key the Unicode character
to the single byte code. |
protected boolean | subset Indicates if all the glyphs and widths for that particular
encoding should be included in the document. |
protected ArrayList | subsetRanges |
static int | STRIKETHROUGH_POSITION
The strikethrough position. |
static int | STRIKETHROUGH_THICKNESS
The strikethrough thickness. |
static int | SUBSCRIPT_OFFSET
The recommended vertical offset from the baseline for subscripts for this font. |
static int | SUBSCRIPT_SIZE
The recommended vertical size for subscripts for this font. |
static int | SUPERSCRIPT_OFFSET
The recommended vertical offset from the baseline for superscripts for this font. |
static int | SUPERSCRIPT_SIZE
The recommended vertical size for superscripts for this font. |
static String | SYMBOL This is a possible value of a base 14 type 1 font |
static String | TIMES_BOLD This is a possible value of a base 14 type 1 font |
static String | TIMES_BOLDITALIC This is a possible value of a base 14 type 1 font |
static String | TIMES_ITALIC This is a possible value of a base 14 type 1 font |
static String | TIMES_ROMAN This is a possible value of a base 14 type 1 font |
protected char[] | unicodeDifferences same as differences but with the unicode codes |
static int | UNDERLINE_POSITION
The undeline position. |
static int | UNDERLINE_THICKNESS
The underline thickness. |
protected int[] | widths table of characters widths for this encoding |
static String | WINANSI A possible encoding. |
static String | ZAPFDINGBATS This is a possible value of a base 14 type 1 font |
Constructor Summary | |
---|---|
protected | BaseFont()
Creates new BaseFont |
Method Summary | |
---|---|
static void | addFont(PRIndirectReference fontRef, IntHashtable hits, ArrayList fonts) |
void | addSubsetRange(int[] range)
Adds a character range when subsetting. |
boolean | charExists(int c)
Checks if a character exists in this font. |
byte[] | convertToBytes(String text)
Converts a String to a byte array according
to the font's encoding. |
byte[] | convertToBytes(int char1)
Converts a char to a byte array according
to the font's encoding. |
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. |
protected void | createEncoding()
Creates the widths and the differences arrays |
static BaseFont | createFont()
Creates a new font. |
static BaseFont | createFont(String name, String encoding, boolean embedded)
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(PRIndirectReference fontRef)
Creates a font based on an existing document font. |
static String | createSubsetPrefix() Creates a unique subset prefix to be added to the font name when the font is embedded and subset. |
static String[] | enumerateTTCNames(String ttcFile) Enumerates the postscript font names present inside a
True Type Collection. |
static String[] | enumerateTTCNames(byte[] ttcArray) 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[][] | getAllNameEntries() 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 | getAscent(String text)
Gets the ascent of a String in normalized 1000 units. |
float | getAscentPoint(String text, float fontSize)
Gets the ascent of a String 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[] | getCodePagesSupported() Gets the code pages supported by the font. |
int | getCompressionLevel()
Returns the compression level used for the font streams. |
int | getDescent(String text)
Gets the descent of a String in normalized 1000 units. |
float | getDescentPoint(String text, float fontSize)
Gets the descent of a String in points. |
String[] | getDifferences() Gets the array with the names of the characters. |
static ArrayList | getDocumentFonts(PdfReader reader)
Gets a list of all document fonts. |
static ArrayList | getDocumentFonts(PdfReader reader, int page)
Gets a list of the document fonts in a particular page. |
String | getEncoding() Gets the encoding used to convert String into byte[] . |
abstract String[][] | getFamilyFontName() Gets the family name of the font. |
abstract float | getFontDescriptor(int key, float fontSize) Gets the font parameter identified by key . |
int | getFontType() Gets the font type. |
abstract String[][] | getFullFontName() Gets the full name of the font. |
static String[][] | getFullFontName(String name, String encoding, byte[] ttfAfm) Gets the full name of the font. |
abstract PdfStream | getFullFontStream()
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 | getPostscriptFontName() Gets the postscript font name. |
protected abstract int[] | getRawCharBBox(int c, String name) |
abstract int | getRawWidth(int c, String name)
Gets the width from the font according to the Unicode char c
or the name . |
static InputStream | getResourceStream(String key) Gets the font resources. |
static InputStream | getResourceStream(String key, ClassLoader loader) Gets the font resources. |
char | getUnicodeDifferences(int index) Gets the Unicode character corresponding to the byte output to the pdf stream. |
char[] | getUnicodeDifferences() Gets the array with the unicode characters. |
int | getUnicodeEquivalent(int c) Gets the Unicode equivalent to a CID.
|
int | getWidth(int char1)
Gets the width of a char in normalized 1000 units. |
int | getWidth(String text)
Gets the width of a String in normalized 1000 units. |
float | getWidthPoint(String text, float fontSize)
Gets the width of a String in points. |
float | getWidthPoint(int char1, float fontSize)
Gets the width of a char in points. |
float | getWidthPointKerned(String text, float fontSize)
Gets the width of a String in points taking kerning
into account. |
int[] | getWidths() Gets the font width array. |
abstract boolean | hasKernPairs() Checks if the font has any kerning pairs. |
boolean | isDirectTextToByte() Gets the direct conversion of char to byte . |
boolean | isEmbedded() Gets the embedded flag. |
boolean | isFontSpecific() Gets the symbolic flag of the font. |
boolean | isForceWidthsOutput() Gets the state of the property. |
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. |
static void | recourseFonts(PdfDictionary page, IntHashtable hits, ArrayList 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 of char directly to byte
by casting. |
void | setForceWidthsOutput(boolean forceWidthsOutput) Set to true to force the generation of the
widths array. |
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 | setSubset(boolean subset) Indicates if all the glyphs and widths for that particular
encoding should be included in the document. |
abstract void | writeFont(PdfWriter writer, PdfIndirectReference ref, Object[] params) Outputs to the writer the font dictionaries and streams. |
Since: 2.1.3
char
directly to byte
by casting.encoding
is only used to map a char to the position inside
the font, not to the expected char name.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
Parameters: c the character to check
Returns: true
if the character has a glyph,
false
otherwise
String
to a byte array according
to the font's encoding.Parameters: text the String
to be converted
Returns: an array of byte
representing the conversion according to the font's encoding
char
to a byte array according
to the font's encoding.Parameters: char1 the char
to be converted
Returns: an array of byte
representing the conversion according to the font's encoding
widths
and the differences
arraysReturns: a BaseFont object (Helvetica, Winansi, not embedded)
Throws: IOException This shouldn't occur ever DocumentException This shouldn't occur ever
Since: 2.1.1
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 it's location on file encoding the encoding to be applied to this font embedded 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 invalid IOException the font file could not be read
The fonts may or may not be cached depending on the flag cached
.
If the byte
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 it's location on file encoding the encoding to be applied to this font embedded true if the font is to be embedded in the PDF cached true if the font comes from the cache or is added to the cache if new, false if the font is always created new ttfAfm the true type font or the afm in a byte array pfb 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 invalid IOException the font file could not be read
The fonts may or may not be cached depending on the flag cached
.
If the byte
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 it's location on file encoding the encoding to be applied to this font embedded true if the font is to be embedded in the PDF cached true if the font comes from the cache or is added to the cache if new, false if the font is always created new ttfAfm the true type font or the afm in a byte array pfb the pfb in a byte array noThrow 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 invalid IOException the font file could not be read
Parameters: fontRef the reference to the document font
Returns: the font
Returns: the subset prefix
Parameters: ttcFile the file name of the font
Returns: the postscript font names
Throws: DocumentException on error IOException on error
Parameters: ttcArray the font as a byte
array
Returns: the postscript font names
Throws: DocumentException on error IOException on error
Parameters: name the name of the font encoding the encoding of the font ttfAfm the true type font or the afm in a byte array
Returns: an array of Object[] built with {getPostscriptFontName(), getFamilyFontName(), getFullFontName()}
Throws: DocumentException on error IOException on error
Returns: the full name of the font
Since: 2.0.8
Parameters: name the name of the font encoding the encoding of the font ttfAfm the true type font or the afm in a byte array
Returns: an array of Object[] built with {getPostscriptFontName(), getFamilyFontName(), getFullFontName()}
Throws: DocumentException on error IOException on error
Since: 2.0.8
String
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 the String
to get the ascent of
Returns: the ascent in normalized 1000 units
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 size of the font
Returns: the ascent in points
Parameters: name the full name of the font
Returns: the name without the modifiers Bold, Italic or BoldItalic
null
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
Parameters: c the Unicode
Returns: the CID equivalent
Returns: the code pages supported by the font
Returns: the compression level (0 = best speed, 9 = best compression, -1 is default)
Since: 2.1.3
String
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 the String
to get the descent of
Returns: the descent in normalized 1000 units
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 size of the font
Returns: the descent in points
Returns: the array with the names of the characters
ArrayList
contains a Object[]{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
ArrayList
contains a Object[]{String,PRIndirectReference}
with the font name
and the indirect reference to it.Parameters: reader the document where the fonts are to be listed from page the page to list the fonts from
Returns: the list of fonts and references
String
into byte[]
.Returns: the encoding name
Returns: the family name of the font
key
. Valid values
for key
are ASCENT
, AWT_ASCENT
, CAPHEIGHT
,
DESCENT
, AWT_DESCENT
,
ITALICANGLE
, BBOXLLX
, BBOXLLY
, BBOXURX
and BBOXURY
.Parameters: key the parameter to be extracted fontSize the font size in points
Returns: the parameter in points
Returns: the font type
Returns: the full name of the font
Parameters: name the name of the font encoding the encoding of the font ttfAfm the true type font or the afm in a byte array
Returns: the full name of the font
Throws: DocumentException on error IOException on error
Returns: a PdfStream with the font program
Since: 2.1.3
Parameters: char1 the first char char2 the second char
Returns: the kerning to be applied in normalized 1000 units
Returns: the postscript font name
c
or the name
. If the name
is null it's a symbolic font.Parameters: c the unicode char name the glyph name
Returns: the width of the char
Parameters: key the full name of the resource
Returns: the InputStream
to get the resource or
null
if not found
Parameters: key the full name of the resource loader the ClassLoader to load the resource or null to try the ones available
Returns: the InputStream
to get the resource or
null
if not found
Parameters: index the byte index
Returns: the Unicode character
Returns: the array with the unicode characters
Parameters: c the CID code
Returns: the Unicode equivalent
char
in normalized 1000 units.Parameters: char1 the unicode char
to get the width of
Returns: the width in normalized 1000 units
String
in normalized 1000 units.Parameters: text the String
to get the witdth of
Returns: the width in normalized 1000 units
String
in points.Parameters: text the String
to get the width of fontSize the font size
Returns: the width in points
char
in points.Parameters: char1 the char
to get the width of fontSize the font size
Returns: the width in points
String
in points taking kerning
into account.Parameters: text the String
to get the witdth of fontSize the font size
Returns: the width in points
Returns: the font width array
Returns: true
if the font has any kerning pairs
char
to byte
.Returns: value of property directTextToByte.
See Also: BaseFont
Returns: true
if the font is embedded.
Returns: true
if the font is symbolic
Returns: value of property forceWidthsOutput
Returns: false
to include all the glyphs and widths.
Parameters: enc the encoding to be normalized
Returns: the normalized encoding
Parameters: c the character advance the character advance normalized to 1000 units
Returns: true
if the advance was set,
false
otherwise
Parameters: compressionLevel a value between 0 (best speed) and 9 (best compression)
Since: 2.1.3
char
directly to byte
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.
true
to force the generation of the
widths array.Parameters: forceWidthsOutput true
to force the generation of the
widths array
Parameters: char1 the first char char2 the second char kern the kerning to apply in normalized 1000 units
Returns: true
if the kerning was applied, false
otherwise
Parameters: name the new font name
true
only the glyphs used will be included in the font. When set to false
and (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
Parameters: writer the writer for this document ref the font indirect reference params several parameters that depend on the font type
Throws: IOException on error DocumentException error in generating the object