Package com.itextpdf.text.pdf
Class CJKFont
java.lang.Object
com.itextpdf.text.pdf.BaseFont
com.itextpdf.text.pdf.CJKFont
Creates a CJK font compatible with the fonts in the Adobe Asian font Pack.
-
Nested Class Summary
Nested classes/interfaces inherited from class com.itextpdf.text.pdf.BaseFont
BaseFont.StreamFont -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final intprivate CMapCidByteprivate booleanprivate CMapCidUni(package private) static final StringThe encoding used in the PDF document for CJK fonts(package private) static Properties(package private) static Propertiesprivate StringThe CMap name associated with this fontprivate static final intprivate StringThe font nameprivate IntHashtableprivate static booleanstatic final StringThe path to the font resources.private static final intprivate StringThe style modifierprivate CMapUniCidprivate Stringprivate static final intprivate IntHashtableFields inherited from class com.itextpdf.text.pdf.BaseFont
ASCENT, AWT_ASCENT, AWT_DESCENT, AWT_LEADING, AWT_MAXADVANCE, BBOXLLX, BBOXLLY, BBOXURX, BBOXURY, BuiltinFonts14, CACHED, CAPHEIGHT, CHAR_RANGE_ARABIC, CHAR_RANGE_CYRILLIC, CHAR_RANGE_HEBREW, CHAR_RANGE_LATIN, charBBoxes, CID_NEWLINE, compressionLevel, COURIER, COURIER_BOLD, COURIER_BOLDOBLIQUE, COURIER_OBLIQUE, CP1250, CP1252, CP1257, DEFAULT_FONT_MATRIX, DESCENT, differences, directTextToByte, embedded, EMBEDDED, encoding, fastWinansi, FONT_TYPE_CJK, FONT_TYPE_DOCUMENT, FONT_TYPE_T1, FONT_TYPE_T3, FONT_TYPE_TT, FONT_TYPE_TTUNI, FONT_WEIGHT, fontCache, fontSpecific, fontType, forceWidthsOutput, HELVETICA, HELVETICA_BOLD, HELVETICA_BOLDOBLIQUE, HELVETICA_OBLIQUE, IDENTITY_H, IDENTITY_V, ITALICANGLE, MACROMAN, NOT_CACHED, NOT_EMBEDDED, notdef, PARAGRAPH_SEPARATOR, RESOURCE_PATH, specialMap, STRIKETHROUGH_POSITION, STRIKETHROUGH_THICKNESS, SUBSCRIPT_OFFSET, SUBSCRIPT_SIZE, subset, subsetRanges, SUPERSCRIPT_OFFSET, SUPERSCRIPT_SIZE, SYMBOL, TIMES_BOLD, TIMES_BOLDITALIC, TIMES_ITALIC, TIMES_ROMAN, UNDERLINE_POSITION, UNDERLINE_THICKNESS, unicodeDifferences, vertical, WEIGHT_CLASS, WIDTH_CLASS, widths, WINANSI, ZAPFDINGBATS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleancharExists(int c) Checks if a character exists in this font.(package private) byte[]convertToBytes(int char1) Converts acharto a byte array according to the font's encoding.byte[]convertToBytes(String text) Converts aStringto a byte array according to the font's encoding.(package private) static StringconvertToHCIDMetrics(int[] keys, IntHashtable h) (package private) static StringconvertToVCIDMetrics(int[] keys, IntHashtable v, IntHashtable h) (package private) static IntHashtableString[][]Gets all the entries of the names-table.private floatgetBBox(int idx) int[]getCharBBox(int c) Gets the smallest box enclosing the character contours.intgetCidCode(int c) Gets the CID code given an Unicode.private PdfDictionarygetCIDFont(PdfIndirectReference fontDescriptor, IntHashtable cjkTag) static StringGetCompatibleFont(String enc) Returns a font compatible with a CJK encoding or null if not found.private floatgetDescNumber(String name) String[][]Gets the family name of the font.private PdfDictionarygetFontBaseType(PdfIndirectReference CIDFont) private PdfDictionaryfloatgetFontDescriptor(int key, float fontSize) Gets the font parameter identified bykey.String[][]Gets the full name of the font.You can't get the FontStream of a CJK font (CJK fonts are never embedded), so this method always returns null.intgetKerning(int char1, int char2) Gets the kerning between two Unicode chars.Gets the postscript font name.protected int[]getRawCharBBox(int c, String name) (package private) intgetRawWidth(int c, String name) Gets the width from the font according to the Unicode charcor thename.intgetUnicodeEquivalent(int c) Gets the Unicode equivalent to a CID.(package private) StringintgetWidth(int char1) Gets the width of acharin normalized 1000 units.intGets the width of aStringin normalized 1000 units.booleanChecks if the font has any kerning pairs.static booleanChecks if its a valid CJK font.booleanprivate voidprivate static voidprivate static voidreadFontProperties(String name) booleansetCharAdvance(int c, int advance) Sets the character advance.booleansetKerning(int char1, int char2, int kern) Sets the kerning between two Unicode chars.voidsetPostscriptFontName(String name) Sets the font name that will appear in the pdf font dictionary.(package private) voidwriteFont(PdfWriter writer, PdfIndirectReference ref, Object[] params) Outputs to the writer the font dictionaries and streams.Methods inherited from class com.itextpdf.text.pdf.BaseFont
addSubsetRange, correctArabicAdvance, createBuiltInFontDictionary, createEncoding, createFont, createFont, createFont, createFont, createFont, createFont, createFont, createSubsetPrefix, enumerateTTCNames, enumerateTTCNames, getAllFontNames, getAllNameEntries, getAscent, getAscentPoint, getBaseName, getCodePagesSupported, getCompressionLevel, getDescent, getDescentPoint, getDifferences, getDocumentFonts, getDocumentFonts, getEncoding, getFontMatrix, getFontType, getFullFontName, getSubfamily, getUnicodeDifferences, getUnicodeDifferences, getWidthPoint, getWidthPoint, getWidthPointKerned, getWidths, isDirectTextToByte, isEmbedded, isFontSpecific, isForceWidthsOutput, isSubset, isVertical, normalizeEncoding, setCompressionLevel, setDirectTextToByte, setFontDescriptor, setForceWidthsOutput, setSubset
-
Field Details
-
CJK_ENCODING
The encoding used in the PDF document for CJK fonts- See Also:
-
FIRST
private static final int FIRST- See Also:
-
BRACKET
private static final int BRACKET- See Also:
-
SERIAL
private static final int SERIAL- See Also:
-
V1Y
private static final int V1Y- See Also:
-
cjkFonts
-
cjkEncodings
-
allFonts
-
propertiesLoaded
private static boolean propertiesLoaded -
RESOURCE_PATH_CMAP
The path to the font resources.- See Also:
-
registryNames
-
cidByte
-
uniCid
-
cidUni
-
uniMap
-
fontName
The font name -
style
The style modifier -
CMap
The CMap name associated with this font -
cidDirect
private boolean cidDirect -
vMetrics
-
hMetrics
-
fontDesc
-
-
Constructor Details
-
CJKFont
CJKFont(String fontName, String enc, boolean emb) throws DocumentException Creates a CJK font.- Parameters:
fontName- the name of the fontenc- the encoding of the fontemb- alwaysfalse. CJK font and not embedded- Throws:
DocumentException- on error
-
-
Method Details
-
loadProperties
private static void loadProperties() -
loadRegistry
- Throws:
IOException
-
getUniMap
String getUniMap() -
loadCMaps
- Throws:
DocumentException
-
GetCompatibleFont
Returns a font compatible with a CJK encoding or null if not found.- Parameters:
enc-- Returns:
-
isCJKFont
Checks if its a valid CJK font.- Parameters:
fontName- the font nameenc- the encoding- Returns:
trueif it is CJK font
-
getWidth
public int getWidth(int char1) Gets the width of acharin normalized 1000 units. -
getWidth
Description copied from class:BaseFontGets the width of aStringin normalized 1000 units. -
getRawWidth
Description copied from class:BaseFontGets the width from the font according to the Unicode charcor thename. If thenameis null it's a symbolic font.- Specified by:
getRawWidthin classBaseFont- Parameters:
c- the unicode charname- the glyph name- Returns:
- the width of the char
-
getKerning
public int getKerning(int char1, int char2) Description copied from class:BaseFontGets the kerning between two Unicode chars.- Specified by:
getKerningin classBaseFont- Parameters:
char1- the first charchar2- the second char- Returns:
- the kerning to be applied in normalized 1000 units
-
getFontDescriptor
-
getCIDFont
-
getFontBaseType
-
writeFont
void writeFont(PdfWriter writer, PdfIndirectReference ref, Object[] params) throws DocumentException, IOException Description copied from class:BaseFontOutputs to the writer the font dictionaries and streams.- Specified by:
writeFontin classBaseFont- Parameters:
writer- the writer for this documentref- the font indirect referenceparams- several parameters that depend on the font type- Throws:
DocumentException- error in generating the objectIOException- on error
-
getFullFontStream
You can't get the FontStream of a CJK font (CJK fonts are never embedded), so this method always returns null.- Specified by:
getFullFontStreamin classBaseFont- Returns:
- null
- Since:
- 2.1.3
-
getDescNumber
-
getBBox
private float getBBox(int idx) -
getFontDescriptor
public float getFontDescriptor(int key, float fontSize) Gets the font parameter identified bykey. Valid values forkeyareASCENT,CAPHEIGHT,DESCENTandITALICANGLE.- Specified by:
getFontDescriptorin classBaseFont- Parameters:
key- the parameter to be extractedfontSize- the font size in points- Returns:
- the parameter in points
-
getPostscriptFontName
Description copied from class:BaseFontGets the postscript font name.- Specified by:
getPostscriptFontNamein classBaseFont- Returns:
- the postscript 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}.- Specified by:
getFullFontNamein classBaseFont- 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}.- Specified by:
getAllNameEntriesin classBaseFont- Returns:
- the full name of the font
-
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}.- Specified by:
getFamilyFontNamein classBaseFont- Returns:
- the family name of the font
-
createMetric
-
convertToHCIDMetrics
-
convertToVCIDMetrics
-
readFontProperties
- Throws:
IOException
-
getUnicodeEquivalent
public int getUnicodeEquivalent(int c) Description copied from class:BaseFontGets the Unicode equivalent to a CID. The (inexistent) CIDis translated as '\n'. It has only meaning with CJK fonts with Identity encoding. - Overrides:
getUnicodeEquivalentin classBaseFont- Parameters:
c- the CID code- Returns:
- the Unicode equivalent
-
getCidCode
public int getCidCode(int c) Description copied from class:BaseFontGets the CID code given an Unicode. It has only meaning with CJK fonts.- Overrides:
getCidCodein classBaseFont- Parameters:
c- the Unicode- Returns:
- the CID equivalent
-
hasKernPairs
public boolean hasKernPairs()Checks if the font has any kerning pairs.- Specified by:
hasKernPairsin classBaseFont- Returns:
- always
false
-
charExists
public boolean charExists(int c) Checks if a character exists in this font.- Overrides:
charExistsin classBaseFont- Parameters:
c- the character to check- Returns:
trueif the character has a glyph,falseotherwise
-
setCharAdvance
public boolean setCharAdvance(int c, int advance) Sets the character advance.- Overrides:
setCharAdvancein classBaseFont- Parameters:
c- the characteradvance- the character advance normalized to 1000 units- Returns:
trueif the advance was set,falseotherwise. Will always returnfalse
-
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.- Specified by:
setPostscriptFontNamein classBaseFont- Parameters:
name- the new font name
-
setKerning
public boolean setKerning(int char1, int char2, int kern) Description copied from class:BaseFontSets the kerning between two Unicode chars.- Specified by:
setKerningin classBaseFont- Parameters:
char1- the first charchar2- the second charkern- the kerning to apply in normalized 1000 units- Returns:
trueif the kerning was applied,falseotherwise
-
getCharBBox
public int[] getCharBBox(int c) Description copied from class:BaseFontGets the smallest box enclosing the character contours. It will returnnullif 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].- Overrides:
getCharBBoxin classBaseFont- 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
- Specified by:
getRawCharBBoxin classBaseFont
-
convertToBytes
Converts aStringto a byte array according to the font's encoding.- Overrides:
convertToBytesin classBaseFont- Parameters:
text- theStringto be converted- Returns:
- an array of
byterepresenting the conversion according to the font's encoding
-
convertToBytes
byte[] convertToBytes(int char1) Converts acharto a byte array according to the font's encoding.- Overrides:
convertToBytesin classBaseFont- Parameters:
char1- thecharto be converted- Returns:
- an array of
byterepresenting the conversion according to the font's encoding
-
isIdentity
public boolean isIdentity()
-