Package org.apache.pdfbox.pdmodel.font
Class PDFont
java.lang.Object
org.apache.pdfbox.pdmodel.font.PDFont
- All Implemented Interfaces:
COSObjectable
,PDFontLike
- Direct Known Subclasses:
PDSimpleFont
,PDType0Font
This is the base class for all PDF fonts.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final FontMetrics
AFM for standard 14 fontsprivate float
protected static final Matrix
protected final COSDictionary
private PDFontDescriptor
private float
private static final org.apache.commons.logging.Log
private final CMap
-
Constructor Summary
ConstructorsModifierConstructorDescription(package private)
PDFont()
Constructor for embedding.(package private)
Constructor for Standard 14.protected
PDFont
(COSDictionary fontDictionary) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionabstract 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.final byte[]
Encodes the given string for use in a PDF content stream.boolean
float
This will get the average font width for all characters.Convert this standard java object to a COS object.getDisplacement
(int code) Returns the displacement vector (w0, w1) in text space, for the given character.Returns the font descriptor, may be null.Returns the font matrix, which represents the transformation from glyph space to text space.getPositionVector
(int code) Returns the position vector (v), in text space, for the given character.float
Determines the width of the space character.protected final FontMetrics
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.This will get the subtype of font.protected CMap
Get the /ToUnicode CMap.getType()
This will always return "Font" for fonts.float
getWidth
(int code) Returns the advance width of the given character, in glyph space.The widths of the characters.int
hashCode()
boolean
Returns true if this font is one of the "Standard 14" fonts and receives special handling.abstract boolean
Returns true if the font uses vertical writing mode.private PDFontDescriptor
private CMap
protected final CMap
Reads a CMap given a COS Stream or Name.abstract int
readCode
(InputStream in) Reads a character code from a content stream string.protected final 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.toString()
toUnicode
(int code) Returns the Unicode character sequence which corresponds to the given character code.Returns the Unicode character sequence which corresponds to the given character code.abstract boolean
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
Methods inherited from interface org.apache.pdfbox.pdmodel.font.PDFontLike
getBoundingBox, getHeight, getName, getWidthFromFont, hasExplicitWidth, isDamaged, isEmbedded
-
Field Details
-
LOG
private static final org.apache.commons.logging.Log LOG -
DEFAULT_FONT_MATRIX
-
dict
-
toUnicodeCMap
-
afmStandard14
AFM for standard 14 fonts -
fontDescriptor
-
widths
-
avgFontWidth
private float avgFontWidth -
fontWidthOfSpace
private float fontWidthOfSpace -
codeToWidthMap
-
-
Constructor Details
-
PDFont
PDFont()Constructor for embedding. -
PDFont
PDFont(String baseFont) Constructor for Standard 14. -
PDFont
Constructor.- Parameters:
fontDictionary
- Font dictionary.- Throws:
IOException
-
-
Method Details
-
loadFontDescriptor
-
loadUnicodeCmap
-
getStandard14AFM
Returns the AFM if this is a Standard 14 font. -
getFontDescriptor
Description copied from interface:PDFontLike
Returns the font descriptor, may be null.- Specified by:
getFontDescriptor
in interfacePDFontLike
-
setFontDescriptor
Sets the font descriptor when embedding a font. -
readCMap
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
Description copied from interface:COSObjectable
Convert this standard java object to a COS object.- Specified by:
getCOSObject
in interfaceCOSObjectable
- Returns:
- The cos object that matches this Java object.
-
getPositionVector
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 interfacePDFontLike
- Parameters:
code
- character code- Returns:
- position vector
-
getDisplacement
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
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. See the cyan rectangles in the DrawPrintTextLocations.java example to see this in action.
- Specified by:
getWidth
in interfacePDFontLike
- 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
-
encode
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.IllegalArgumentException
- if a character isn't supported by the font.
-
encode
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.IllegalArgumentException
- if a character isn't supported by the font.
-
getStringWidth
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.IllegalArgumentException
- if a character isn't supported by the font.
-
getAverageFontWidth
public float getAverageFontWidth()This will get the average font width for all characters.- Specified by:
getAverageFontWidth
in interfacePDFontLike
- Returns:
- The width is in 1000 unit of text space, ie 333 or 777
-
readCode
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
Returns the Unicode character sequence which corresponds to the given character code.- Parameters:
code
- character codecustomGlyphList
- a custom glyph list to use instead of the Adobe Glyph List- Returns:
- Unicode character(s)
- Throws:
IOException
-
toUnicode
Returns the Unicode character sequence which corresponds to the given character code.- Parameters:
code
- character code- Returns:
- Unicode character(s)
- Throws:
IOException
-
getType
This will always return "Font" for fonts.- Returns:
- The type of object that this is.
-
getSubType
This will get the subtype of font. -
getWidths
The widths of the characters. This will be null for the standard 14 fonts.- Returns:
- The widths of the characters.
-
getFontMatrix
Description copied from interface:PDFontLike
Returns the font matrix, which represents the transformation from glyph space to text space.- Specified by:
getFontMatrix
in interfacePDFontLike
-
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
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. -
equals
-
hashCode
public int hashCode() -
toString
-
getToUnicodeCMap
Get the /ToUnicode CMap.- Returns:
- The /ToUnicode CMap or null if there is none.
-