PDFont (Apache PDFBox 2.0.0 API)

java.lang.Object
- org.apache.pdfbox.pdmodel.font.PDFont

All Implemented Interfaces:

COSObjectable, PDFontLike

Direct Known Subclasses:

PDSimpleFont, PDType0Font
```
public abstract class PDFont
extends Object
implements COSObjectable, PDFontLike
```
This is the base class for all PDF fonts.

Author:

Ben Litchfield

Field Summary

Fields
Modifier and Type Field and Description

protected static Matrix DEFAULT_FONT_MATRIX

protected COSDictionary dict

Fields
Modifier and Type	Field and Description
`protected static Matrix`	`DEFAULT_FONT_MATRIX`
`protected COSDictionary`	`dict`

Constructor Summary

Constructors
Modifier Constructor and Description

protected PDFont(COSDictionary fontDictionary)
Constructor.

Constructors
Modifier	Constructor and Description
`protected`	`PDFont(COSDictionary fontDictionary)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`abstract void`	`addToSubset(int codePoint)` Adds the given Unicode point to the subset.
`protected abstract byte[]`	`encode(int unicode)` Encodes the given Unicode code point for use in a PDF content stream.
`byte[]`	`encode(String text)` Encodes the given string for use in a PDF content stream.
`boolean`	`equals(Object other)`
`float`	`getAverageFontWidth()` This will get the average font width for all characters.
`abstract org.apache.fontbox.util.BoundingBox`	`getBoundingBox()` Returns the font's bounding box.
`COSDictionary`	`getCOSObject()` Convert this standard java object to a COS object.
`Vector`	`getDisplacement(int code)` Returns the displacement vector (w0, w1) in text space, for the given character.
`PDFontDescriptor`	`getFontDescriptor()` Returns the font descriptor, may be null.
`Matrix`	`getFontMatrix()` Returns the font matrix, which represents the transformation from glyph space to text space.
`abstract float`	`getHeight(int code)` Returns the height of the given character, in glyph space.
`abstract String`	`getName()` Returns the name of this font, either the PostScript "BaseName" or the Type 3 "Name".
`Vector`	`getPositionVector(int code)` Returns the position vector (v), in text space, for the given character.
`float`	`getSpaceWidth()` Determines the width of the space character.
`protected org.apache.fontbox.afm.FontMetrics`	`getStandard14AFM()` Returns the AFM if this is a Standard 14 font.
`protected abstract float`	`getStandard14Width(int code)` Returns the glyph width from the AFM if this is a Standard 14 font.
`float`	`getStringWidth(String text)` Returns the width of the given Unicode string.
`String`	`getSubType()` This will get the subtype of font.
`String`	`getType()` This will always return "Font" for fonts.
`float`	`getWidth(int code)` Returns the advance width of the given character, in glyph space.
`abstract float`	`getWidthFromFont(int code)` Returns the width of a glyph in the embedded font file.
`protected List<Float>`	`getWidths()` The widths of the characters.
`int`	`hashCode()`
`abstract boolean`	`isDamaged()` Returns true if the embedded font file is damaged.
`abstract boolean`	`isEmbedded()` Returns true if the font file is embedded in the PDF.
`boolean`	`isStandard14()` Returns true if this font is one of the "Standard 14" fonts and receives special handling.
`abstract boolean`	`isVertical()` Returns true if the font uses vertical writing mode.
`protected org.apache.fontbox.cmap.CMap`	`readCMap(COSBase base)` /** Reads a CMap given a COS Stream or Name.
`abstract int`	`readCode(InputStream in)` Reads a character code from a content stream string.
`protected void`	`setFontDescriptor(PDFontDescriptor fontDescriptor)` Sets the font descriptor when embedding a font.
`abstract void`	`subset()` Replaces this font with a subset containing only the given Unicode characters.
`String`	`toString()`
`String`	`toUnicode(int code)` Returns the Unicode character sequence which corresponds to the given character code.
`String`	`toUnicode(int code, GlyphList customGlyphList)` Returns the Unicode character sequence which corresponds to the given character code.
`abstract boolean`	`willBeSubset()` Returns true if this font will be subset when embedded.

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

- Field Detail
  - DEFAULT_FONT_MATRIX
```
protected static final Matrix DEFAULT_FONT_MATRIX
```
  - dict
```
protected final COSDictionary dict
```
- Constructor Detail
  - PDFont
```
protected PDFont(COSDictionary fontDictionary)
          throws IOException
```
    Constructor.
    
    Parameters:
    fontDictionary - Font dictionary.
    
    Throws:
    
    IOException
- Method Detail
  - getStandard14AFM
```
protected final org.apache.fontbox.afm.FontMetrics getStandard14AFM()
```
    Returns the AFM if this is a Standard 14 font.
  - getFontDescriptor
```
public PDFontDescriptor getFontDescriptor()
```
    Description copied from interface: PDFontLike
    
    Returns the font descriptor, may be null.
    
    Specified by:
    
    getFontDescriptor in interface PDFontLike
  - setFontDescriptor
```
protected final void setFontDescriptor(PDFontDescriptor fontDescriptor)
```
    Sets the font descriptor when embedding a font.
  - readCMap
```
protected final org.apache.fontbox.cmap.CMap readCMap(COSBase base)
                                               throws IOException
```
    /** Reads a CMap given a COS Stream or Name. May return null if a predefined CMap does not exist.
    
    Parameters:
    base - COSName or COSStream
    
    Throws:
    
    IOException
  - getCOSObject
```
public COSDictionary getCOSObject()
```
    Description copied from interface: COSObjectable
    
    Convert this standard java object to a COS object.
    
    Specified by:
    
    getCOSObject in interface COSObjectable
    
    Returns:
    The cos object that matches this Java object.
  - getPositionVector
```
public Vector getPositionVector(int code)
```
    Description copied from interface: PDFontLike
    
    Returns the position vector (v), in text space, for the given character. This represents the position of vertical origin relative to horizontal origin, for horizontal writing it will always be (0, 0). For vertical writing both x and y are set.
    
    Specified by:
    
    getPositionVector in interface PDFontLike
    
    Parameters:
    code - character code
    
    Returns:
    position vector
  - getDisplacement
```
public Vector getDisplacement(int code)
                       throws IOException
```
    Returns the displacement vector (w0, w1) in text space, for the given character. For horizontal text only the x component is used, for vertical text only the y component.
    
    Parameters:
    code - character code
    
    Returns:
    displacement vector
    
    Throws:
    
    IOException
  - getWidth
```
public float getWidth(int code)
               throws IOException
```
    Description copied from interface: PDFontLike
    
    Returns the advance width of the given character, in glyph space.
    If you want the visual bounds of the glyph then call getPath(..) on the appropriate PDFont subclass to retrieve the glyph outline as a GeneralPath instead.
    
    Specified by:
    
    getWidth in interface PDFontLike
    
    Parameters:
    code - character code
    
    Throws:
    
    IOException
  - getStandard14Width
```
protected abstract float getStandard14Width(int code)
```
    Returns the glyph width from the AFM if this is a Standard 14 font.
    
    Parameters:
    code - character code
    
    Returns:
    width in 1/1000 text space
  - getWidthFromFont
```
public abstract float getWidthFromFont(int code)
                                throws IOException
```
    Description copied from interface: PDFontLike
    
    Returns the width of a glyph in the embedded font file.
    
    Specified by:
    
    getWidthFromFont in interface PDFontLike
    
    Parameters:
    code - character code
    
    Returns:
    width in glyph space
    
    Throws:
    
    IOException - if the font could not be read
  - isEmbedded
```
public abstract boolean isEmbedded()
```
    Description copied from interface: PDFontLike
    
    Returns true if the font file is embedded in the PDF.
    
    Specified by:
    
    isEmbedded in interface PDFontLike
  - getHeight
```
public abstract float getHeight(int code)
                         throws IOException
```
    Description copied from interface: PDFontLike
    
    Returns the height of the given character, in glyph space. This can be expensive to calculate. Results are only approximate.
    Warning: This method is deprecated in PDFBox 2.0 because there is no meaningful value which it can return. The PDFontLike.getWidth(int) method returns the advance width of a glyph, but there is no corresponding advance height. The logical height of a character is the same for every character in a font, so if you want that, retrieve the font bbox's height. Otherwise if you want the visual bounds of the glyph then call getPath(..) on the appropriate PDFont subclass to retrieve the glyph outline as a GeneralPath.
    
    Specified by:
    
    getHeight in interface PDFontLike
    
    Parameters:
    code - character code
    
    Throws:
    
    IOException
  - encode
```
public final byte[] encode(String text)
                    throws IOException
```
    Encodes the given string for use in a PDF content stream.
    
    Parameters:
    text - Any Unicode text.
    
    Returns:
    Array of PDF content stream bytes.
    
    Throws:
    
    IOException - If the text could not be encoded.
  - encode
```
protected abstract byte[] encode(int unicode)
                          throws IOException
```
    Encodes the given Unicode code point for use in a PDF content stream. Content streams use a multi-byte encoding with 1 to 4 bytes.
    This method is called when embedding text in PDFs and when filling in fields.
    
    Parameters:
    unicode - Unicode code point.
    
    Returns:
    Array of 1 to 4 PDF content stream bytes.
    
    Throws:
    
    IOException - If the text could not be encoded.
  - getStringWidth
```
public float getStringWidth(String text)
                     throws IOException
```
    Returns the width of the given Unicode string.
    
    Parameters:
    text - The text to get the width of.
    
    Returns:
    The width of the string in 1/1000 units of text space.
    
    Throws:
    
    IOException - If there is an error getting the width information.
  - getAverageFontWidth
```
public float getAverageFontWidth()
```
    This will get the average font width for all characters.
    
    Specified by:
    
    getAverageFontWidth in interface PDFontLike
    
    Returns:
    The width is in 1000 unit of text space, ie 333 or 777
  - readCode
```
public abstract int readCode(InputStream in)
                      throws IOException
```
    Reads a character code from a content stream string. Codes may be up to 4 bytes long.
    
    Parameters:
    in - string stream
    
    Returns:
    character code
    
    Throws:
    
    IOException - if the CMap or stream cannot be read
  - toUnicode
```
public String toUnicode(int code,
               GlyphList customGlyphList)
                 throws IOException
```
    Returns the Unicode character sequence which corresponds to the given character code.
    
    Parameters:
    code - character code
    customGlyphList - a custom glyph list to use instead of the Adobe Glyph List
    
    Returns:
    Unicode character(s)
    
    Throws:
    
    IOException
  - toUnicode
```
public String toUnicode(int code)
                 throws IOException
```
    Returns the Unicode character sequence which corresponds to the given character code.
    
    Parameters:
    code - character code
    
    Returns:
    Unicode character(s)
    
    Throws:
    
    IOException
  - getType
```
public String getType()
```
    This will always return "Font" for fonts.
    
    Returns:
    The type of object that this is.
  - getSubType
```
public String getSubType()
```
    This will get the subtype of font.
  - getName
```
public abstract String getName()
```
    Description copied from interface: PDFontLike
    
    Returns the name of this font, either the PostScript "BaseName" or the Type 3 "Name".
    
    Specified by:
    
    getName in interface PDFontLike
  - getBoundingBox
```
public abstract org.apache.fontbox.util.BoundingBox getBoundingBox()
                                                            throws IOException
```
    Description copied from interface: PDFontLike
    
    Returns the font's bounding box.
    
    Specified by:
    
    getBoundingBox in interface PDFontLike
    
    Throws:
    
    IOException
  - getWidths
```
protected final List<Float> getWidths()
```
    The widths of the characters. This will be null for the standard 14 fonts.
    
    Returns:
    The widths of the characters.
  - getFontMatrix
```
public Matrix getFontMatrix()
```
    Description copied from interface: PDFontLike
    
    Returns the font matrix, which represents the transformation from glyph space to text space.
    
    Specified by:
    
    getFontMatrix in interface PDFontLike
  - getSpaceWidth
```
public float getSpaceWidth()
```
    Determines the width of the space character.
    
    Returns:
    the width of the space character
  - isVertical
```
public abstract boolean isVertical()
```
    Returns true if the font uses vertical writing mode.
  - isStandard14
```
public boolean isStandard14()
```
    Returns true if this font is one of the "Standard 14" fonts and receives special handling.
  - addToSubset
```
public abstract void addToSubset(int codePoint)
```
    Adds the given Unicode point to the subset.
    
    Parameters:
    codePoint - Unicode code point
  - subset
```
public abstract void subset()
                     throws IOException
```
    Replaces this font with a subset containing only the given Unicode characters.
    
    Throws:
    
    IOException - if the subset could not be written
  - willBeSubset
```
public abstract boolean willBeSubset()
```
    Returns true if this font will be subset when embedded.
  - isDamaged
```
public abstract boolean isDamaged()
```
    Description copied from interface: PDFontLike
    
    Returns true if the embedded font file is damaged.
    
    Specified by:
    
    isDamaged in interface PDFontLike
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class PDFont

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_FONT_MATRIX

dict

Constructor Detail

PDFont

Method Detail

getStandard14AFM

getFontDescriptor

setFontDescriptor

readCMap

getCOSObject

getPositionVector

getDisplacement

getWidth

getStandard14Width

getWidthFromFont

isEmbedded

getHeight

encode

encode

getStringWidth

getAverageFontWidth

readCode

toUnicode

toUnicode

getType

getSubType

getName

getBoundingBox

getWidths

getFontMatrix

getSpaceWidth

isVertical

isStandard14

addToSubset

subset

willBeSubset

isDamaged

equals

hashCode

toString