OpenTypeFont (Big Faceless Report Generator 1.1.40)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.faceless.pdf2
Class OpenTypeFont

java.lang.Object
  org.faceless.pdf2.PDFFont
      org.faceless.pdf2.OpenTypeFont

All Implemented Interfaces:: Cloneable

public final class OpenTypeFont
extends PDFFont
extends PDFFont

A subclass of PDFFont that represents an OpenType font. OpenType fonts are a superset of TrueType fonts, but also include fonts where the glyphs are defined using Adobes "Compact Font" format (which are supported since version 2.3 of the library).

OpenType fonts can be stored by reference only (the font is not embedded into the file), or can be embedded using either one or two bytes per glyph. One byte is only really suitable when the font is using a subset of the ASCII character set - eg. western european characters only. If the font is going to be used to display non-roman characters, two bytes should be used.

Since:: 2.0 (prior to 2.0 this class was called TrueTypeFont)

Constructor Summary
`OpenTypeFont(InputStream in, int bytesperglyph)` Create a new OpenTypeFont from the specified InputStream.

Method Summary
`boolean`	`equals(Object o)`
`float`	`getAscender()` Get the Ascender for the font (the maximum height above the baseline the font extends), as a proportion of the point size.
`float`	`getDefaultLeading()` Get the default leading for this font - the preferred distance between two successive baselines of text.
`float`	`getDescender()` Get the Descender for the font (the maximum height below the baseline the font extends), as a proportion of the point size.
`String`	`getEmbeddingRestrictions()` Returns `null` if the font can be embedded without any restrictions, or a non-null String if the font has embedding restrictions.
`float`	`getStrikeoutPosition()` Get the strikeout position, as a proportion of the font size.
`float`	`getStrikeoutThickness()` Get the strikeout thickness, as a proportion of the font size.
`float`	`getSubscriptPosition()` Get the recommended position of a sub-script version of this font, as a proportion of the sub-scripted font size.
`float`	`getSubscriptSize()` Get the recommended size of a super/sub script version of this font, as a proportion of the normal font size.
`float`	`getSuperscriptPosition()` Get the recommended position of a super-script version of this font, as a proportion of the sub-scripted font size.
`float`	`getUnderlinePosition()` Get the underline position, as a proportion of the font size.
`float`	`getUnderlineThickness()` Get the underline thickness, as a proportion of the font size.
`boolean`	`isMonospace()` Return true if every character has the same width (like Courier), false if every character is potentially a different width (like Times-Roman)
`void`	`setEmbed(boolean embed)` Whether to embed the font in the PDF.
`void`	`setSubset(boolean subset)` Whether to "subset" the font by removing unused glyph definitions from the font when it's embedded in the file.
`String`	`toString()`

Methods inherited from class org.faceless.pdf2.PDFFont
`getBaseName, getBottom, getCharWidth, getCharWidth, getKerning, getKerning, getLeft, getRight, getTop, isDefined, isDefined, isHorizontal, ligaturize, ligaturize, requote, requote`

Methods inherited from class java.lang.Object
`getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

OpenTypeFont

public OpenTypeFont(InputStream in,
                    int bytesperglyph)
             throws IOException

Create a new OpenTypeFont from the specified InputStream. The InputStream is closed after use.

Parameters:: in - the InputStream to read the font from.; bytesperglyph - the number of bytes to use for each glyph. Must be 1 or 2. Thanks to compression there is surprisingly little difference in terms of size in the resulting file, so if in doubt, use 2.
Throws:: IOException
Since:: 2.0

Method Detail

setSubset

public void setSubset(boolean subset)

Whether to "subset" the font by removing unused glyph definitions from the font when it's embedded in the file. This is generally a good thing, unless the font will be used to display text that's not known at PDF creation time (i.e. it's used in a form).

Parameters:: subset - whether to subset the font (the default is true)

setEmbed

public void setEmbed(boolean embed)

Whether to embed the font in the PDF. Embedding the Font will result in larger files, but the PDF will be readable anywhere - choosing not to embed the font will mean a matching font is required on the system viewing the PDF. If that font is missing, the document cannot guarantee to be displayed correctly. 2-byte fonts are always embedded.

Parameters:: embed - whether to embed the font (the default is true)

getEmbeddingRestrictions

public String getEmbeddingRestrictions()

Returns null if the font can be embedded without any restrictions, or a non-null String if the font has embedding restrictions. Note the library will not prevent you from using a font with embedding restrictions unless you have set the OutputProfile.Feature.FontEmbeddingRestrictions feature - it's your responsibility to ensure you have the right to embed the font. The content of the String is undefined but is intended to detail the restriction type.

Since:: 2.7.8