Font

java.lang.Object
- com.datalogics.PDFL.Font

```
public class Font
extends java.lang.Object
```
Represents a font. Defines the typeface, size, style (bold, italic), Unicode values, and other details. The Font class represents a font installed on the system.

Constructor Summary

Constructors
Constructor and Description
`Font(java.lang.String fontName)` Find a font with the specified name, and construct a Font object from it.
`Font(java.lang.String fontName, java.util.EnumSet<FontCreateFlags> createFlags)` Find a font with the specified name, and construct a Font object from it.
`Font(java.lang.String fontName, java.util.EnumSet<FontCreateFlags> createFlags, WritingMode wrMode)` Find a font with the specified name, and construct a Font object from it.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`delete()` Destructor.
`void`	`embedNow(Document doc)` Embeds the Font.
`long`	`findIndexOfFirstUnrepresentableChar(java.lang.String text)` Find the index of the first character that cannot be represented in this font.
`double`	`getAscent()`
`double`	`getAvgWidth()`
`double`	`getCapHeight()`
`java.lang.String`	`getCidFontType()`
`double`	`getDescent()`
`boolean`	`getEmbedded()` Tests that Font is embedded in the document it was created for returns true if the font is embedded and returns false if it is not
`java.lang.String`	`getEncoding()` Return the encoding of the font.
`EncodingInfo`	`getEncodingInfo()` Get the populated CEncoding object.
`java.util.EnumSet<FontFlags>`	`getFlags()` Get the font flags for a font.
`static java.util.List<Font>`	`getFontList()` Get a list of available fonts.
`java.lang.String`	`getFullName()` Get the Full Name of the font.
`double`	`getItalicAngle()`
`double`	`getLeading()`
`double`	`getMaxWidth()`
`double`	`getMissingWidth()`
`java.lang.String`	`getName()` Get the name of the font.
`PDFDict`	`getPDFDict()` Retrieve the PDFDict representation of this object
`double`	`getStemH()`
`double`	`getStemV()`
`java.lang.String`	`getType()` Get the type of the font.
`WritingMode`	`getWritingMode()`
`double`	`getXHeight()`
`boolean`	`isFromDoc()`
`boolean`	`isTextRepresentable(java.lang.String text)` Is this text representable in this font?
`double`	`measureTextWidth(java.lang.String text, double fontSize)` Measures the width of the specified text in points, using the Font at the specified size.

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

- Constructor Detail
  - Font
```
public Font(java.lang.String fontName)
```
    Find a font with the specified name, and construct a Font object from it. Otherwise, it makes a font with the default encoding (MacRomanEncoding on Macs, WinAnsiEncoding elsewhere, or for symbol fonts, their own custom encoding). There is not a way to specify another encoding for the font.
    When setting text, it checks to see if the text is representable in the font's encoding. If it is not, then DLE makes a "unicode font" with an Identity-H encoding and uses that to set the text. For non-Type0 fonts, this may result in two versions of a font in the output document.
    PDFL enforces the following requirements on fonts:
    - TrueTypes used as CID fonts must be embedded.
    - All CID fonts that are embedded must be subsetted.
    - CID fonts that are marked as embedded get their DoNotEmbed flag turned off (or else PDFL won't make a PDEFont from the SysFont).
  - Font
```
public Font(java.lang.String fontName,
            java.util.EnumSet<FontCreateFlags> createFlags)
```
    Find a font with the specified name, and construct a Font object from it. Otherwise, it makes a font with the default encoding (MacRomanEncoding on Macs, WinAnsiEncoding elsewhere, or for symbol fonts, their own custom encoding). There is not a way to specify another encoding for the font.
    When setting text, it checks to see if the text is representable in the font's encoding. If it is not, then DLE makes a "unicode font" with an Identity-H encoding and uses that to set the text. For non-Type0 fonts, this may result in two versions of a font in the output document.
    PDFL enforces the following requirements on fonts:
    - TrueTypes used as CID fonts must be embedded.
    - All CID fonts that are embedded must be subsetted.
    - CID fonts that are marked as embedded get their DoNotEmbed flag turned off (or else PDFL won't make a PDEFont from the SysFont).
    Parameters:
    
    fontName - the name of the font to create
    
    createFlags - flags specifying embedding and other options for the use of a font in the document
  - Font
```
public Font(java.lang.String fontName,
            java.util.EnumSet<FontCreateFlags> createFlags,
            WritingMode wrMode)
```
    Find a font with the specified name, and construct a Font object from it. Otherwise, it makes a font with the default encoding (MacRomanEncoding on Macs, WinAnsiEncoding elsewhere, or for symbol fonts, their own custom encoding). There is not a way to specify another encoding for the font.
    When setting text, it checks to see if the text is representable in the font's encoding. If it is not, then DLE makes a "unicode font" with an Identity-H or Identity-V encoding and uses that to set the text. For non-Type0 fonts, this may result in two versions of a font in the output document.
    PDFL enforces the following requirements on fonts:
    - TrueTypes used as CID fonts must be embedded.
    - All CID fonts that are embedded must be subsetted.
    - CID fonts that are marked as embedded get their DoNotEmbed flag turned off (or else PDFL won't make a PDEFont from the SysFont).
    Parameters:
    
    fontName - the name of the font to create
    
    createFlags - flags specifying embedding and other options for the use of a font in the document
    
    wrMode - determines whether text will be printed horizontally or vertically
- Method Detail
  - delete
```
public void delete()
```
    Destructor.
  - getFontList
```
public static java.util.List<Font> getFontList()
```
    Get a list of available fonts.
    
    Returns:
    
    The list of available fonts.
  - getAscent
```
public double getAscent()
```
    Returns:
    
    The Ascent value of the font in glyph space units.
  - getAvgWidth
```
public double getAvgWidth()
```
    Returns:
    
    The AvgWidth value of the font in glyph space units, or 0 if not defined.
  - getCapHeight
```
public double getCapHeight()
```
    Returns:
    
    The CapHeight value of the font in glyph space units, or 0 if not defined.
  - getDescent
```
public double getDescent()
```
    Returns:
    
    The descent value of the font. \\xrefitem pdelayer_apis "PDE Layer" "PDE Layer" PDSysFont PDSysFontGetAttrs \\xrefitem pdelayer_apis "PDE Layer" "PDE Layer" PDEFont PDEFontGetAttrs \\xrefitem pdlayer_apis "PD Layer" "PD Layer" PDFont PDFontGetMetrics
  - getEncoding
```
public java.lang.String getEncoding()
```
    Return the encoding of the font.
    Returns:
    The encoding of the font, eg:
    
    WinAnsiEncoding
    
    MacRomanEncoding
  - getItalicAngle
```
public double getItalicAngle()
```
    Returns:
    
    The ItalicAngle value of the font in degrees.
  - getLeading
```
public double getLeading()
```
    Returns:
    
    The leading value of the font, or 0 if not present.
  - getMaxWidth
```
public double getMaxWidth()
```
    Returns:
    
    The MaxWidth value of the font in glyph space units, or 0 if not present.
  - getMissingWidth
```
public double getMissingWidth()
```
    Returns:
    
    The MissingWidth value of the font in glyph space units, or 0 if not present.
  - getName
```
public java.lang.String getName()
```
    Get the name of the font.
    
    Returns:
    
    The name of the font.
  - getFullName
```
public java.lang.String getFullName()
```
    Get the Full Name of the font.
    
    Returns:
    
    The Full Name of the font. Note: This method only returns a meaningful result for TrueType-based technology fonts.
  - getStemH
```
public double getStemH()
```
    Returns:
    
    The StemH value of the font in glyph space units, or 0 if not present.
  - getStemV
```
public double getStemV()
```
    Returns:
    
    The StemV value of the font in glyph space units, or 0 if not present.
  - getType
```
public java.lang.String getType()
```
    Get the type of the font.
    Returns:
    The type of the font.
    
    Type0
    
    Type1
    
    MMType1
    
    TrueType
  - getCidFontType
```
public java.lang.String getCidFontType()
```
  - getXHeight
```
public double getXHeight()
```
    Returns:
    
    The XHeight value of the font in glyph space units, or 0 if not present.
  - getFlags
```
public java.util.EnumSet<FontFlags> getFlags()
```
    Get the font flags for a font.
  - getEncodingInfo
```
public EncodingInfo getEncodingInfo()
```
    Get the populated CEncoding object.
  - getWritingMode
```
public WritingMode getWritingMode()
```
    Returns:
    
    The WritingMode of the font.
  - isTextRepresentable
```
public boolean isTextRepresentable(java.lang.String text)
```
    Is this text representable in this font?
    
    Parameters:
    
    text - the text to check
  - findIndexOfFirstUnrepresentableChar
```
public long findIndexOfFirstUnrepresentableChar(java.lang.String text)
```
    Find the index of the first character that cannot be represented in this font. This will return the index of the first character in the string for which the font has no glyph. If all characters can be represented (i.e. if IsTextRepresentable() would return true), this will return the length of the string.
    
    Parameters:
    
    text - the text to check
    
    Returns:
    
    The index of the first character that cannot be represented in this font.
  - getPDFDict
```
public PDFDict getPDFDict()
```
    Retrieve the PDFDict representation of this object
  - isFromDoc
```
public boolean isFromDoc()
```
  - getEmbedded
```
public boolean getEmbedded()
```
    Tests that Font is embedded in the document it was created for returns true if the font is embedded and returns false if it is not
  - embedNow
```
public void embedNow(Document doc)
```
    Embeds the Font.
    
    Parameters:
    
    doc - the Document the Font is embedded into
  - measureTextWidth
```
public double measureTextWidth(java.lang.String text,
                               double fontSize)
```
    Measures the width of the specified text in points, using the Font at the specified size.
    
    Parameters:
    
    text - the Text to be measured
    
    fontSize - the Font size to be used

Class Font

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Font

Font

Font

Method Detail

delete

getFontList

getAscent

getAvgWidth

getCapHeight

getDescent

getEncoding

getItalicAngle

getLeading

getMaxWidth

getMissingWidth

getName

getFullName

getStemH

getStemV

getType

getCidFontType

getXHeight

getFlags

getEncodingInfo

getWritingMode

isTextRepresentable

findIndexOfFirstUnrepresentableChar

getPDFDict

isFromDoc

getEmbedded

embedNow

measureTextWidth