org.axsl.fontR.output
Interface FontPDF

All Superinterfaces:

FontOutput

public interface FontPDF

extends FontOutput

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

Method Summary

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[]	getFontBBox() 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.

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

getContents, getFontUse

Method Detail

getWidths

public 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

public 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

public 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

public 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.

getFontBBox

public int[] getFontBBox()

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

public 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

public 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

public 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.