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
A PostScript Type 1 Font.
- Author:
- Ben Litchfield
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final PDType1Font
static final PDType1Font
static final PDType1Font
static final PDType1Font
static final PDType1Font
static final PDType1Font
static final PDType1Font
static final PDType1Font
static final PDType1Font
static final PDType1Font
static final PDType1Font
static final PDType1Font
static final PDType1Font
static final PDType1Font
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
ConstructorsConstructorDescriptionPDType1Font
(COSDictionary fontDictionary) Creates a Type 1 font from a Font dictionary in a PDF.PDType1Font
(PDDocument doc, InputStream pfbIn) Creates a new Type 1 font for embedding.PDType1Font
(PDDocument doc, InputStream pfbIn, Encoding encoding) Creates a new Type 1 font for embedding. -
Method Summary
Modifier and TypeMethodDescriptioncodeToName
(int code) protected byte[]
encode
(int unicode) Encodes the given Unicode code point for use in a PDF content stream.float
This will get the average font width for all characters.final String
Returns the PostScript name of the font.org.apache.fontbox.util.BoundingBox
Returns the font's bounding box.org.apache.fontbox.FontBoxFont
Returns the embedded or system font used for rendering.final Matrix
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.getName()
Returns the name of this font, either the PostScript "BaseName" or the Type 3 "Name".Returns the path for the character with the given name.org.apache.fontbox.type1.Type1Font
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
Returns true if the font contains the character with the given name.boolean
Returns true if the embedded font file is damaged.boolean
Returns true if the font file is embedded in the PDF.int
readCode
(InputStream in) Reads a character code from a content stream string.protected Encoding
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 Details
-
TIMES_ROMAN
-
TIMES_BOLD
-
TIMES_ITALIC
-
TIMES_BOLD_ITALIC
-
HELVETICA
-
HELVETICA_BOLD
-
HELVETICA_OBLIQUE
-
HELVETICA_BOLD_OBLIQUE
-
COURIER
-
COURIER_BOLD
-
COURIER_OBLIQUE
-
COURIER_BOLD_OBLIQUE
-
SYMBOL
-
ZAPF_DINGBATS
-
-
Constructor Details
-
PDType1Font
Creates a new Type 1 font for embedding.- Parameters:
doc
- PDF document to write topfbIn
- PFB file stream- Throws:
IOException
-
PDType1Font
Creates a new Type 1 font for embedding.- Parameters:
doc
- PDF document to write topfbIn
- PFB file streamencoding
-- Throws:
IOException
-
PDType1Font
Creates a Type 1 font from a Font dictionary in a PDF.- Parameters:
fontDictionary
- font dictionary.- Throws:
IOException
- if there was an error initializing the font.IllegalArgumentException
- if /FontFile3 was used.
-
-
Method Details
-
getBaseFont
Returns the PostScript name of the font. -
getHeight
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:
IOException
-
encode
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.
- Specified by:
encode
in classPDFont
- Parameters:
unicode
- Unicode code point.- Returns:
- Array of 1 to 4 PDF content stream bytes.
- Throws:
IOException
- If the text could not be encoded.
-
getWidthFromFont
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:
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
Description copied from class:PDFont
Reads a character code from a content stream string. Codes may be up to 4 bytes long.- Specified by:
readCode
in classPDFont
- Parameters:
in
- string stream- Returns:
- character code
- Throws:
IOException
- if the CMap or stream cannot be read
-
readEncodingFromFont
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:
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
Description copied from interface:PDFontLike
Returns the name of this font, either the PostScript "BaseName" or the Type 3 "Name". -
getBoundingBox
Description copied from interface:PDFontLike
Returns the font's bounding box.- Throws:
IOException
-
codeToName
- Throws:
IOException
-
getPath
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:
IOException
- if the path could not be read
-
hasGlyph
Description copied from class:PDSimpleFont
Returns true if the font contains the character with the given name.- Specified by:
hasGlyph
in classPDSimpleFont
- Throws:
IOException
- if the path could not be read
-
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.
-