PdfFont (org.jpedal:OpenViewerFX 7.12.28 API)

java.lang.Object
- org.jpedal.fonts.PdfFont

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

TrueType, Type1, Type3
```
public class PdfFont
extends Object
implements Serializable
```
contains all generic pdf font data for fonts.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`allNumbers`
`String`	`CMapName`
`protected boolean`	`containsHexNumbers`
`protected String`	`copyright`
`protected PdfObjectReader`	`currentPdfFile` handle onto file access
`protected String[]`	`diffs` holds lookup to map char differences in embedded font
`protected int`	`embeddedEnc` embedded encoding
`protected String`	`embeddedFamilyName`
`protected String`	`embeddedFontName`
`CmapSpec`	`encodingCmapSpec` adobe specified cmaps used in encoding
`float[]`	`FontBBox` font bounding box
`protected int`	`fontEnc` encoding pattern used for font.
`protected String`	`fontID` String used to reference font (ie F1)
`double[]`	`FontMatrix` FontBBox for font
`protected int`	`fontTypes` font type
`PdfJavaGlyphs`	`glyphs`
`boolean`	`hasDoubleBytes`
`protected boolean`	`hasEncoding` show if encoding set
`protected boolean`	`isCIDFont` flag to show type of font
`boolean`	`isFontEmbedded` flag to show if Font included embedded data
`protected boolean`	`isFontSubstituted`
`protected boolean`	`isFontVertical`
`protected boolean`	`isHex` flag to show Gxxx, Bxxx, Cxxx.
`protected int`	`italicAngle`
`protected ClassLoader`	`loader` loader to load data from jar
`protected int`	`maxCharCount` number of glyphs - 65536 for CID fonts
`protected Map<String,Integer>`	`rawDiffKeys`
`protected boolean`	`renderPage`
`protected String`	`substituteFont`
`protected String`	`substituteFontFile`
`protected boolean`	`TTstreamisCID`

Constructor Summary

Constructors
Constructor and Description

PdfFont()

PdfFont(PdfObjectReader current_pdf_file)
get handles onto Reader so we can access the file

Constructors
Constructor and Description
`PdfFont()`
`PdfFont(PdfObjectReader current_pdf_file)` get handles onto Reader so we can access the file

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`createCIDFont(PdfObject pdfObject, PdfObject Descendent)` generic CID code
`void`	`createFont(PdfObject pdfObject, String fontID, boolean renderPage, ObjectStore objectStore, Map<String,PdfJavaGlyphs> substitutedFonts)` read in a font and its details from the pdf file
`String`	`getBaseFontName()` get raw font name which may include +xxxxxx
`Rectangle`	`getBoundingBox()` get bounding box to highlight
`int[]`	`getCIDToGIDMap()`
`String[]`	`getCMAP()`
`String`	`getCopyright()` get the copyright information
`float`	`getCurrentFontSpaceWidth()` get width of a space
`float`	`getDefaultWidth(int idx)` returns width or value in widthTable (-1 if no width set) idx=-1 returns default
`float`	`getDescent()`
`int`	`getDiffChar(int index)`
`int`	`getDiffChar(String glypName)` used by PDF2HTML5 where encoding different from index in TJ command and we need to remap via glyf name (ie sample_pdf_htmls/thoughtcorp/Simple Relational Contracts.pdf)
`String`	`getDiffMapping(int charInt)` return char mapped onto value in Differences or null
`String`	`getEmbeddedChar(int charInt)`
`int`	`getEncodedCMAPValue(int ptr)` looks up ptr in any CID CMAP in font
`float[]`	`getFontBounds()`
`int`	`getFontEncoding(boolean notNull)`
`String`	`getFontID()`
`String`	`getFontName()` get font name as a string from ID (ie Tf /F1) and load if one of Adobe 14
`int`	`getFontType()` gets type of font (ie 3 ) so we can call type specific code.
`PdfJavaGlyphs`	`getGlyphData()`
`String`	`getGlyphValue(int rawInt)` convert value read from TJ operand into correct glyph Also check to see if mapped onto unicode value
`float`	`getGlyphWidth(String charGlyph, int rawInt, String displayValue)` used in generic renderer
`Font`	`getJavaFontX(int size)` Returns the java font, initializing it first if it hasn't been used before.
`String`	`getMappedChar(int charInt, boolean remap)` Returns the char glyph corresponding to the specified code for the specified font.
`int`	`getObjID()`
`static String`	`getSpaces(float currentGap, float spaceWidth, float currentThreshold)` workout spaces (if any) to add into content for a gap from user settings, space info in pdf
`float`	`getSpaceWidthHTML()` get width of a space for HTML
`String`	`getSubstituteFont()` name of font and Path used to display
`PdfObject`	`getToUnicode()`
`String`	`getTruncatedName()`
`String`	`getUnicodeMapping(int char_int)` return unicode value for this index value
`String`	`getUnicodeValue(String displayValue, int rawInt)` return the mapped character
`float`	`getWidth(int charInt)` Returns width of the specified character Allows for no value set
`boolean`	`hasToUnicode()` Used by HTML code to tell whether to use CID range remapping or not
`protected void`	`init(PdfObjectReader current_pdf_file)` set number of glyphs to 256 or 65536
`protected void`	`init(String fontID, boolean renderPage)`
`boolean`	`is1C()`
`boolean`	`isBrokenFont()` workaround to handle issue with some odd SAP files Please do not use.
`boolean`	`isCIDFont()` flag if CID font
`int`	`isDoubleBytes()` flag to show if double (1), single (0) or unset (-1)
`int`	`isDoubleBytes(int firstVal, int secondByte, boolean secondByteIsEscaped)` work out if 1 or 2 bytes for each char
`boolean`	`isFontSubsetted()`
`boolean`	`isFontSubstituted()` used to show truetype used for type 0 CID
`boolean`	`isFontVertical()`
`boolean`	`isSingleByte()`
`boolean`	`isWidthVertical()`
`void`	`putFontEncoding(int enc)` store encoding and load required mappings
`protected void`	`putMappedChar(int charInt, String mappedChar)` Insert a new mapped char in the name mapping table
`void`	`readWidths(PdfObject pdfObject, boolean setSpace)` read in width values
`void`	`resetNameForHTML(String newName)` used by PDF2HTML to replace unsuitable characters and make sure unique
`protected void`	`setBoundsAndMatrix(PdfObject pdfFontDescriptor)`
`void`	`setDefaultDisplayFont(String fontName)` set the font used for default from Java fonts on system - check it is a valid font (otherwise it will default to Lucida anyway)
`protected void`	`setEncoding(PdfObject pdfObject, PdfObject pdfFontDescriptor)`
`void`	`setFont(String font, int textSize)`
`void`	`setLastWidth(float lastWidth)`
`protected void`	`setName(PdfObject pdfObject)`
`void`	`setRawFontName(String baseFont)`
`void`	`setValuesForGlyph(int rawInt, String charGlyph, String displayValue, String embeddedChar)`

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

Field Detail

CMapName
```
public String CMapName
```

containsHexNumbers
```
protected boolean containsHexNumbers
```

allNumbers
```
protected boolean allNumbers
```

embeddedFontName
```
protected String embeddedFontName
```

embeddedFamilyName
```
protected String embeddedFamilyName
```

isFontVertical
```
protected boolean isFontVertical
```

glyphs
```
public PdfJavaGlyphs glyphs
```

hasDoubleBytes
```
public boolean hasDoubleBytes
```

encodingCmapSpec
```
public CmapSpec encodingCmapSpec
```
adobe specified cmaps used in encoding

substituteFont
```
protected String substituteFont
```

renderPage
```
protected boolean renderPage
```

embeddedEnc
```
protected int embeddedEnc
```
embedded encoding

diffs
```
protected String[] diffs
```
holds lookup to map char differences in embedded font

isFontEmbedded
```
public boolean isFontEmbedded
```
flag to show if Font included embedded data

TTstreamisCID
```
protected boolean TTstreamisCID
```

fontID
```
protected String fontID
```
String used to reference font (ie F1)

maxCharCount
```
protected int maxCharCount
```
number of glyphs - 65536 for CID fonts

hasEncoding
```
protected boolean hasEncoding
```
show if encoding set

fontTypes
```
protected int fontTypes
```
font type

substituteFontFile
```
protected String substituteFontFile
```

rawDiffKeys

protected final Map<String,Integer> rawDiffKeys

currentPdfFile

protected PdfObjectReader currentPdfFile

handle onto file access

loader
```
protected final ClassLoader loader
```
loader to load data from jar

FontMatrix
```
public double[] FontMatrix
```
FontBBox for font

FontBBox
```
public float[] FontBBox
```
font bounding box

isHex
```
protected boolean isHex
```
flag to show Gxxx, Bxxx, Cxxx.

fontEnc
```
protected int fontEnc
```
encoding pattern used for font. -1 means not set

isCIDFont
```
protected boolean isCIDFont
```
flag to show type of font

isFontSubstituted
```
protected boolean isFontSubstituted
```

italicAngle
```
protected int italicAngle
```

Constructor Detail
- PdfFont
```
public PdfFont()
```
- PdfFont
```
public PdfFont(PdfObjectReader current_pdf_file)
```
  get handles onto Reader so we can access the file

Method Detail

getTruncatedName
```
public String getTruncatedName()
```

isFontSubstituted
```
public boolean isFontSubstituted()
```
used to show truetype used for type 0 CID

isCIDFont
```
public final boolean isCIDFont()
```
flag if CID font

init

protected final void init(PdfObjectReader current_pdf_file)

set number of glyphs to 256 or 65536

getUnicodeMapping

public final String getUnicodeMapping(int char_int)

return unicode value for this index value

putFontEncoding
```
public final void putFontEncoding(int enc)
```
store encoding and load required mappings

getUnicodeValue

public final String getUnicodeValue(String displayValue,
                                    int rawInt)

return the mapped character

getGlyphValue
```
public final String getGlyphValue(int rawInt)
```
convert value read from TJ operand into correct glyph
Also check to see if mapped onto unicode value

setDefaultDisplayFont
```
public final void setDefaultDisplayFont(String fontName)
```
set the font used for default from Java fonts on system - check it is a valid font (otherwise it will default to Lucida anyway)

getJavaFontX
```
public final Font getJavaFontX(int size)
```
Returns the java font, initializing it first if it hasn't been used before.

getFontName
```
public final String getFontName()
```
get font name as a string from ID (ie Tf /F1) and load if one of Adobe 14

getCopyright
```
public final String getCopyright()
```
get the copyright information

getBaseFontName
```
public final String getBaseFontName()
```
get raw font name which may include +xxxxxx

getCurrentFontSpaceWidth

public final float getCurrentFontSpaceWidth()

get width of a space

getSpaceWidthHTML
```
public final float getSpaceWidthHTML()
```
get width of a space for HTML

getFontEncoding

public final int getFontEncoding(boolean notNull)

getWidth
```
public final float getWidth(int charInt)
```
Returns width of the specified character
Allows for no value set

createCIDFont

public void createCIDFont(PdfObject pdfObject,
                          PdfObject Descendent)
                   throws PdfFontException

generic CID code

Throws:: PdfFontException

readWidths

public void readWidths(PdfObject pdfObject,
                       boolean setSpace)
                throws Exception

read in width values

Throws:: Exception

createFont

public void createFont(PdfObject pdfObject,
                       String fontID,
                       boolean renderPage,
                       ObjectStore objectStore,
                       Map<String,PdfJavaGlyphs> substitutedFonts)
                throws Exception

read in a font and its details from the pdf file

Throws:: Exception

setName

protected void setName(PdfObject pdfObject)

resetNameForHTML
```
public void resetNameForHTML(String newName)
```
used by PDF2HTML to replace unsuitable characters and make sure unique

Parameters:

newName -

getObjID
```
public int getObjID()
```

setEncoding

protected void setEncoding(PdfObject pdfObject,
                           PdfObject pdfFontDescriptor)

getDescent
```
public float getDescent()
```

setBoundsAndMatrix

protected void setBoundsAndMatrix(PdfObject pdfFontDescriptor)

init

protected void init(String fontID,
                    boolean renderPage)

getDiffChar
```
public final int getDiffChar(String glypName)
```
used by PDF2HTML5 where encoding different from index in TJ command and we need to remap via glyf name (ie sample_pdf_htmls/thoughtcorp/Simple Relational Contracts.pdf)

Parameters:

glypName -

Returns:

putMappedChar

protected final void putMappedChar(int charInt,
                                   String mappedChar)

Insert a new mapped char in the name mapping table

getDiffMapping
```
public String getDiffMapping(int charInt)
```
return char mapped onto value in Differences or null

Parameters:

charInt -

Returns:

getMappedChar

public final String getMappedChar(int charInt,
                                  boolean remap)

Returns the char glyph corresponding to the specified code for the specified font.

getEmbeddedChar

public final String getEmbeddedChar(int charInt)

getFontType
```
public final int getFontType()
```
gets type of font (ie 3 ) so we can call type specific code.

Returns:

int of type

getSubstituteFont
```
public String getSubstituteFont()
```
name of font and Path used to display

getGlyphWidth

public float getGlyphWidth(String charGlyph,
                           int rawInt,
                           String displayValue)

used in generic renderer

getGlyphData
```
public PdfJavaGlyphs getGlyphData()
```

setFont

public void setFont(String font,
                    int textSize)

is1C
```
public boolean is1C()
```

isFontSubsetted
```
public boolean isFontSubsetted()
```

setValuesForGlyph

public void setValuesForGlyph(int rawInt,
                              String charGlyph,
                              String displayValue,
                              String embeddedChar)

getBoundingBox
```
public Rectangle getBoundingBox()
```
get bounding box to highlight

Returns:

setRawFontName

public void setRawFontName(String baseFont)

getSpaces

public static String getSpaces(float currentGap,
                               float spaceWidth,
                               float currentThreshold)

workout spaces (if any) to add into content for a gap from user settings, space info in pdf

getDiffChar
```
public int getDiffChar(int index)
```

getFontBounds
```
public float[] getFontBounds()
```

isFontVertical
```
public boolean isFontVertical()
```

setLastWidth

public void setLastWidth(float lastWidth)

Parameters:: lastWidth -

getFontID
```
public String getFontID()
```

isSingleByte
```
public boolean isSingleByte()
```

isBrokenFont
```
public boolean isBrokenFont()
```
workaround to handle issue with some odd SAP files Please do not use.

Returns:

hasToUnicode
```
public boolean hasToUnicode()
```
Used by HTML code to tell whether to use CID range remapping or not

Returns:

Whether a 'ToUnicode' dictionary is provided.

getDefaultWidth
```
public float getDefaultWidth(int idx)
```
returns width or value in widthTable (-1 if no width set) idx=-1 returns default

isDoubleBytes

public int isDoubleBytes(int firstVal,
                         int secondByte,
                         boolean secondByteIsEscaped)

work out if 1 or 2 bytes for each char

Parameters:: firstVal -; secondByte -; secondByteIsEscaped -
Returns:: 0=false 1=true -1=unset

isDoubleBytes
```
public int isDoubleBytes()
```
flag to show if double (1), single (0) or unset (-1)

Returns:

getToUnicode
```
public PdfObject getToUnicode()
```

getCIDToGIDMap
```
public int[] getCIDToGIDMap()
```

getEncodedCMAPValue
```
public int getEncodedCMAPValue(int ptr)
```
looks up ptr in any CID CMAP in font

Parameters:

ptr -

Returns:

-1 if no CMAP, otherwise value

getCMAP
```
public String[] getCMAP()
```

isWidthVertical
```
public boolean isWidthVertical()
```

Class PdfFont

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CMapName

containsHexNumbers

allNumbers

embeddedFontName

embeddedFamilyName

copyright

isFontVertical

glyphs

hasDoubleBytes

encodingCmapSpec

substituteFont

renderPage

embeddedEnc

diffs

isFontEmbedded

TTstreamisCID

fontID

maxCharCount

hasEncoding

fontTypes

substituteFontFile

rawDiffKeys

currentPdfFile

loader

FontMatrix

FontBBox

isHex

fontEnc

isCIDFont

isFontSubstituted

italicAngle

Constructor Detail

PdfFont

PdfFont

Method Detail

getTruncatedName

isFontSubstituted

isCIDFont

init

getUnicodeMapping

putFontEncoding

getUnicodeValue

getGlyphValue

setDefaultDisplayFont

getJavaFontX

getFontName

getCopyright

getBaseFontName

getCurrentFontSpaceWidth

getSpaceWidthHTML

getFontEncoding

getWidth

createCIDFont

readWidths

createFont

setName

resetNameForHTML

getObjID

setEncoding

getDescent

setBoundsAndMatrix

init

getDiffChar

putMappedChar

getDiffMapping

getMappedChar

getEmbeddedChar

getFontType

getSubstituteFont

getGlyphWidth

getGlyphData

setFont

is1C

isFontSubsetted