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,PDVectorFont
- Direct Known Subclasses:
PDMMType1Font
public class PDType1Font extends PDSimpleFont implements PDVectorFont
A PostScript Type 1 Font.- Author:
- Ben Litchfield
-
-
Field Summary
-
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(Standard14Fonts.FontName baseFont)Creates a Type 1 standard 14 font for embedding.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.StringcodeToName(int code)protected byte[]encode(int unicode)Encodes the given Unicode code point for use in a PDF content stream.floatgetAverageFontWidth()This will get the average font width for all characters.java.lang.StringgetBaseFont()Returns the PostScript name of the font.org.apache.fontbox.util.BoundingBoxgetBoundingBox()Returns the font's bounding box.org.apache.fontbox.FontBoxFontgetFontBoxFont()Returns the embedded or system font used for rendering.MatrixgetFontMatrix()Returns the font matrix, which represents the transformation from glyph space to text space.floatgetHeight(int code)Returns the height of the given character, in glyph space.java.lang.StringgetName()Returns the name of this font, either the PostScript "BaseName" or the Type 3 "Name".java.awt.geom.GeneralPathgetNormalizedPath(int code)Returns the normalized glyph path for the given character code in a PDF.java.awt.geom.GeneralPathgetPath(int code)Returns the glyph path for the given character code.java.awt.geom.GeneralPathgetPath(java.lang.String name)Returns the path for the character with the given name.org.apache.fontbox.type1.Type1FontgetType1Font()Returns the embedded or substituted Type 1 font, or null if there is none.floatgetWidthFromFont(int code)Returns the width of a glyph in the embedded font file.booleanhasGlyph(int code)Returns true if this font contains a glyph for the given character code in a PDF.booleanhasGlyph(java.lang.String name)Returns true if the font contains the character with the given name.booleanisDamaged()Returns true if the embedded font file is damaged.booleanisEmbedded()Returns true if the font file is embedded in the PDF.intreadCode(java.io.InputStream in)Reads a character code from a content stream string.protected EncodingreadEncodingFromFont()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, isNonZeroBoundingBox, 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
-
-
-
-
Constructor Detail
-
PDType1Font
public PDType1Font(Standard14Fonts.FontName baseFont)
Creates a Type 1 standard 14 font for embedding.- Parameters:
baseFont- One of the standard 14 PostScript names, e.g.Standard14Fonts.FontName.HELVETICA_BOLD.
-
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- if the font could not be read
-
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- encoding to be used for the font- Throws:
java.io.IOException- if the font could not be read
-
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.- Returns:
- the PostScript name of the font
-
getHeight
public float getHeight(int code) throws java.io.IOExceptionDescription copied from interface:PDFontLikeReturns 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.- Specified by:
getHeightin interfacePDFontLike- Parameters:
code- character code- Returns:
- the height of the given character
- Throws:
java.io.IOException- if the height could not be read
-
encode
protected byte[] encode(int unicode) throws java.io.IOExceptionDescription copied from class:PDFontEncodes 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.IOExceptionDescription copied from interface:PDFontLikeReturns the width of a glyph in the embedded font file.- Specified by:
getWidthFromFontin interfacePDFontLike- 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:PDFontLikeReturns true if the font file is embedded in the PDF.- Specified by:
isEmbeddedin interfacePDFontLike- Returns:
- true if the font file is embedded in the PDF
-
getAverageFontWidth
public float getAverageFontWidth()
Description copied from class:PDFontThis will get the average font width for all characters.- Specified by:
getAverageFontWidthin interfacePDFontLike- Overrides:
getAverageFontWidthin 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.IOExceptionDescription copied from class:PDFontReads 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:PDSimpleFontCalled by readEncoding() if the encoding needs to be extracted from the font file.- Specified by:
readEncodingFromFontin classPDSimpleFont- Returns:
- encoding of the font
- 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.- Returns:
- the embedded or substituted Type 1 font or null
-
getFontBoxFont
public org.apache.fontbox.FontBoxFont getFontBoxFont()
Description copied from class:PDSimpleFontReturns the embedded or system font used for rendering. This is never null.- Specified by:
getFontBoxFontin classPDSimpleFont- Returns:
- the embedded or system font used for rendering
-
getName
public java.lang.String getName()
Description copied from interface:PDFontLikeReturns the name of this font, either the PostScript "BaseName" or the Type 3 "Name".- Specified by:
getNamein interfacePDFontLike- Returns:
- the name of the font
-
getBoundingBox
public org.apache.fontbox.util.BoundingBox getBoundingBox() throws java.io.IOExceptionDescription copied from interface:PDFontLikeReturns the font's bounding box.- Specified by:
getBoundingBoxin interfacePDFontLike- Returns:
- the bounding box
- Throws:
java.io.IOException- if the bounding box could not be read
-
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.IOExceptionDescription copied from class:PDSimpleFontReturns 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:
getPathin classPDSimpleFont- Parameters:
name- glyph name- Returns:
- glyph path of the character with the given name
- Throws:
java.io.IOException- if the path could not be read
-
getPath
public java.awt.geom.GeneralPath getPath(int code) throws java.io.IOExceptionDescription copied from interface:PDVectorFontReturns the glyph path for the given character code.- Specified by:
getPathin interfacePDVectorFont- Parameters:
code- character code in a PDF. Not to be confused with unicode.- Returns:
- the glyph path for the given character code
- Throws:
java.io.IOException- if the font could not be read
-
getNormalizedPath
public java.awt.geom.GeneralPath getNormalizedPath(int code) throws java.io.IOExceptionDescription copied from interface:PDVectorFontReturns the normalized glyph path for the given character code in a PDF. The resulting path is normalized to the PostScript 1000 unit square, and fallback glyphs are returned where appropriate, e.g. for missing glyphs.- Specified by:
getNormalizedPathin interfacePDVectorFont- Parameters:
code- character code in a PDF. Not to be confused with unicode.- Returns:
- the normalized glyph path for the given character code
- Throws:
java.io.IOException- if the font could not be read
-
hasGlyph
public boolean hasGlyph(java.lang.String name) throws java.io.IOExceptionDescription copied from class:PDSimpleFontReturns true if the font contains the character with the given name.- Specified by:
hasGlyphin classPDSimpleFont- Parameters:
name- glyph name- Returns:
- true if the font contains the character with the given name
- Throws:
java.io.IOException- if the path could not be read
-
hasGlyph
public boolean hasGlyph(int code) throws java.io.IOExceptionDescription copied from interface:PDVectorFontReturns true if this font contains a glyph for the given character code in a PDF.- Specified by:
hasGlyphin interfacePDVectorFont- Parameters:
code- character code in a PDF. Not to be confused with unicode.- Returns:
- true if this font contains a glyph for the given character code
- Throws:
java.io.IOException- if the font could not be read
-
getFontMatrix
public final Matrix getFontMatrix()
Description copied from interface:PDFontLikeReturns the font matrix, which represents the transformation from glyph space to text space.- Specified by:
getFontMatrixin interfacePDFontLike- Overrides:
getFontMatrixin classPDFont- Returns:
- the font matrix
-
isDamaged
public boolean isDamaged()
Description copied from interface:PDFontLikeReturns true if the embedded font file is damaged.- Specified by:
isDamagedin interfacePDFontLike- Returns:
- true if the embedded font file is damaged
-
-