FontProgramFactory (iText 7

java.lang.Object
- com.itextpdf.io.font.FontProgramFactory

public final class FontProgramFactory
extends Object

Provides methods for creating various types of fonts.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static FontProgram`	`createFont()` Creates a new font.
`static FontProgram`	`createFont(byte[] fontProgram)` Creates a new font.
`static FontProgram`	`createFont(byte[] ttc, int ttcIndex, boolean cached)`
`static FontProgram`	`createFont(String fontProgram)` Creates a new font.
`static FontProgram`	`createFont(String fontProgram, boolean cached)` Creates a new font.
`static FontProgram`	`createFont(String name, byte[] font, boolean cached)` Creates a new font.
`static FontProgram`	`createFont(String ttc, int ttcIndex, boolean cached)` Creates a new True Type font from ttc file, The fonts may or may not be cached depending on the flag `cached`.
`static FontProgram`	`createRegisteredFont(String fontName)`
`static FontProgram`	`createRegisteredFont(String fontName, int style)`
`static FontProgram`	`createRegisteredFont(String fontName, int style, boolean cached)`
`static FontProgram`	`createType1Font(byte[] afm, byte[] pfb)`
`static FontProgram`	`createType1Font(String name, byte[] afm, byte[] pfb, boolean cached)` Creates a new font.
`static FontProgram`	`createType1Font(String metricsPath, String binaryPath)`
`static FontProgram`	`createType1Font(String metricsPath, String binaryPath, boolean cached)`
`static Set<String>`	`getRegisteredFontFamilies()` Gets a set of registered font names.
`static Set<String>`	`getRegisteredFonts()` Gets a set of registered font names.
`static boolean`	`isRegisteredFont(String fontname)` Checks if a certain font is registered.
`static void`	`registerFont(String path)` Register a ttf- or a ttc-file.
`static void`	`registerFont(String path, String alias)` Register a font file and use an alias for the font contained in it.
`static int`	`registerFontDirectory(String dir)` Register all the fonts in a directory.
`static void`	`registerFontFamily(String familyName, String fullName, String path)` Register a font by giving explicitly the font family and name.
`static int`	`registerSystemFontDirectories()` Register fonts in some probable directories.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - createFont
```
public static FontProgram createFont()
                              throws IOException
```
    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
  - createFont
```
public static FontProgram createFont(String fontProgram)
                              throws 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, null, true);
 
```
    Parameters:
    
    fontProgram - the name of the font or its location on file
    
    Returns:
    
    returns a new font. This font may come from the cache
    
    Throws:
    
    IOException
  - createFont
```
public static FontProgram createFont(String fontProgram,
                                     boolean cached)
                              throws 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:
    
    fontProgram - the name of the font or its location on file
    
    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
    
    Returns:
    
    returns a new font. This font may come from the cache
    
    Throws:
    
    IOException
  - createFont
```
public static FontProgram createFont(byte[] fontProgram)
                              throws 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".
    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:
    
    fontProgram - the true type font or the afm in a byte array 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 FontProgramFactory 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:
    
    IOException
  - createFont
```
public static FontProgram createFont(String name,
                                     byte[] font,
                                     boolean cached)
                              throws 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 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 its location on file
    
    font - the true type font or the afm in a byte array
    
    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
    
    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:
    
    IOException
  - createType1Font
```
public static FontProgram createType1Font(String name,
                                          byte[] afm,
                                          byte[] pfb,
                                          boolean cached)
                                   throws 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 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 its location on file
    
    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
    
    afm - the afm or pfm metrics file 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:
    
    IOException
  - createType1Font
```
public static FontProgram createType1Font(byte[] afm,
                                          byte[] pfb)
                                   throws IOException
```
    Throws:
    
    IOException
  - createType1Font
```
public static FontProgram createType1Font(String metricsPath,
                                          String binaryPath,
                                          boolean cached)
                                   throws IOException
```
    Throws:
    
    IOException
  - createType1Font
```
public static FontProgram createType1Font(String metricsPath,
                                          String binaryPath)
                                   throws IOException
```
    Throws:
    
    IOException
  - createFont
```
public static FontProgram createFont(String ttc,
                                     int ttcIndex,
                                     boolean cached)
                              throws IOException
```
    Creates a new True Type font from ttc file,
    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:
    
    ttc - location of true type collection file (*.ttc)
    
    ttcIndex - the encoding to be applied to this font
    
    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
    
    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:
    
    IOException
  - createFont
```
public static FontProgram createFont(byte[] ttc,
                                     int ttcIndex,
                                     boolean cached)
                              throws IOException
```
    Throws:
    
    IOException
  - createRegisteredFont
```
public static FontProgram createRegisteredFont(String fontName,
                                               int style,
                                               boolean cached)
                                        throws IOException
```
    Throws:
    
    IOException
  - createRegisteredFont
```
public static FontProgram createRegisteredFont(String fontName,
                                               int style)
                                        throws IOException
```
    Throws:
    
    IOException
  - createRegisteredFont
```
public static FontProgram createRegisteredFont(String fontName)
                                        throws IOException
```
    Throws:
    
    IOException
  - registerFontFamily
```
public static void registerFontFamily(String familyName,
                                      String fullName,
                                      String path)
```
    Register a font by giving explicitly the font family and name.
    
    Parameters:
    
    familyName - the font family
    
    fullName - the font name
    
    path - the font path
  - registerFont
```
public static void registerFont(String path)
```
    Register a ttf- or a ttc-file.
    
    Parameters:
    
    path - the path to a ttf- or ttc-file
  - registerFont
```
public static void registerFont(String path,
                                String alias)
```
    Register a font file and use an alias for the font contained in it.
    
    Parameters:
    
    path - the path to a font file
    
    alias - the alias you want to use for the font
  - registerFontDirectory
```
public static int registerFontDirectory(String dir)
```
    Register all the fonts in a directory.
    
    Parameters:
    
    dir - the directory
    
    Returns:
    
    the number of fonts registered
  - registerSystemFontDirectories
```
public static int registerSystemFontDirectories()
```
    Register fonts in some probable directories. It usually works in Windows, Linux and Solaris.
    
    Returns:
    
    the number of fonts registered
  - getRegisteredFonts
```
public static Set<String> getRegisteredFonts()
```
    Gets a set of registered font names.
    
    Returns:
    
    a set of registered fonts
  - getRegisteredFontFamilies
```
public static Set<String> getRegisteredFontFamilies()
```
    Gets a set of registered font names.
    
    Returns:
    
    a set of registered font families
  - isRegisteredFont
```
public static boolean isRegisteredFont(String fontname)
```
    Checks if a certain font is registered.
    
    Parameters:
    
    fontname - the name of the font that has to be checked.
    
    Returns:
    
    true if the font is found

Class FontProgramFactory

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createFont

createFont

createFont

createFont

createFont

createType1Font

createType1Font

createType1Font

createType1Font

createFont

createFont

createRegisteredFont

createRegisteredFont

createRegisteredFont

registerFontFamily

registerFont

registerFont

registerFontDirectory

registerSystemFontDirectories

getRegisteredFonts

getRegisteredFontFamilies

isRegisteredFont