org.apache.fop.pdf

Class PDFFontDescriptor

Implemented Interfaces:
PDFWritable
Known Direct Subclasses:
PDFCIDFontDescriptor

public class PDFFontDescriptor
extends PDFDictionary

Class representing a font descriptor (/FontDescriptor object).

Font descriptors are specified on page 222 and onwards of the PDF 1.3 spec.

Field Summary

Fields inherited from class org.apache.fop.pdf.PDFDictionary

entries, order

Fields inherited from class org.apache.fop.pdf.PDFObject

DATE_FORMAT, log

Constructor Summary

PDFFontDescriptor(String basefont, int ascent, int descent, int capHeight, int flags, PDFRectangle fontBBox, int italicAngle, int stemV)
Create the /FontDescriptor object

Method Summary

AbstractPDFStream
getCIDSet()
AbstractPDFStream
getFontFile()
void
setCIDSet(AbstractPDFStream cidSet)
Sets the CIDSet stream for this font descriptor.
void
setFontFile(FontType subtype, AbstractPDFStream fontfile)
Set the optional font file stream
void
setMetrics(int avgWidth, int maxWidth, int missingWidth, int leading, int stemH, int xHeight)
Set the optional metrics.

Methods inherited from class org.apache.fop.pdf.PDFDictionary

get, output, put, put, writeDictionary

Methods inherited from class org.apache.fop.pdf.PDFObject

encode, encodeBinaryToHexString, encodeString, encodeText, formatDateTime, formatDateTime, formatObject, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, getParent, hasObjectNumber, makeReference, output, outputInline, referencePDF, setDocument, setObjectNumber, setParent, toPDF, toPDFString

Constructor Details

PDFFontDescriptor

public PDFFontDescriptor(String basefont,
                         int ascent,
                         int descent,
                         int capHeight,
                         int flags,
                         PDFRectangle fontBBox,
                         int italicAngle,
                         int stemV)
Create the /FontDescriptor object
Parameters:
basefont - the base font name
ascent - the maximum height above the baseline
descent - the maximum depth below the baseline
capHeight - height of the capital letters
flags - various characteristics of the font
fontBBox - the bounding box for the described font
italicAngle - the angle of the vertical dominant strokes
stemV - the width of the dominant vertical stems of glyphs

Method Details

getCIDSet

public AbstractPDFStream getCIDSet()
Returns:
the CIDSet stream or null if not applicable

getFontFile

public AbstractPDFStream getFontFile()
Returns:
the FontFile or null if the font is not embedded

setCIDSet

public void setCIDSet(AbstractPDFStream cidSet)
Sets the CIDSet stream for this font descriptor. (Optional)
Parameters:
cidSet - the CIDSet stream

setFontFile

public void setFontFile(FontType subtype,
                        AbstractPDFStream fontfile)
Set the optional font file stream
Parameters:
subtype - the font type defined in the font stream
fontfile - the stream containing an embedded font

setMetrics

public void setMetrics(int avgWidth,
                       int maxWidth,
                       int missingWidth,
                       int leading,
                       int stemH,
                       int xHeight)
Set the optional metrics.
Parameters:
avgWidth - The average width of characters in this font. The default value is 0.
maxWidth - The maximum width of characters in this font. The default value is 0.
missingWidth - missing width
leading - the desired spacing between lines of text. The default value is 0.
stemH - The vertical width of the dominant horizontal stems of glyphs in the font. The default value is 0.
xHeight - The y-coordinate of the top of flat non-ascending lowercase letters, measured from the baseline. The default value is 0.

Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.