Font (ICEpdf API)

java.lang.Object
- org.icepdf.core.pobjects.Dictionary
- - org.icepdf.core.pobjects.fonts.Font

Direct Known Subclasses:

Font
```
public abstract class Font
extends Dictionary
```
This class represents a PDF object which has a subtype value equal to "Font". The class does the necessary encoding and Cmap manipulation to allow the proper display of text that uses this font object.

This class is generally only used by the ContentParser for laying out text for display and for text extraction. There are two categories of PDF fonts: Simple and Composite.

Simple Fonts

There are several types of simple font; all of which have the following properties:
- Glyphs in the font are selected by single-byte character codes obtained from a string that is shown by the text-showing operators. Logically, these codes index into a table of 256 glyphs; the mapping from codes to glyphs is called the font's encoding. Each font program has a built-in encoding. Under some circumstances, the encoding can be altered by means described in Section 5.5.5, "Character Encoding."
- Each glyph has a single set of metrics, including a horizontal displacement or width, as described in Section 5.1.3, "Glyph Positioning and Metrics." That is, simple fonts support only horizontal writing mode.
- Except for Type 3 fonts and certain standard Type 1 fonts, every font dictionary contains a subsidiary dictionary, the font descriptor, containing fontwide metrics and other attributes of the font; see Section 5.7, "Font Descriptors." Among those attributes is an optional font file stream containing the font program itself.
Composite Fonts

A composite font, also called Type0 font, is one whose glyphs are obtained from a font like object called a CIDFont. A composite font is represented by a font dictionary whose Subtype value is Type0. The Type 0 font is known as the root font, and its associated CID Font is called its descendant.
Since:

1.0

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`basefont`
`static Name`	`BASEFONT_KEY`
`static int`	`CID_FORMAT` Indicates that the font used to render this String object is in the Composite Font family and thus each glyph is represented by at least one byte.
`protected static java.lang.String[]`	`CORE14`
`static Name`	`ENCODING_KEY`
`static Name`	`FIRST_CHAR_KEY`
`protected int`	`firstchar`
`protected FontFile`	`font`
`static int`	`FONT_FLAG_ALL_CAP` Font contains no lowercase letters; typically used for display purposes, such as for titles or headlines.
`static int`	`FONT_FLAG_FIXED_PITCH` All glyphs have the same width (as opposed to proportional or variable-pitch fonts, which have different widths).
`static int`	`FONT_FLAG_FORCE_BOLD` Font contains no lowercase letters; typically used for display purposes, such as for titles or headlines.
`static int`	`FONT_FLAG_ITALIC` Glyphs have dominant vertical strokes that are slanted.
`static int`	`FONT_FLAG_NON_SYMBOLIC` Font uses the Adobe standard Latin character set or a subset of it.
`static int`	`FONT_FLAG_SCRIPT` Glyphs resemble cursive handwriting.
`static int`	`FONT_FLAG_SERIF` Glyphs have serifs, which are short strokes drawn at an angle on the top and bottom of glyph stems.
`static int`	`FONT_FLAG_SMALL_CAP` Glyphs have dominant vertical strokes that are slanted.
`static int`	`FONT_FLAG_SYMBOLIC` Font contains glyphs outside the Adobe standard Latin character set.
`protected FontDescriptor`	`fontDescriptor`
`protected boolean`	`inited`
`protected boolean`	`isAFMFont`
`protected boolean`	`isFontSubstitution`
`protected boolean`	`isVerticalWriting`
`static Name`	`LAST_CHAR_KEY`
`protected int`	`lastchar`
`protected Name`	`name`
`static Name`	`NAME_KEY`
`protected Resources`	`parentResource`
`static int`	`SIMPLE_FORMAT` Indicates that the font used to render this String object is in the Simple Font family and thus each glyph is represented by one byte.
`protected Name`	`subtype`
`protected int`	`subTypeFormat`
`protected static java.lang.String[][]`	`TO_UNICODE` Map named CMap to Unicode mapping.
`static Name`	`TYPE`
`protected static java.lang.String[][]`	`TYPE1_FONT_NAME`

Fields inherited from class org.icepdf.core.pobjects.Dictionary
entries, FORM_TYPE_KEY, isDeleted, isNew, LENGTH_KEY, library, SUBTYPE_KEY, TYPE_KEY

Constructor Summary

Constructors
Constructor and Description

Font(Library library, java.util.HashMap entries)
Creates a new instance of a PDF Font.

Constructors
Constructor and Description
`Font(Library library, java.util.HashMap entries)` Creates a new instance of a PDF Font.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getBaseFont()` Gets the fonts base name.
`protected java.lang.String`	`getCanonicalName(java.lang.String name)` Gets the base name of the core 14 fonts, null if it does not match
`FontFile`	`getFont()` Returns a font which can be used to paint the glyphs in the character set.
`Name`	`getName()` Gets the font name.
`Resources`	`getParentResource()`
`Name`	`getSubType()` Gets the font subtype value.
`int`	`getSubTypeFormat()` Gets the font subtype format
`abstract void`	`init()` Initiate the font.
`boolean`	`isAFMFont()` Indicates that this font is an Adobe Core 14 font.
`boolean`	`isCore14(java.lang.String fontName)` Returns true if the font name is one of the core 14 fonts specified by Adobe.
`boolean`	`isFontSubstitution()`
`boolean`	`isVerticalWriting()` Returns true if the writing mode is vertical; false, otherwise
`void`	`setParentResource(Resources parentResource)`
`java.lang.String`	`toString()` String representation of the Font object.

Methods inherited from class org.icepdf.core.pobjects.Dictionary
getEntries, getFloat, getInt, getLibrary, getNumber, getObject, getPObjectReference, isDeleted, isNew, setDeleted, setNew, setPObjectReference

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

- Field Detail
  - TYPE
```
public static final Name TYPE
```
  - NAME_KEY
```
public static final Name NAME_KEY
```
  - BASEFONT_KEY
```
public static final Name BASEFONT_KEY
```
  - ENCODING_KEY
```
public static final Name ENCODING_KEY
```
  - FIRST_CHAR_KEY
```
public static final Name FIRST_CHAR_KEY
```
  - LAST_CHAR_KEY
```
public static final Name LAST_CHAR_KEY
```
  - FONT_FLAG_FIXED_PITCH
```
public static final int FONT_FLAG_FIXED_PITCH
```
    All glyphs have the same width (as opposed to proportional or variable-pitch fonts, which have different widths).
    
    See Also:
    
    Constant Field Values
  - FONT_FLAG_SERIF
```
public static final int FONT_FLAG_SERIF
```
    Glyphs have serifs, which are short strokes drawn at an angle on the top and bottom of glyph stems. (Sans serif fonts do not have serifs.)
    
    See Also:
    
    Constant Field Values
  - FONT_FLAG_SYMBOLIC
```
public static final int FONT_FLAG_SYMBOLIC
```
    Font contains glyphs outside the Adobe standard Latin character set. This flag and the Nonsymbolic flag shall not both be set or both be clear.
    
    See Also:
    
    Constant Field Values
  - FONT_FLAG_SCRIPT
```
public static final int FONT_FLAG_SCRIPT
```
    Glyphs resemble cursive handwriting.
    
    See Also:
    
    Constant Field Values
  - FONT_FLAG_NON_SYMBOLIC
```
public static final int FONT_FLAG_NON_SYMBOLIC
```
    Font uses the Adobe standard Latin character set or a subset of it.
    
    See Also:
    
    Constant Field Values
  - FONT_FLAG_ITALIC
```
public static final int FONT_FLAG_ITALIC
```
    Glyphs have dominant vertical strokes that are slanted.
    
    See Also:
    
    Constant Field Values
  - FONT_FLAG_ALL_CAP
```
public static final int FONT_FLAG_ALL_CAP
```
    Font contains no lowercase letters; typically used for display purposes, such as for titles or headlines.
    
    See Also:
    
    Constant Field Values
  - FONT_FLAG_SMALL_CAP
```
public static final int FONT_FLAG_SMALL_CAP
```
    Glyphs have dominant vertical strokes that are slanted.
    
    See Also:
    
    Constant Field Values
  - FONT_FLAG_FORCE_BOLD
```
public static final int FONT_FLAG_FORCE_BOLD
```
    Font contains no lowercase letters; typically used for display purposes, such as for titles or headlines.
    
    See Also:
    
    Constant Field Values
  - name
```
protected Name name
```
  - basefont
```
protected java.lang.String basefont
```
  - subtype
```
protected Name subtype
```
  - SIMPLE_FORMAT
```
public static final int SIMPLE_FORMAT
```
    Indicates that the font used to render this String object is in the Simple Font family and thus each glyph is represented by one byte.
    
    See Also:
    
    Constant Field Values
  - CID_FORMAT
```
public static final int CID_FORMAT
```
    Indicates that the font used to render this String object is in the Composite Font family and thus each glyph is represented by at least one byte.
    
    See Also:
    
    Constant Field Values
  - subTypeFormat
```
protected int subTypeFormat
```
  - font
```
protected FontFile font
```
  - firstchar
```
protected int firstchar
```
  - lastchar
```
protected int lastchar
```
  - fontDescriptor
```
protected FontDescriptor fontDescriptor
```
  - inited
```
protected boolean inited
```
  - isAFMFont
```
protected boolean isAFMFont
```
  - isVerticalWriting
```
protected boolean isVerticalWriting
```
  - isFontSubstitution
```
protected boolean isFontSubstitution
```
  - parentResource
```
protected Resources parentResource
```
  - TO_UNICODE
```
protected static final java.lang.String[][] TO_UNICODE
```
    Map named CMap to Unicode mapping.
  - CORE14
```
protected static final java.lang.String[] CORE14
```
  - TYPE1_FONT_NAME
```
protected static final java.lang.String[][] TYPE1_FONT_NAME
```
- Constructor Detail
  - Font
```
public Font(Library library,
            java.util.HashMap entries)
```
    Creates a new instance of a PDF Font.
    
    Parameters:
    
    library - Libaray of all objects in PDF
    
    entries - hash of parsed font attributes
- Method Detail
  - init
```
public abstract void init()
```
    Initiate the font. Retrieve any needed attributes, basically set up the font so it can be used by the content parser.
    
    Overrides:
    
    init in class Dictionary
  - getCanonicalName
```
protected java.lang.String getCanonicalName(java.lang.String name)
```
    Gets the base name of the core 14 fonts, null if it does not match
    
    Parameters:
    
    name - name of font to search for canonical name
  - getBaseFont
```
public java.lang.String getBaseFont()
```
    Gets the fonts base name.
    
    Returns:
    
    fonts base name, "Serif" if none specified.
  - getName
```
public Name getName()
```
    Gets the font name.
    
    Returns:
    
    string representing the font name
  - getSubType
```
public Name getSubType()
```
    Gets the font subtype value.
    
    Returns:
    
    string representing the font subtype
  - getSubTypeFormat
```
public int getSubTypeFormat()
```
    Gets the font subtype format
    
    Returns:
    
    SIMPLE_FORMAT or CID_FORMAT.
  - getFont
```
public FontFile getFont()
```
    Returns a font which can be used to paint the glyphs in the character set.
    
    Returns:
    
    value of embedded font.
  - isVerticalWriting
```
public boolean isVerticalWriting()
```
    Returns true if the writing mode is vertical; false, otherwise
    
    Returns:
    
    true if the writing mode is vertical; false, otherwise.
  - isAFMFont
```
public boolean isAFMFont()
```
    Indicates that this font is an Adobe Core 14 font.
    
    Returns:
    
    true, if font is a core 14 font; false otherwise.
  - isFontSubstitution
```
public boolean isFontSubstitution()
```
  - isCore14
```
public boolean isCore14(java.lang.String fontName)
```
    Returns true if the font name is one of the core 14 fonts specified by Adobe.
    
    Parameters:
    
    fontName - name to test if a core 14 font.
    
    Returns:
    
    true, if font name is a core 14 font; false, otherwise.
  - toString
```
public java.lang.String toString()
```
    String representation of the Font object.
    
    Overrides:
    
    toString in class Dictionary
    
    Returns:
    
    string representing Font object attributes.
  - getParentResource
```
public Resources getParentResource()
```
  - setParentResource
```
public void setParentResource(Resources parentResource)
```

Class Font

Simple Fonts

Composite Fonts

Field Summary

Fields inherited from class org.icepdf.core.pobjects.Dictionary

Constructor Summary

Method Summary

Methods inherited from class org.icepdf.core.pobjects.Dictionary

Methods inherited from class java.lang.Object

Field Detail

TYPE

NAME_KEY

BASEFONT_KEY

ENCODING_KEY

FIRST_CHAR_KEY

LAST_CHAR_KEY

FONT_FLAG_FIXED_PITCH

FONT_FLAG_SERIF

FONT_FLAG_SYMBOLIC

FONT_FLAG_SCRIPT

FONT_FLAG_NON_SYMBOLIC

FONT_FLAG_ITALIC

FONT_FLAG_ALL_CAP

FONT_FLAG_SMALL_CAP

FONT_FLAG_FORCE_BOLD

name

basefont

subtype

SIMPLE_FORMAT

CID_FORMAT

subTypeFormat

font

firstchar

lastchar

fontDescriptor

inited

isAFMFont

isVerticalWriting

isFontSubstitution

parentResource

TO_UNICODE

CORE14

TYPE1_FONT_NAME

Constructor Detail

Font

Method Detail

init

getCanonicalName

getBaseFont

getName

getSubType

getSubTypeFormat

getFont

isVerticalWriting

isAFMFont

isFontSubstitution

isCore14

toString

getParentResource

setParentResource