Package org.apache.pdfbox.pdmodel.font
Class PDType1Font
- java.lang.Object
-
- org.apache.pdfbox.pdmodel.font.PDFont
-
- org.apache.pdfbox.pdmodel.font.PDSimpleFont
-
- org.apache.pdfbox.pdmodel.font.PDType1Font
-
- All Implemented Interfaces:
COSObjectable
,PDFontLike
- Direct Known Subclasses:
PDMMType1Font
public class PDType1Font extends PDSimpleFont
A PostScript Type 1 Font.- Author:
- Ben Litchfield
-
-
Field Summary
Fields Modifier and Type Field Description static PDType1Font
COURIER
static PDType1Font
COURIER_BOLD
static PDType1Font
COURIER_BOLD_OBLIQUE
static PDType1Font
COURIER_OBLIQUE
static PDType1Font
HELVETICA
static PDType1Font
HELVETICA_BOLD
static PDType1Font
HELVETICA_BOLD_OBLIQUE
static PDType1Font
HELVETICA_OBLIQUE
static PDType1Font
SYMBOL
static PDType1Font
TIMES_BOLD
static PDType1Font
TIMES_BOLD_ITALIC
static PDType1Font
TIMES_ITALIC
static PDType1Font
TIMES_ROMAN
static PDType1Font
ZAPF_DINGBATS
-
Fields inherited from class org.apache.pdfbox.pdmodel.font.PDSimpleFont
encoding, glyphList
-
Fields inherited from class org.apache.pdfbox.pdmodel.font.PDFont
DEFAULT_FONT_MATRIX, dict
-
-
Constructor Summary
Constructors Constructor Description PDType1Font(COSDictionary fontDictionary)
Creates a Type 1 font from a Font dictionary in a PDF.PDType1Font(PDDocument doc, java.io.InputStream pfbIn)
Creates a new Type 1 font for embedding.PDType1Font(PDDocument doc, java.io.InputStream pfbIn, Encoding encoding)
Creates a new Type 1 font for embedding.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
codeToName(int code)
protected byte[]
encode(int unicode)
Encodes the given Unicode code point for use in a PDF content stream.float
getAverageFontWidth()
This will get the average font width for all characters.java.lang.String
getBaseFont()
Returns the PostScript name of the font.org.apache.fontbox.util.BoundingBox
getBoundingBox()
Returns the font's bounding box.org.apache.fontbox.FontBoxFont
getFontBoxFont()
Returns the embedded or system font used for rendering.Matrix
getFontMatrix()
Returns the font matrix, which represents the transformation from glyph space to text space.float
getHeight(int code)
Returns the height of the given character, in glyph space.java.lang.String
getName()
Returns the name of this font, either the PostScript "BaseName" or the Type 3 "Name".java.awt.geom.GeneralPath
getPath(java.lang.String name)
Returns the path for the character with the given name.org.apache.fontbox.type1.Type1Font
getType1Font()
Returns the embedded or substituted Type 1 font, or null if there is none.float
getWidthFromFont(int code)
Returns the width of a glyph in the embedded font file.boolean
hasGlyph(java.lang.String name)
Returns true if the font contains the character with the given name.boolean
isDamaged()
Returns true if the embedded font file is damaged.boolean
isEmbedded()
Returns true if the font file is embedded in the PDF.int
readCode(java.io.InputStream in)
Reads a character code from a content stream string.protected Encoding
readEncodingFromFont()
Called by readEncoding() if the encoding needs to be extracted from the font file.-
Methods inherited from class org.apache.pdfbox.pdmodel.font.PDSimpleFont
addToSubset, getEncoding, getGlyphList, getStandard14Width, getSymbolicFlag, hasExplicitWidth, isFontSymbolic, isStandard14, isSymbolic, isVertical, readEncoding, subset, toUnicode, toUnicode, willBeSubset
-
Methods inherited from class org.apache.pdfbox.pdmodel.font.PDFont
encode, equals, getCOSObject, getDisplacement, getFontDescriptor, getPositionVector, getSpaceWidth, getStandard14AFM, getStringWidth, getSubType, getToUnicodeCMap, getType, getWidth, getWidths, hashCode, readCMap, setFontDescriptor, toString
-
-
-
-
Field Detail
-
TIMES_ROMAN
public static final PDType1Font TIMES_ROMAN
-
TIMES_BOLD
public static final PDType1Font TIMES_BOLD
-
TIMES_ITALIC
public static final PDType1Font TIMES_ITALIC
-
TIMES_BOLD_ITALIC
public static final PDType1Font TIMES_BOLD_ITALIC
-
HELVETICA
public static final PDType1Font HELVETICA
-
HELVETICA_BOLD
public static final PDType1Font HELVETICA_BOLD
-
HELVETICA_OBLIQUE
public static final PDType1Font HELVETICA_OBLIQUE
-
HELVETICA_BOLD_OBLIQUE
public static final PDType1Font HELVETICA_BOLD_OBLIQUE
-
COURIER
public static final PDType1Font COURIER
-
COURIER_BOLD
public static final PDType1Font COURIER_BOLD
-
COURIER_OBLIQUE
public static final PDType1Font COURIER_OBLIQUE
-
COURIER_BOLD_OBLIQUE
public static final PDType1Font COURIER_BOLD_OBLIQUE
-
SYMBOL
public static final PDType1Font SYMBOL
-
ZAPF_DINGBATS
public static final PDType1Font ZAPF_DINGBATS
-
-
Constructor Detail
-
PDType1Font
public PDType1Font(PDDocument doc, java.io.InputStream pfbIn) throws java.io.IOException
Creates a new Type 1 font for embedding.- Parameters:
doc
- PDF document to write topfbIn
- PFB file stream- Throws:
java.io.IOException
-
PDType1Font
public PDType1Font(PDDocument doc, java.io.InputStream pfbIn, Encoding encoding) throws java.io.IOException
Creates a new Type 1 font for embedding.- Parameters:
doc
- PDF document to write topfbIn
- PFB file streamencoding
-- Throws:
java.io.IOException
-
PDType1Font
public PDType1Font(COSDictionary fontDictionary) throws java.io.IOException
Creates a Type 1 font from a Font dictionary in a PDF.- Parameters:
fontDictionary
- font dictionary.- Throws:
java.io.IOException
- if there was an error initializing the font.java.lang.IllegalArgumentException
- if /FontFile3 was used.
-
-
Method Detail
-
getBaseFont
public final java.lang.String getBaseFont()
Returns the PostScript name of the font.
-
getHeight
public float getHeight(int code) throws java.io.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. See the cyan rectangles in the DrawPrintTextLocations.java example to see this in action.- Parameters:
code
- character code- Throws:
java.io.IOException
-
encode
protected byte[] encode(int unicode) throws java.io.IOException
Description copied from class:PDFont
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.
-
getWidthFromFont
public float getWidthFromFont(int code) throws java.io.IOException
Description copied from interface:PDFontLike
Returns the width of a glyph in the embedded font file.- Parameters:
code
- character code- Returns:
- width in glyph space
- Throws:
java.io.IOException
- if the font could not be read
-
isEmbedded
public boolean isEmbedded()
Description copied from interface:PDFontLike
Returns true if the font file is embedded in the PDF.
-
getAverageFontWidth
public float getAverageFontWidth()
Description copied from class:PDFont
This will get the average font width for all characters.- Specified by:
getAverageFontWidth
in interfacePDFontLike
- Overrides:
getAverageFontWidth
in classPDFont
- Returns:
- The width is in 1000 unit of text space, ie 333 or 777
-
readCode
public int readCode(java.io.InputStream in) throws java.io.IOException
Description copied from class:PDFont
Reads a character code from a content stream string. Codes may be up to 4 bytes long.
-
readEncodingFromFont
protected Encoding readEncodingFromFont() throws java.io.IOException
Description copied from class:PDSimpleFont
Called by readEncoding() if the encoding needs to be extracted from the font file.- Specified by:
readEncodingFromFont
in classPDSimpleFont
- Throws:
java.io.IOException
- if the font file could not be read.
-
getType1Font
public org.apache.fontbox.type1.Type1Font getType1Font()
Returns the embedded or substituted Type 1 font, or null if there is none.
-
getFontBoxFont
public org.apache.fontbox.FontBoxFont getFontBoxFont()
Description copied from class:PDSimpleFont
Returns the embedded or system font used for rendering. This is never null.- Specified by:
getFontBoxFont
in classPDSimpleFont
-
getName
public java.lang.String getName()
Description copied from interface:PDFontLike
Returns the name of this font, either the PostScript "BaseName" or the Type 3 "Name".
-
getBoundingBox
public org.apache.fontbox.util.BoundingBox getBoundingBox() throws java.io.IOException
Description copied from interface:PDFontLike
Returns the font's bounding box.- Throws:
java.io.IOException
-
codeToName
public java.lang.String codeToName(int code) throws java.io.IOException
- Throws:
java.io.IOException
-
getPath
public java.awt.geom.GeneralPath getPath(java.lang.String name) throws java.io.IOException
Description copied from class:PDSimpleFont
Returns the path for the character with the given name. For some fonts, GIDs may be used instead of names when calling this method.- Specified by:
getPath
in classPDSimpleFont
- Returns:
- glyph path
- Throws:
java.io.IOException
- if the path could not be read
-
hasGlyph
public boolean hasGlyph(java.lang.String name) throws java.io.IOException
Description copied from class:PDSimpleFont
Returns true if the font contains the character with the given name.- Specified by:
hasGlyph
in classPDSimpleFont
- Throws:
java.io.IOException
- if the path could not be read
-
getFontMatrix
public final 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 interfacePDFontLike
- Overrides:
getFontMatrix
in classPDFont
-
isDamaged
public boolean isDamaged()
Description copied from interface:PDFontLike
Returns true if the embedded font file is damaged.
-
-