PDFont (x-easypdf-pdfbox 3.2.0 API)

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

所有已实现的接口:

org.apache.pdfbox.pdmodel.common.COSObjectable, org.apache.pdfbox.pdmodel.font.PDFontLike
```
public abstract class PDFont
extends Object
implements org.apache.pdfbox.pdmodel.common.COSObjectable, org.apache.pdfbox.pdmodel.font.PDFontLike
```
从以下版本开始:

1.8

作者:

xsx

字段概要

字段
限定符和类型字段和说明

protected static org.apache.pdfbox.util.Matrix DEFAULT_FONT_MATRIX

protected org.apache.pdfbox.cos.COSDictionary dict

字段
限定符和类型	字段和说明
`protected static org.apache.pdfbox.util.Matrix`	`DEFAULT_FONT_MATRIX`
`protected org.apache.pdfbox.cos.COSDictionary`	`dict`

构造器概要

构造器
限定符构造器和说明

protected PDFont(org.apache.pdfbox.cos.COSDictionary fontDictionary)
Constructor.

构造器
限定符	构造器和说明
`protected`	`PDFont(org.apache.pdfbox.cos.COSDictionary fontDictionary)` Constructor.

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`abstract void`	`addToSubset(int codePoint)` Adds the given Unicode point to the subset.
`byte[]`	`encode(Character character)` Encodes the given character for use in a PDF content stream.
`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.
`float`	`getCharacterWidth(Character character)` Returns the width of the given Unicode character.
`org.apache.pdfbox.cos.COSDictionary`	`getCOSObject()`
`org.apache.pdfbox.util.Vector`	`getDisplacement(int code)` Returns the displacement vector (w0, w1) in text space, for the given character.
`org.apache.pdfbox.pdmodel.font.PDFontDescriptor`	`getFontDescriptor()`
`org.apache.pdfbox.util.Matrix`	`getFontMatrix()`
`org.apache.pdfbox.util.Vector`	`getPositionVector(int code)`
`float`	`getRealWidth(int code, float size)`
`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.
`protected org.apache.fontbox.cmap.CMap`	`getToUnicodeCMap()` Get the /ToUnicode CMap.
`String`	`getType()` This will always return "Font" for fonts.
`float`	`getWidth(int code)`
`protected List<Float>`	`getWidths()` The widths of the characters.
`int`	`hashCode()`
`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(org.apache.pdfbox.cos.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(org.apache.pdfbox.pdmodel.font.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, org.apache.pdfbox.pdmodel.font.encoding.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.

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 org.apache.pdfbox.pdmodel.font.PDFontLike
getBoundingBox, getHeight, getName, getWidthFromFont, hasExplicitWidth, isDamaged, isEmbedded

- 字段详细资料
  - DEFAULT_FONT_MATRIX
```
protected static final org.apache.pdfbox.util.Matrix DEFAULT_FONT_MATRIX
```
  - dict
```
protected final org.apache.pdfbox.cos.COSDictionary dict
```
- 构造器详细资料
  - PDFont
```
protected PDFont(org.apache.pdfbox.cos.COSDictionary fontDictionary)
```
    Constructor.
    
    参数:
    
    fontDictionary - Font dictionary.
- 方法详细资料
  - getStandard14AFM
```
protected final org.apache.fontbox.afm.FontMetrics getStandard14AFM()
```
    Returns the AFM if this is a Standard 14 font.
    
    返回:
    
    the AFM
  - getFontDescriptor
```
public org.apache.pdfbox.pdmodel.font.PDFontDescriptor getFontDescriptor()
```
    指定者:
    
    getFontDescriptor 在接口中 org.apache.pdfbox.pdmodel.font.PDFontLike
  - setFontDescriptor
```
protected final void setFontDescriptor(org.apache.pdfbox.pdmodel.font.PDFontDescriptor fontDescriptor)
```
    Sets the font descriptor when embedding a font.
    
    参数:
    
    fontDescriptor - font descriptor of the embedded font
  - readCMap
```
protected final org.apache.fontbox.cmap.CMap readCMap(org.apache.pdfbox.cos.COSBase base)
                                               throws IOException
```
    Reads a CMap given a COS Stream or Name. May return null if a predefined CMap does not exist.
    
    参数:
    
    base - COSName or COSStream
    
    返回:
    
    the CMap if present
    
    抛出:
    
    IOException - if the CMap could not be read
  - getCOSObject
```
public org.apache.pdfbox.cos.COSDictionary getCOSObject()
```
    指定者:
    
    getCOSObject 在接口中 org.apache.pdfbox.pdmodel.common.COSObjectable
  - getPositionVector
```
public org.apache.pdfbox.util.Vector getPositionVector(int code)
```
    指定者:
    
    getPositionVector 在接口中 org.apache.pdfbox.pdmodel.font.PDFontLike
  - getDisplacement
```
public org.apache.pdfbox.util.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.
    
    参数:
    
    code - character code
    
    返回:
    
    displacement vector
    
    抛出:
    
    IOException - if the data could not be read
  - getRealWidth
```
public float getRealWidth(int code,
                          float size)
                   throws IOException
```
    抛出:
    
    IOException
  - getWidth
```
public float getWidth(int code)
               throws IOException
```
    指定者:
    
    getWidth 在接口中 org.apache.pdfbox.pdmodel.font.PDFontLike
    
    抛出:
    
    IOException
  - getStandard14Width
```
protected abstract float getStandard14Width(int code)
```
    Returns the glyph width from the AFM if this is a Standard 14 font.
    
    参数:
    
    code - character code
    
    返回:
    
    width in 1/1000 text space
  - encode
```
public final byte[] encode(String text)
                    throws IOException
```
    Encodes the given string for use in a PDF content stream.
    
    参数:
    
    text - Any Unicode text.
    
    返回:
    
    Array of PDF content stream bytes.
    
    抛出:
    
    IOException - If the text could not be encoded.
    
    IllegalArgumentException - if a character isn't supported by the font.
  - encode
```
public final byte[] encode(Character character)
                    throws IOException
```
    Encodes the given character for use in a PDF content stream.
    
    参数:
    
    character - Any Unicode character.
    
    返回:
    
    Array of PDF content stream bytes.
    
    抛出:
    
    IOException - If the text could not be encoded.
    
    IllegalArgumentException - if a character isn't supported by the font.
  - encode
```
public 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.
    
    参数:
    
    unicode - Unicode code point.
    
    返回:
    
    Array of 1 to 4 PDF content stream bytes.
    
    抛出:
    
    IOException - If the text could not be encoded.
    
    IllegalArgumentException - if a character isn't supported by the font.
  - getStringWidth
```
public float getStringWidth(String text)
                     throws IOException
```
    Returns the width of the given Unicode string.
    
    参数:
    
    text - The text to get the width of.
    
    返回:
    
    The width of the string in 1/1000 units of text space.
    
    抛出:
    
    IOException - If there is an error getting the width information.
    
    IllegalArgumentException - if a character isn't supported by the font.
  - getCharacterWidth
```
public float getCharacterWidth(Character character)
                        throws IOException
```
    Returns the width of the given Unicode character.
    
    参数:
    
    character - The character to get the width of.
    
    返回:
    
    The width of the string in 1/1000 units of text space.
    
    抛出:
    
    IOException - If there is an error getting the width information.
    
    IllegalArgumentException - if a character isn't supported by the font.
  - getAverageFontWidth
```
public float getAverageFontWidth()
```
    This will get the average font width for all characters.
    
    指定者:
    
    getAverageFontWidth 在接口中 org.apache.pdfbox.pdmodel.font.PDFontLike
    
    返回:
    
    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.
    
    参数:
    
    in - string stream
    
    返回:
    
    character code
    
    抛出:
    
    IOException - if the CMap or stream cannot be read
  - toUnicode
```
public String toUnicode(int code,
                        org.apache.pdfbox.pdmodel.font.encoding.GlyphList customGlyphList)
```
    Returns the Unicode character sequence which corresponds to the given character code.
    
    参数:
    
    code - character code
    
    customGlyphList - a custom glyph list to use instead of the Adobe Glyph List
    
    返回:
    
    Unicode character(s)
  - toUnicode
```
public String toUnicode(int code)
```
    Returns the Unicode character sequence which corresponds to the given character code.
    
    参数:
    
    code - character code
    
    返回:
    
    Unicode character(s)
  - getType
```
public String getType()
```
    This will always return "Font" for fonts.
    
    返回:
    
    The type of object that this is.
  - getSubType
```
public String getSubType()
```
    This will get the subtype of font.
    
    返回:
    
    the subtype
  - getWidths
```
protected final List<Float> getWidths()
```
    The widths of the characters. This will be null for the standard 14 fonts.
    
    返回:
    
    The widths of the characters.
  - getFontMatrix
```
public org.apache.pdfbox.util.Matrix getFontMatrix()
```
    指定者:
    
    getFontMatrix 在接口中 org.apache.pdfbox.pdmodel.font.PDFontLike
  - getSpaceWidth
```
public float getSpaceWidth()
```
    Determines the width of the space character.
    
    返回:
    
    the width of the space character
  - isVertical
```
public abstract boolean isVertical()
```
    Returns true if the font uses vertical writing mode.
    
    返回:
    
    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.
    
    返回:
    
    true if this font is one of the "Standard 14" fonts
  - addToSubset
```
public abstract void addToSubset(int codePoint)
```
    Adds the given Unicode point to the subset.
    
    参数:
    
    codePoint - Unicode code point
  - subset
```
public abstract void subset()
                     throws IOException
```
    Replaces this font with a subset containing only the given Unicode characters.
    
    抛出:
    
    IOException - if the subset could not be written
  - willBeSubset
```
public abstract boolean willBeSubset()
```
    Returns true if this font will be subset when embedded.
    
    返回:
    
    true if this font will be subset when embedded
  - equals
```
public boolean equals(Object other)
```
    覆盖:
    
    equals 在类中 Object
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 Object
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - getToUnicodeCMap
```
protected org.apache.fontbox.cmap.CMap getToUnicodeCMap()
```
    Get the /ToUnicode CMap.
    
    返回:
    
    The /ToUnicode CMap or null if there is none.

类 PDFont

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

从接口继承的方法 org.apache.pdfbox.pdmodel.font.PDFontLike

字段详细资料

DEFAULT_FONT_MATRIX

dict

构造器详细资料

PDFont

方法详细资料

getStandard14AFM

getFontDescriptor

setFontDescriptor

readCMap

getCOSObject

getPositionVector

getDisplacement

getRealWidth

getWidth

getStandard14Width

encode

encode

encode

getStringWidth

getCharacterWidth

getAverageFontWidth

readCode

toUnicode

toUnicode

getType

getSubType

getWidths

getFontMatrix

getSpaceWidth

isVertical

isStandard14

addToSubset

subset

willBeSubset

equals

hashCode

toString

getToUnicodeCMap