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.
-
-
Field Summary
Fields Modifier and Type Field Description private static java.util.Map<java.lang.String,java.lang.String>
ALT_NAMES
private java.util.Map<java.lang.Integer,byte[]>
codeToBytesMap
to improve encoding speed.static PDType1Font
COURIER
static PDType1Font
COURIER_BOLD
static PDType1Font
COURIER_BOLD_OBLIQUE
static PDType1Font
COURIER_OBLIQUE
private BoundingBox
fontBBox
private Matrix
fontMatrix
private java.awt.geom.AffineTransform
fontMatrixTransform
private FontBoxFont
genericFont
embedded or system font for rendering.static PDType1Font
HELVETICA
static PDType1Font
HELVETICA_BOLD
static PDType1Font
HELVETICA_BOLD_OBLIQUE
static PDType1Font
HELVETICA_OBLIQUE
private boolean
isDamaged
private boolean
isEmbedded
private static org.apache.commons.logging.Log
LOG
private static int
PFB_START_MARKER
static PDType1Font
SYMBOL
static PDType1Font
TIMES_BOLD
static PDType1Font
TIMES_BOLD_ITALIC
static PDType1Font
TIMES_ITALIC
static PDType1Font
TIMES_ROMAN
private Type1Font
type1font
embedded font.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 Modifier Constructor Description private
PDType1Font(java.lang.String baseFont)
Creates a Type 1 standard 14 font for embedding.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 Static 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.private static int
findBinaryOffsetAfterExec(byte[] bytes, int startOffset)
private BoundingBox
generateBoundingBox()
float
getAverageFontWidth()
This will get the average font width for all characters.java.lang.String
getBaseFont()
Returns the PostScript name of the font.BoundingBox
getBoundingBox()
Returns the font's bounding box.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".private java.lang.String
getNameInFont(java.lang.String name)
Maps a PostScript glyph name to the name in the underlying font, for example when using a TTF font we might map "W" to "uni0057".java.awt.geom.GeneralPath
getPath(java.lang.String name)
Returns the path for the character with the given name.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.private int
repairLength1(byte[] bytes, int length1)
Some Type 1 fonts have an invalid Length1, which causes the binary segment of the font to be truncated, see PDFBOX-2350, PDFBOX-3677.private int
repairLength2(byte[] bytes, int length1, int length2)
Some Type 1 fonts have an invalid Length2, see PDFBOX-3475.-
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
-
LOG
private static final org.apache.commons.logging.Log LOG
-
ALT_NAMES
private static final java.util.Map<java.lang.String,java.lang.String> ALT_NAMES
-
PFB_START_MARKER
private static final int PFB_START_MARKER
- See Also:
- Constant Field Values
-
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
-
type1font
private final Type1Font type1font
embedded font.
-
genericFont
private final FontBoxFont genericFont
embedded or system font for rendering.
-
isEmbedded
private final boolean isEmbedded
-
isDamaged
private final boolean isDamaged
-
fontMatrix
private Matrix fontMatrix
-
fontMatrixTransform
private final java.awt.geom.AffineTransform fontMatrixTransform
-
fontBBox
private BoundingBox fontBBox
-
codeToBytesMap
private final java.util.Map<java.lang.Integer,byte[]> codeToBytesMap
to improve encoding speed.
-
-
Constructor Detail
-
PDType1Font
private PDType1Font(java.lang.String baseFont)
Creates a Type 1 standard 14 font for embedding.- Parameters:
baseFont
- One of the standard 14 PostScript names
-
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
-
repairLength1
private int repairLength1(byte[] bytes, int length1)
Some Type 1 fonts have an invalid Length1, which causes the binary segment of the font to be truncated, see PDFBOX-2350, PDFBOX-3677.- Parameters:
bytes
- Type 1 stream byteslength1
- Length1 from the Type 1 stream- Returns:
- repaired Length1 value
-
findBinaryOffsetAfterExec
private static int findBinaryOffsetAfterExec(byte[] bytes, int startOffset)
-
repairLength2
private int repairLength2(byte[] bytes, int length1, int length2)
Some Type 1 fonts have an invalid Length2, see PDFBOX-3475. A negative /Length2 brings an IllegalArgumentException in Arrays.copyOfRange(), a huge value eats up memory because of padding.- Parameters:
bytes
- Type 1 stream byteslength1
- Length1 from the Type 1 streamlength2
- Length2 from the Type 1 stream- Returns:
- repaired Length2 value
-
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 Type1Font getType1Font()
Returns the embedded or substituted Type 1 font, or null if there is none.
-
getFontBoxFont
public 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 BoundingBox getBoundingBox() throws java.io.IOException
Description copied from interface:PDFontLike
Returns the font's bounding box.- Throws:
java.io.IOException
-
generateBoundingBox
private BoundingBox generateBoundingBox() throws java.io.IOException
- Throws:
java.io.IOException
-
codeToName
public java.lang.String codeToName(int code) throws java.io.IOException
- Throws:
java.io.IOException
-
getNameInFont
private java.lang.String getNameInFont(java.lang.String name) throws java.io.IOException
Maps a PostScript glyph name to the name in the underlying font, for example when using a TTF font we might map "W" to "uni0057".- 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.
-
-