org.axsl.font.output

Interface FontPdf

All Superinterfaces:

FontOutput

public interface FontPdf
extends FontOutput

Provides services to applications using and embedding fonts in PDF output.

Method Summary

Modifier and Type	Method and Description
int	getFirstIndex() Convenience method equivalent to getFontUse().getEncoding().getFirstIndex().
int	getFlags() Returns the Flags value for this font, used in a PDF Font Descriptor, as defined in the PDF Reference, Second Edition, Section 5.7, and, more specifically, in Section 5.7.1.
int[]	getFontBoundingBox() Returns the FontBBox value for this font, used in a PDF Font Descriptor, as defined in the PDF Reference, Second Edition, Section 5.7.
java.lang.String	getItalicAngleFormatted() Returns a compactly formatted version of the ItalicAngle value for this font, expressed in degrees counterclockwise from vertical.
int	getLastIndex() Convenience method equivalent to getFontUse().getEncoding().getFirstIndex().
java.lang.String	getPdfFontFileStreamAdditional() Returns the "Additional entries in a FontFile stream dictionary" that is documented in the PDF Reference, Second Edition, Section 5.8, especially Table 5.22.
java.lang.String	getToUnicodeBf() Return the BF Entries needed to write this FontUse's ToUnicode CMap.
short[]	getWidths() Returns an array containing the widths of all glyphs in the font that can be encoded by the FontUse instance.
java.lang.String	textToPdf(java.lang.CharSequence theString, FontOptions fontOptions, Orthography orthography) Converts a String to the content that should be written into a PDF to show that String.

Methods inherited from interface org.axsl.font.output.FontOutput

getContents, getFontUse

Method Detail

getWidths

short[] getWidths()

Returns an array containing the widths of all glyphs in the font that can be encoded by the FontUse instance.

Returns:

An array whose elements are the widths of the glyphs that can be encoded by the FontUse instance. Element 0 contains the width for the first encodable glyph index (see Encoding.getFirstIndex()). The last element contains the width for the last encodable glyph index (see Encoding.getLastIndex()). Each element contains the width for the encodable glyph index that is equal to the element index + Encoding.getFirstIndex(). For fonts that have been subsetted, only the characters that are included in the subset are returned.

getFirstIndex

int getFirstIndex()

Convenience method equivalent to getFontUse().getEncoding().getFirstIndex(). This is the glyph index for the first item in the array returned by getWidths(). This is needed when embedding some types of fonts in a PDF file.

Returns:

The integer value of the first character code in this font.

getLastIndex

int getLastIndex()

Convenience method equivalent to getFontUse().getEncoding().getFirstIndex(). This is the glyph index for the last item in the array returned by getWidths(). This is needed when embedding some types of fonts in a PDF file.

Returns:

The integer value of the last character code in this font.

getPdfFontFileStreamAdditional

java.lang.String getPdfFontFileStreamAdditional()

Returns the "Additional entries in a FontFile stream dictionary" that is documented in the PDF Reference, Second Edition, Section 5.8, especially Table 5.22.

Returns:

The String containing the "Additional entries", or null if Font.isEmbeddable() is false.

getFontBoundingBox

int[] getFontBoundingBox()

Returns the FontBBox value for this font, used in a PDF Font Descriptor, as defined in the PDF Reference, Second Edition, Section 5.7.

Returns:

The FontBBox value, in 1/1000ths of a text space unit.

getFlags

int getFlags()

Returns the Flags value for this font, used in a PDF Font Descriptor, as defined in the PDF Reference, Second Edition, Section 5.7, and, more specifically, in Section 5.7.1.

Returns:

The Flags value.

getItalicAngleFormatted

java.lang.String getItalicAngleFormatted()

Returns a compactly formatted version of the ItalicAngle value for this font, expressed in degrees counterclockwise from vertical. Leading and trailing zeros are stripped. The decimal point is stripped for integral values. A leading negative sign is added for negative values, the lack of one indicates a positive value.

Returns:

The italic angle, formatted.

getToUnicodeBf

java.lang.String getToUnicodeBf()

Return the BF Entries needed to write this FontUse's ToUnicode CMap.

Returns:

A String containing the BFEntries for this FontUse's ToUnicode CMap. For fonts that have been subsetted, the entries only apply to the subset.

textToPdf

java.lang.String textToPdf(java.lang.CharSequence theString,
                           FontOptions fontOptions,
                           Orthography orthography)

Converts a String to the content that should be written into a PDF to show that String.

Parameters:

theString - The input String, that is, the text that needs to be shown in the PDF.

fontOptions - The font options, such as ligatures and small-caps that should be used when computing the glyphs for this word.

orthography - The orthography that should be used when applying font features like subsitutions.

Returns:

The String that should actually be written into the PDF to show the input text.