Class BaseFont

java.lang.Object
com.gitlab.pdftk_java.com.lowagie.text.pdf.BaseFont
Direct Known Subclasses:
CJKFont, DocumentFont, TrueTypeFont, Type1Font
public abstract class BaseFont extends Object
Base class for the several font types supported

  • Field Details

    • COURIER

      public static final String COURIER
      This is a possible value of a base 14 type 1 font
      See Also:

    • COURIER_BOLD

      public static final String COURIER_BOLD
      This is a possible value of a base 14 type 1 font
      See Also:

    • COURIER_OBLIQUE

      public static final String COURIER_OBLIQUE
      This is a possible value of a base 14 type 1 font
      See Also:

    • COURIER_BOLDOBLIQUE

      public static final String COURIER_BOLDOBLIQUE
      This is a possible value of a base 14 type 1 font
      See Also:

    • HELVETICA

      public static final String HELVETICA
      This is a possible value of a base 14 type 1 font
      See Also:

    • HELVETICA_BOLD

      public static final String HELVETICA_BOLD
      This is a possible value of a base 14 type 1 font
      See Also:

    • HELVETICA_OBLIQUE

      public static final String HELVETICA_OBLIQUE
      This is a possible value of a base 14 type 1 font
      See Also:

    • HELVETICA_BOLDOBLIQUE

      public static final String HELVETICA_BOLDOBLIQUE
      This is a possible value of a base 14 type 1 font
      See Also:

    • SYMBOL

      public static final String SYMBOL
      This is a possible value of a base 14 type 1 font
      See Also:

    • TIMES_ROMAN

      public static final String TIMES_ROMAN
      This is a possible value of a base 14 type 1 font
      See Also:

    • TIMES_BOLD

      public static final String TIMES_BOLD
      This is a possible value of a base 14 type 1 font
      See Also:

    • TIMES_ITALIC

      public static final String TIMES_ITALIC
      This is a possible value of a base 14 type 1 font
      See Also:

    • TIMES_BOLDITALIC

      public static final String TIMES_BOLDITALIC
      This is a possible value of a base 14 type 1 font
      See Also:

    • ZAPFDINGBATS

      public static final String ZAPFDINGBATS
      This is a possible value of a base 14 type 1 font
      See Also:

    • ASCENT

      public static final int ASCENT
      The 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 CAPHEIGHT
      The y coordinate of the top of flat capital letters, measured from the baseline.
      See Also:

    • DESCENT

      public static final int DESCENT
      The maximum depth below the baseline reached by glyphs in this font. The value is a negative number.
      See Also:

    • ITALICANGLE

      public static final int ITALICANGLE
      The 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 BBOXLLX
      The lower left x glyph coordinate.
      See Also:

    • BBOXLLY

      public static final int BBOXLLY
      The lower left y glyph coordinate.
      See Also:

    • BBOXURX

      public static final int BBOXURX
      The upper right x glyph coordinate.
      See Also:

    • BBOXURY

      public static final int BBOXURY
      The upper right y glyph coordinate.
      See Also:

    • AWT_ASCENT

      public static final int AWT_ASCENT
      java.awt.Font property
      See Also:

    • AWT_DESCENT

      public static final int AWT_DESCENT
      java.awt.Font property
      See Also:

    • AWT_LEADING

      public static final int AWT_LEADING
      java.awt.Font property
      See Also:

    • AWT_MAXADVANCE

      public static final int AWT_MAXADVANCE
      java.awt.Font property
      See Also:

    • FONT_TYPE_T1

      public static final int FONT_TYPE_T1
      The font is Type 1.
      See Also:

    • FONT_TYPE_TT

      public static final int FONT_TYPE_TT
      The font is True Type with a standard encoding.
      See Also:

    • FONT_TYPE_CJK

      public static final int FONT_TYPE_CJK
      The font is CJK.
      See Also:

    • FONT_TYPE_TTUNI

      public static final int FONT_TYPE_TTUNI
      The font is True Type with a Unicode encoding.
      See Also:

    • FONT_TYPE_DOCUMENT

      public static final int FONT_TYPE_DOCUMENT
      A font already inside the document.
      See Also:

    • FONT_TYPE_T3

      public static final int FONT_TYPE_T3
      A Type3 font.
      See Also:

    • IDENTITY_H

      public static final String IDENTITY_H
      The Unicode encoding with horizontal writing.
      See Also:

    • IDENTITY_V

      public static final String IDENTITY_V
      The Unicode encoding with vertical writing.
      See Also:

    • CP1250

      public static final String CP1250
      A possible encoding.
      See Also:

    • CP1252

      public static final String CP1252
      A possible encoding.
      See Also:

    • CP1257

      public static final String CP1257
      A possible encoding.
      See Also:

    • WINANSI

      public static final String WINANSI
      A possible encoding.
      See Also:

    • MACROMAN

      public static final String MACROMAN
      A possible encoding.
      See Also:

    • EMBEDDED

      public static final boolean EMBEDDED
      if the font has to be embedded
      See Also:

    • NOT_EMBEDDED

      public static final boolean NOT_EMBEDDED
      if the font doesn't have to be embedded
      See Also:

    • CACHED

      public static final boolean CACHED
      if the font has to be cached
      See Also:

    • NOT_CACHED

      public static final boolean NOT_CACHED
      if the font doesn't have to be cached
      See Also:

    • RESOURCE_PATH

      public static final String RESOURCE_PATH
      The path to the font resources.
      See Also:

    • CID_NEWLINE

      public static final char CID_NEWLINE
      The fake CID code that represents a newline.
      See Also:

    • fontType

      int fontType
      The font type.

    • notdef

      public static final String notdef
      a not defined character in a custom PDF encoding
      See Also:

    • widths

      protected int[] widths
      table of characters widths for this encoding

    • differences

      protected String[] differences
      encoding names

    • unicodeDifferences

      protected char[] unicodeDifferences
      same as differences but with the unicode codes

    • charBBoxes

      protected int[][] charBBoxes

    • encoding

      protected String encoding
      encoding used with this font

    • embedded

      protected boolean embedded
      true if the font is to be embedded in the PDF

    • fontSpecific

      protected boolean fontSpecific
      true if the font must use it's built in encoding. In that case the encoding is only used to map a char to the position inside the font, not to the expected char name.

    • fontCache

      protected static HashMap fontCache
      cache for the fonts already used.

    • BuiltinFonts14

      protected static final HashMap BuiltinFonts14
      list of the 14 built in fonts.

    • forceWidthsOutput

      protected boolean forceWidthsOutput
      Forces the output of the width array. Only matters for the 14 built-in fonts.

    • directTextToByte

      protected boolean directTextToByte
      Converts char directly to byte by casting.

    • subset

      protected boolean subset
      Indicates if all the glyphs and widths for that particular encoding should be included in the document.

    • fastWinansi

      protected boolean fastWinansi

  • Constructor Details

    • BaseFont

      protected BaseFont()
      Creates new BaseFont

  • Method Details

    • 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 by an AFM 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.

      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

    • 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 by an AFM 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 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.

      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

    • createFont

      public static BaseFont createFont(PRIndirectReference fontRef)
      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

      protected static String getBaseName(String name)
      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

      protected static String normalizeEncoding(String enc)
      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

    • createEncoding

      protected void createEncoding()
      Creates the widths and the differences arrays

    • getRawWidth

      abstract int getRawWidth(int c, String name)
      Gets the width from the font according to the Unicode char 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

    • getKerning

      public abstract int getKerning(char char1, char char2)
      Gets the kerning between two Unicode chars.
      Parameters:
      char1 - the first char
      char2 - the second char
      Returns:
      the kerning to be applied in normalized 1000 units

    • setKerning

      public abstract boolean setKerning(char char1, char char2, int kern)
      Sets the kerning between two Unicode chars.
      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

    • getWidth

      public int getWidth(char char1)
      Gets the width of a char in normalized 1000 units.
      Parameters:
      char1 - the unicode char to get the width of
      Returns:
      the width in normalized 1000 units

    • getWidth

      public int getWidth(String text)
      Gets the width of a String in normalized 1000 units.
      Parameters:
      text - the String to get the witdth of
      Returns:
      the width in normalized 1000 units

    • getDescent

      public int getDescent(String text)
      Gets the descent of a 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 dexcent in normalized 1000 units

    • getAscent

      public int getAscent(String text)
      Gets the ascent of a 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

    • getDescentPoint

      public float getDescentPoint(String text, float fontSize)
      Gets the descent of a 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 dexcent in points

    • getAscentPoint

      public float getAscentPoint(String text, float fontSize)
      Gets the ascent of a 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

    • getWidthPointKerned

      public float getWidthPointKerned(String text, float fontSize)
      Gets the width of a 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

    • getWidthPoint

      public float getWidthPoint(String text, float fontSize)
      Gets the width of a String in points.
      Parameters:
      text - the String to get the witdth of
      fontSize - the font size
      Returns:
      the width in points

    • getWidthPoint

      public float getWidthPoint(char char1, float fontSize)
      Gets the width of a char in points.
      Parameters:
      char1 - the char to get the witdth of
      fontSize - the font size
      Returns:
      the width in points

    • convertToBytes

      byte[] convertToBytes(String text)
      Converts a 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

    • 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 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

    • getEncoding

      public String getEncoding()
      Gets the encoding used to convert String into byte[].
      Returns:
      the encoding name

    • getFontDescriptor

      public abstract float getFontDescriptor(int key, float fontSize)
      Gets the font parameter identified by 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

    • 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

      public static String createSubsetPrefix()
      Creates a unique subset prefix to be added to the font name when the font is embedded and subset.
      Returns:
      the subset prefix

    • 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

      public abstract String getPostscriptFontName()
      Gets the postscript font name.
      Returns:
      the postscript font name

    • setPostscriptFontName

      public abstract void setPostscriptFontName(String name)
      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

      public abstract String[][] 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

    • 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 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

    • 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 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

    • getFamilyFontName

      public abstract String[][] 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

      public String[] 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

    • enumerateTTCNames

      public static String[] enumerateTTCNames(String ttcFile) throws DocumentException, IOException
      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 error
      IOException - on error

    • enumerateTTCNames

      public static String[] enumerateTTCNames(byte[] ttcArray) throws DocumentException, IOException
      Enumerates the postscript font names present inside a True Type Collection.
      Parameters:
      ttcArray - the font as a byte array
      Returns:
      the postscript font names
      Throws:
      DocumentException - on error
      IOException - on error

    • getWidths

      public int[] getWidths()
      Gets the font width array.
      Returns:
      the font width array

    • getDifferences

      public String[] 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 to true 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 of char to byte.
      Returns:
      value of property directTextToByte.
      See Also:

    • setDirectTextToByte

      public void setDirectTextToByte(boolean directTextToByte)
      Sets the conversion of 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.

    • 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. Set to false to include all.
      Parameters:
      subset - new value of property subset

    • getResourceStream

      public static InputStream getResourceStream(String key)
      Gets the font resources.
      Parameters:
      key - the full name of the resource
      Returns:
      the InputStream to get the resource or null if not found

    • getResourceStream

      public static InputStream getResourceStream(String key, ClassLoader loader)
      Gets the font resources.
      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

    • getUnicodeEquivalent

      public char getUnicodeEquivalent(char c)
      Gets the Unicode equivalent to a CID. The (inexistent) CID 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 char getCidCode(char 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(char 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(char c, int advance)
      Sets the character advance.
      Parameters:
      c - the character
      advance - the character advance normalized to 1000 units
      Returns:
      true if the advance was set, false otherwise

    • addFont

      private static void addFont(PRIndirectReference fontRef, IntHashtable hits, ArrayList fonts)

    • recourseFonts

      private static void recourseFonts(PdfDictionary page, IntHashtable hits, ArrayList fonts, int level)

    • getDocumentFonts

      public static ArrayList getDocumentFonts(PdfReader reader)
      Gets a list of all document fonts. Each element of the 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

    • getDocumentFonts

      public static ArrayList getDocumentFonts(PdfReader reader, int page)
      Gets a list of the document fonts in a particular page. Each element of the 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

    • getCharBBox

      public int[] getCharBBox(char c)
      Gets the smallest box enclosing the character contours. It will return 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

    • getRawCharBBox

      protected abstract int[] getRawCharBBox(int c, String name)

    • 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.