SetaPDF_Core_Font_Type3 Class representing a Type3 font.
File: /SetaPDF v2/Core/Font/Type3.php
This class is only useable by existing MMType1 fonts.
Class hierarchy
Implements
- SetaPDF_Core_Font_FontInterface
- SetaPDF_Core_Font_Glyph_Collection_CollectionInterface
- SetaPDF_Core_Resource
Summary
Methods
- __construct()
- _ensureUnderlinePosition()
- _ensureUnderlineThickness()
- _getEncodingTable()
- _getWidths()
- getAscent()
- getAvgWidth()
- getBaseEncodingTable()
- getCharByCharCode()
- getCharCode()
- getCharCodes()
- getCharsByCharCodes()
- getDictionary()
- getFontBBoxVector()
- getFontDescriptor()
- getFontFamily()
- getFontMatrix()
- getFontName()
- getGlyphWidth()
- getGlyphWidthByCharCode()
- getGlyphsWidth()
- getIndirectObject()
- getInfo()
- getItalicAngle()
- getMaxWidth()
- getMissingWidth()
- getResourceType()
- getType()
- getUnderlinePosition()
- getUnderlineThickness()
- isBold()
- isItalic()
- isMonospace()
- recalculateFontBBox()
- setUnderlinePosition()
- setUnderlineThickness()
- splitCharCodes()
Constants
INFO_COPYRIGHT
Info constant
INFO_CREATION_DATE
Info constant
INFO_UNIQUE_ID
Info constant
INFO_VERSION
Info constant
TYPE_COLOR_SPACE
Type constant
TYPE_EXT_G_STATE
Type constant
TYPE_FONT
Type constant
TYPE_PATTERN
Type constant
TYPE_PROC_SET
Type constant
TYPE_PROPERTIES
Type constant
TYPE_SHADING
Type constant
TYPE_X_OBJECT
Type constant
Properties
$_avgWidth
The average width of glyphs in the font.
$_calculatedFontBBox
$_charCodeCache
A char code cache which is used in SetaPDF_Core_Font::getCharByCharCode()
.
$_encodingTable
The encoding table.
$_fontBBox
The font bounding box
$_fontName
The font name
$_substituteCharacter
The substitute character in a fonts specific encoding.
$_underlinePosition
The relative underline positioning.
$_underlineThickness
The underline thickness.
$_widths
Glyph widths
$_widthsByCharCode
Widths by char codes
Static Methods
freeCache()
WARNING: This method is marked as deprecated!
Call SetaPDF_Core_Document::clearCache()
with the type
SetaPDF_Core_Document::CACHE_FONT
instead.
Release font instances by a document instance.
Parameters
- $document : SetaPDF_Core_Document
freeFontCache()
WARNING: This method is marked as deprecated!
Release font instances by a document instance.
Parameters
- $document : SetaPDF_Core_Document
See
get()
Get a font object by an indirect reference.
The needed font object class is automatically resolve via the Subtype value of the font dictionary.
Parameters
- $indirectObjectOrDictionary : SetaPDF_Core_Type_IndirectObjectInterface|SetaPDF_Core_Type_Dictionary
Exceptions
Throws SetaPDF_Exception_NotImplemented
Throws SetaPDF_Core_Font_Exception
Throws SetaPDF_Core_Type_IndirectReference_Exception
Throws SetaPDF_Core_Type_Exception
Methods
__construct()
The constructor.
Parameters
- $indirectObjectOrDictionary : SetaPDF_Core_Type_IndirectObjectInterface|SetaPDF_Core_Type_Dictionary
Exceptions
Throws SetaPDF_Core_Type_Exception
_ensureUnderlinePosition()
Calculates the underline position.
This method is only used if no underline thickness is provided by the font implementation (e.g. through an already embedded font). We simply use the font bounding box to calculate a meaningful value.
_ensureUnderlineThickness()
Calculates the underline thickness.
This method is only used if no underline thickness is provided by the font implementation (e.g. through an already embedded font).
_getEncodingTable()
Get the encoding table based on the Encoding dictionary and it's Differences entry (if available).
Exceptions
Throws SetaPDF_Core_Type_Exception
_getWidths()
Resolves the width values from the font descriptor and fills the $_width-array.
Exceptions
Throws SetaPDF_Core_Type_Exception
Throws SetaPDF_Core_Font_Exception
getAscent()
Returns the distance from baseline of highest ascender (Typographic ascent).
Exceptions
Throws SetaPDF_Core_Font_Exception
getAvgWidth()
Get the average glyph width.
Parameters
- $calculateIfUndefined : boolean
Exceptions
Throws SetaPDF_Core_Font_Exception
Throws SetaPDF_Core_Type_Exception
getBaseEncodingTable()
Get the base encoding of the font.
The base encoding for Type3 fonts is undefined but most readers/viewers use an ascii like table.
getCharByCharCode()
Converts a char code from the font specific encoding to another encoding.
Parameters
- $charCode : string
The char code in the font specific encoding.
- $encoding : string
The resulting encoding
getCharCode()
Get the final character code of a single character.
Parameters
- $char : string
The character
- $encoding : string
The output encoding
getCharCodes()
Get the final character codes of a character string.
Parameters
- $chars : string
The character string
- $encoding : string
The output encoding
getCharsByCharCodes()
Converts char codes from the font specific encoding to another encoding.
Parameters
- $charCodes : string
The char codes in the font specific encoding.
- $encoding : string
The resulting encoding
- $asArray : bool
Exceptions
Throws SetaPDF_Core_Font_Exception
Throws SetaPDF_Core_Type_Exception
getFontBBoxVector()
Get a font bounding box vector.
Parameters
- $name : int
- $fontSize : float
Exceptions
Throws SetaPDF_Core_Exception
getFontMatrix()
getGlyphWidth()
Get the width of a glyph/character.
Parameters
- $char : string
- $encoding : string
The input encoding
Exceptions
Throws SetaPDF_Core_Font_Exception
Throws SetaPDF_Core_Type_Exception
See
getGlyphWidthByCharCode()
Get the width of a glpyh by its char code.
Parameters
- $charCode : string
Exceptions
Throws SetaPDF_Core_Font_Exception
Throws SetaPDF_Core_Type_Exception
getGlyphsWidth()
Get the width of the glyphs/characters.
Parameters
- $chars : string
The characters
- $encoding : string
The input encoding
getIndirectObject()
Gets an indirect object for this font.
Parameters
- $document : SetaPDF_Core_Document
Exceptions
Throws InvalidArgumentException
See
getMaxWidth()
getMissingWidth()
getType()
isBold()
recalculateFontBBox()
Exceptions
Throws SetaPDF_Core_Exception
Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException
Throws SetaPDF_Core_Type_Exception
Throws SetaPDF_Exception
setUnderlinePosition()
Sets the underline position for the current font.
Parameters
- $position : int|float
setUnderlineThickness()
Sets the underline thickness for the current font.
Parameters
- $thickness : int|float