FontSettings (Qoppa jPDFNotes API)

java.lang.Object
- com.qoppa.pdf.FontSettings

```
public class FontSettings
extends Object
```
Font settings object. This class provides methods to control font usage behavior.

Author:

Qoppa Software

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CHINESE_SANSSERIF`
`static int`	`CHINESE_SERIF`
`static int`	`CHINESE_SIMPLIFIED`
`static int`	`JAPANESE_SANSSERIF`
`static int`	`JAPANESE_SERIF`
`static int`	`KOREAN_SANSSERIF`
`static int`	`KOREAN_SERIF`

Constructor Summary

Constructors
Constructor and Description

FontSettings()

Constructors
Constructor and Description
`FontSettings()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addSubstituteFont(String fontName, Font subFont)` Registers a substitute font to use when a font in a PDF file is not embedded in the file and the font is not registered with the operating system.
`static String`	`getCJKSystemFontName(int cjkFontType)` Get the name of the system font that will be used to render non-embedded instances of the CJK font type indicated by cjkFontType
`static List<LocalFont>`	`getLocalFonts()` Returns a list of fonts found in the local environment that can be used for adding text content to a PDF.
`static List<String>`	`getSubFontFamilyList()` Get ordered list of substitute font families.
`static Font`	`getSubstituteFont(String fontName)` Returns a substitute font, if one has been registered, for the given font name.
`static List<String>`	`getUserFontDirectories()` Returns list of user font directories
`static boolean`	`isUseSubstituteFont()` Returns the value of the flag that specifies whether or not the rendering engine should use a substitute font when a font in the PDF cannot be created.
`static void`	`setCJKSystemFontName(int cjkFontType, String systemFontName)` Set the local system font systemFontName to use for a particular CJK font type cjkFontType
`static void`	`setSubFontFamilyList(List<String> subFontFamilies)` Set ordered list of substitute font families.
`static void`	`setUserFontDirectories(List<String> userFontDirs)` Set user font directories used in font embedding.
`static void`	`setUseSubstituteFont(boolean useSubstitute)` Tells the rendering engine to use a substitute font when a font in the PDF cannot be created.

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

- Field Detail
  - JAPANESE_SERIF
```
public static final int JAPANESE_SERIF
```
    See Also:
    
    Constant Field Values
  - JAPANESE_SANSSERIF
```
public static final int JAPANESE_SANSSERIF
```
    See Also:
    
    Constant Field Values
  - CHINESE_SERIF
```
public static final int CHINESE_SERIF
```
    See Also:
    
    Constant Field Values
  - CHINESE_SANSSERIF
```
public static final int CHINESE_SANSSERIF
```
    See Also:
    
    Constant Field Values
  - CHINESE_SIMPLIFIED
```
public static final int CHINESE_SIMPLIFIED
```
    See Also:
    
    Constant Field Values
  - KOREAN_SERIF
```
public static final int KOREAN_SERIF
```
    See Also:
    
    Constant Field Values
  - KOREAN_SANSSERIF
```
public static final int KOREAN_SANSSERIF
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FontSettings
```
public FontSettings()
```
- Method Detail
  - setUseSubstituteFont
```
public static void setUseSubstituteFont(boolean useSubstitute)
```
    Tells the rendering engine to use a substitute font when a font in the PDF cannot be created. The rendering engine will need to use a substitute font if there is an error with the embedded font, or if the specified font is not embedded and a matching font cannot be found in the OS. Otherwise, an exception will be thrown. This exception will be thrown when the page content is parsed. The PDF library must parse the page content for most PDF features including rendering, printing, creating images, text search/extraction, flattening form fields, optimizing, and preflighting.
    
    Parameters:
    
    useSubstitute - Flag indicating whether substitute fonts should be used.
  - isUseSubstituteFont
```
public static boolean isUseSubstituteFont()
```
    Returns the value of the flag that specifies whether or not the rendering engine should use a substitute font when a font in the PDF cannot be created.
    
    Returns:
    
    Boolean flag that indicates whether substitute fonts should be used.
    
    See Also:
    
    setUseSubstituteFont(boolean)
  - addSubstituteFont
```
public static void addSubstituteFont(String fontName,
                                     Font subFont)
```
    Registers a substitute font to use when a font in a PDF file is not embedded in the file and the font is not registered with the operating system. By default, when a font is not embedded in a PDF file, the library looks to the list of fonts available in the operating system. If the font is not found, then the library will look at the substitute fonts for a name that matches.
    
    Parameters:
    
    fontName - The name of the font in the PDF file.
    
    subFont - The substitute font to use when the font is not present in the PDF file or in the OS.
  - getSubstituteFont
```
public static Font getSubstituteFont(String fontName)
```
    Returns a substitute font, if one has been registered, for the given font name.
    
    Parameters:
    
    fontName - The name of the font
    
    Returns:
    
    The substitute font
  - setCJKSystemFontName
```
public static void setCJKSystemFontName(int cjkFontType,
                                        String systemFontName)
```
    Set the local system font systemFontName to use for a particular CJK font type cjkFontType
    
    Parameters:
    
    cjkFontType - the integer code for a particular CJK font type, e.g. Chinese Serif
    
    systemFontName - should either match one of the font names returned by GraphicsEnvironment.getLocalGraphicsEnvironment().getAvailableFontFamilyNames() or else it should be null. If systemFontName matches a system font family name, then that font will be used to render non-embedded instances of cjkFontType. If systemFontName is null, then that resets the font for cjkFontType to the default value, which may be none on some systems. If systemFontName is any other value, then the call has no affect.
  - getCJKSystemFontName
```
public static String getCJKSystemFontName(int cjkFontType)
```
    Get the name of the system font that will be used to render non-embedded instances of the CJK font type indicated by cjkFontType
    
    Parameters:
    
    cjkFontType - the integer code for a particular CJK font type, e.g. Chinese Serif
    
    Returns:
    
    Returns the name of the system font that will be used to render non-embedded instances of the CJK font type indicated by cjkFontType. Returns null if no system font has been set and if no default font names were found on the local system. A null result implies non-embedded instances of cjkFontType will not be rendered correctly.
  - setUserFontDirectories
```
public static void setUserFontDirectories(List<String> userFontDirs)
```
    Set user font directories used in font embedding. In several different cases, fonts will be embedded in the document. These cases include certain textual annotations, editing page content with the content edit tools, preflighting a document (for example, converting to PDF/A-1b), and when converting Microsoft Word documents to PDF. Fonts found in these directories will take precedence over fonts found in local font directories from the operating system. Each directory will be searched in the order supplied. Nested subdirectories will be recursively searched depth first after the parent directory.
    
    Parameters:
    
    userFontDirs - - List of font directory path strings
  - getUserFontDirectories
```
public static List<String> getUserFontDirectories()
```
    Returns list of user font directories
    
    Returns:
    
    List of user font directories
  - getLocalFonts
```
public static List<LocalFont> getLocalFonts()
                                     throws PDFException
```
    Returns a list of fonts found in the local environment that can be used for adding text content to a PDF. Note that not all fonts in the list may necessarily be embeddable. The fonts in this list are put together from the "base" fonts and the "user" fonts: User fonts are fonts located in any user font directories, set by using the setUserFontDirectories() method. Base fonts are fonts that are available through the operating system. Fonts found in user supplied directories will appear before those in the base font directories. On some systems, base font directories often organize fonts in subdirectories. All base font directories are recursively searched for fonts. Fonts found in a parent directory will appear in the list before those found in a subdirectory. The list may not necessarily contain all fonts that were found on the system; only font files we are able to successfully parse will appear in the list. The order of fonts in the list loosely represents the precedence of font selection used internally by Qoppa libraries, all else being equal.
    
    Returns:
    
    List of fonts that we can use.
    
    Throws:
    
    PDFException
  - setSubFontFamilyList
```
public static void setSubFontFamilyList(List<String> subFontFamilies)
```
    Set ordered list of substitute font families. A font from a substitute font family - if found - can be used when editing content where the original font is not available in the document, local fonts or Std14 fonts. Substitute font families are checked in the order specified.
    
    Parameters:
    
    subFontFamilies - - list of substitute font family names
  - getSubFontFamilyList
```
public static List<String> getSubFontFamilyList()
```
    Get ordered list of substitute font families.
    
    Returns:
    
    List of substitute font family names

Class FontSettings

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JAPANESE_SERIF

JAPANESE_SANSSERIF

CHINESE_SERIF

CHINESE_SANSSERIF

CHINESE_SIMPLIFIED

KOREAN_SERIF

KOREAN_SANSSERIF

Constructor Detail

FontSettings

Method Detail

setUseSubstituteFont

isUseSubstituteFont

addSubstituteFont

getSubstituteFont

setCJKSystemFontName

getCJKSystemFontName

setUserFontDirectories

getUserFontDirectories

getLocalFonts

setSubFontFamilyList

getSubFontFamilyList