|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.lowagie.text.pdf.BaseFont
Base class for the several font types supported
Nested Class Summary | |
(package private) 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
|
static int |
AWT_DESCENT
|
static int |
AWT_LEADING
|
static int |
AWT_MAXADVANCE
|
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. |
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 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. |
static int |
DESCENT
The maximum depth below the baseline reached by glyphs in this font. |
protected String[] |
differences
encoding names |
protected boolean |
directTextToByte
Converts char directly to byte
by casting. |
protected boolean |
embedded
true if the font is to be embedded in the PDF |
static boolean |
EMBEDDED
if the font has to be embedded |
protected String |
encoding
encoding used with this font |
protected boolean |
fastWinansi
|
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_TT
The font is True Type with a standard encoding. |
static int |
FONT_TYPE_TTUNI
The font is True Type with a Unicode encoding. |
protected static HashMap |
fontCache
cache for the fonts already used. |
protected boolean |
fontSpecific
true if the font must use it's built in encoding. |
(package private) int |
fontType
The font type. |
protected boolean |
forceWidthsOutput
Forces the output of the width array. |
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 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 |
notdef
a not defined character in a custom PDF encoding |
static String |
RESOURCE_PATH
The path to the font resources. |
protected boolean |
subset
Indicates if all the glyphs and widths for that particular encoding should be included in the document. |
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 |
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 | |
boolean |
charExists(char c)
Checks if a character exists in this font. |
(package private) byte[] |
convertToBytes(String text)
Converts a String to a byte array according
to the font's encoding. |
protected void |
createEncoding()
Creates the widths and the differences arrays |
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 String |
createSubsetPrefix()
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. |
protected static String |
getBaseName(String name)
Gets the name without the modifiers Bold, Italic or BoldItalic. |
char |
getCidCode(char c)
Gets the CID code given an Unicode. |
String[] |
getCodePagesSupported()
Gets the code pages supported by the font. |
String[] |
getDifferences()
Gets the array with the names of the characters. |
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 int |
getKerning(char char1,
char char2)
Gets the kerning between two Unicode chars. |
abstract String |
getPostscriptFontName()
Gets the postscript font name. |
(package private) 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()
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. |
char |
getUnicodeEquivalent(char c)
Gets the Unicode equivalent to a CID. |
int |
getWidth(char 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(char char1,
float fontSize)
Gets the width of a char in points. |
float |
getWidthPoint(String text,
float fontSize)
Gets the width of a String 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. |
boolean |
setCharAdvance(char c,
int advance)
Sets the character advance. |
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. |
void |
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. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String COURIER
public static final String COURIER_BOLD
public static final String COURIER_OBLIQUE
public static final String COURIER_BOLDOBLIQUE
public static final String HELVETICA
public static final String HELVETICA_BOLD
public static final String HELVETICA_OBLIQUE
public static final String HELVETICA_BOLDOBLIQUE
public static final String SYMBOL
public static final String TIMES_ROMAN
public static final String TIMES_BOLD
public static final String TIMES_ITALIC
public static final String TIMES_BOLDITALIC
public static final String ZAPFDINGBATS
public static final int ASCENT
public static final int CAPHEIGHT
public static final int DESCENT
public static final int ITALICANGLE
public static final int BBOXLLX
public static final int BBOXLLY
public static final int BBOXURX
public static final int BBOXURY
public static final int AWT_ASCENT
public static final int AWT_DESCENT
public static final int AWT_LEADING
public static final int AWT_MAXADVANCE
public static final int FONT_TYPE_T1
public static final int FONT_TYPE_TT
public static final int FONT_TYPE_CJK
public static final int FONT_TYPE_TTUNI
public static final int FONT_TYPE_DOCUMENT
public static final String IDENTITY_H
public static final String IDENTITY_V
public static final String CP1250
public static final String CP1252
public static final String CP1257
public static final String WINANSI
public static final String MACROMAN
public static final boolean EMBEDDED
public static final boolean NOT_EMBEDDED
public static final boolean CACHED
public static final boolean NOT_CACHED
public static final String RESOURCE_PATH
public static final char CID_NEWLINE
int fontType
public static final String notdef
protected int[] widths
protected String[] differences
protected char[] unicodeDifferences
protected String encoding
protected boolean embedded
protected boolean fontSpecific
encoding
is only used to map a char to the position inside
the font, not to the expected char name.
protected static HashMap fontCache
protected static final HashMap BuiltinFonts14
protected boolean forceWidthsOutput
protected boolean directTextToByte
char
directly to byte
by casting.
protected boolean subset
protected boolean fastWinansi
Constructor Detail |
protected BaseFont()
Method Detail |
public static BaseFont createFont(String name, String encoding, boolean embedded) throws DocumentException, IOException
The fonts are cached and if they already exist they are extracted from the cache, not parsed again.
This method calls:
createFont(name, encoding, embedded, true, null, null);
name
- the name of the font or it's location on fileencoding
- the encoding to be applied to this fontembedded
- true if the font is to be embedded in the PDF
DocumentException
- the font is invalid
IOException
- the font file could not be readpublic static BaseFont createFont(String name, String encoding, boolean embedded, boolean cached, byte[] ttfAfm, byte[] pfb) throws DocumentException, IOException
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. The name is still required to identify
the font type.
name
- the name of the font or it's 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
DocumentException
- the font is invalid
IOException
- the font file could not be readprotected static String getBaseName(String name)
name
- the full name of the font
protected static String normalizeEncoding(String enc)
enc
- the encoding to be normalized
protected void createEncoding()
widths
and the differences
arrays
UnsupportedEncodingException
- the encoding is not supportedabstract int getRawWidth(int c, String name)
c
or the name
. If the name
is null it's a symbolic font.
c
- the unicode charname
- the glyph name
public abstract int getKerning(char char1, char char2)
char1
- the first charchar2
- the second char
public int getWidth(char char1)
char
in normalized 1000 units.
char1
- the unicode char
to get the width of
public int getWidth(String text)
String
in normalized 1000 units.
text
- the String
to get the witdth of
public float getWidthPointKerned(String text, float fontSize)
String
in points taking kerning
into account.
text
- the String
to get the witdth offontSize
- the font size
public float getWidthPoint(String text, float fontSize)
String
in points.
text
- the String
to get the witdth offontSize
- the font size
public float getWidthPoint(char char1, float fontSize)
char
in points.
char1
- the char
to get the witdth offontSize
- the font size
byte[] convertToBytes(String text)
String
to a byte array according
to the font's encoding.
text
- the String
to be converted
byte
representing the conversion according to the font's encodingabstract void writeFont(PdfWriter writer, PdfIndirectReference ref, Object[] params) throws DocumentException, IOException
writer
- the writer for this documentref
- the font indirect referenceparams
- several parameters that depend on the font type
IOException
- on error
DocumentException
- error in generating the objectpublic String getEncoding()
String
into byte[]
.
public abstract float getFontDescriptor(int key, float fontSize)
key
. Valid values
for key
are ASCENT
, CAPHEIGHT
, DESCENT
,
ITALICANGLE
, BBOXLLX
, BBOXLLY
, BBOXURX
and BBOXURY
.
key
- the parameter to be extractedfontSize
- the font size in points
public int getFontType()
public boolean isEmbedded()
true
if the font is embedded.public boolean isFontSpecific()
true
if the font is symbolicpublic static String createSubsetPrefix()
char getUnicodeDifferences(int index)
index
- the byte index
public abstract String getPostscriptFontName()
public abstract String[][] getFullFontName()
public static String[][] getFullFontName(String name, String encoding, byte[] ttfAfm) throws DocumentException, IOException
name
- the name of the fontencoding
- the encoding of the fontttfAfm
- the true type font or the afm in a byte array
DocumentException
- on error
IOException
- on errorpublic static Object[] getAllFontNames(String name, String encoding, byte[] ttfAfm) throws DocumentException, IOException
name
- the name of the fontencoding
- the encoding of the fontttfAfm
- the true type font or the afm in a byte array
DocumentException
- on error
IOException
- on errorpublic abstract String[][] getFamilyFontName()
public String[] getCodePagesSupported()
public static String[] enumerateTTCNames(String ttcFile) throws DocumentException, IOException
ttcFile
- the file name of the font
DocumentException
- on error
IOException
- on errorpublic static String[] enumerateTTCNames(byte[] ttcArray) throws DocumentException, IOException
ttcArray
- the font as a byte
array
DocumentException
- on error
IOException
- on errorpublic int[] getWidths()
public String[] getDifferences()
public char[] getUnicodeDifferences()
public boolean isForceWidthsOutput()
public void setForceWidthsOutput(boolean forceWidthsOutput)
true
to force the generation of the
widths array.
forceWidthsOutput
- true
to force the generation of the
widths arraypublic boolean isDirectTextToByte()
char
to byte
.
setDirectTextToByte(boolean directTextToByte)
public void setDirectTextToByte(boolean directTextToByte)
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().
directTextToByte
- New value of property directTextToByte.public boolean isSubset()
false
to include all the glyphs and widths.public void setSubset(boolean subset)
false
to include all.
subset
- new value of property subsetpublic static InputStream getResourceStream(String key)
key
- the full name of the resource
InputStream
to get the resource or
null
if not foundpublic static InputStream getResourceStream(String key, ClassLoader loader)
key
- the full name of the resourceloader
- the ClassLoader to load the resource or null to try the ones available
InputStream
to get the resource or
null
if not foundpublic char getUnicodeEquivalent(char c)
c
- the CID code
public char getCidCode(char c)
c
- the Unicode
public abstract boolean hasKernPairs()
true
if the font has any kerning pairspublic boolean charExists(char c)
c
- the character to check
true
if the character has a glyph,
false
otherwisepublic boolean setCharAdvance(char c, int advance)
c
- the characteradvance
- the character advance normalized to 1000 units
true
if the advance was set,
false
otherwise
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |