Package org.apache.pdfbox.pdmodel.font

Class TrueTypeEmbedder

java.lang.Object

org.apache.pdfbox.pdmodel.font.TrueTypeEmbedder

All Implemented Interfaces:

Subsetter

Direct Known Subclasses:

PDCIDFontType2Embedder, PDTrueTypeFontEmbedder

abstract class TrueTypeEmbedder
extends Object
implements Subsetter

Common functionality for embedding TrueType fonts.

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	BASE25
protected final CmapSubtable	cmap	Deprecated.
protected final CmapLookup	cmapLookup
private final PDDocument	document
private final boolean	embedSubset
protected PDFontDescriptor	fontDescriptor
private static final int	ITALIC
private static final int	OBLIQUE
private final Set<Integer>	subsetCodePoints
protected TrueTypeFont	ttf

Constructor Summary

Constructors

Constructor	Description
TrueTypeEmbedder(PDDocument document, COSDictionary dict, TrueTypeFont ttf, boolean embedSubset)	Creates a new TrueType font for embedding.

Method Summary

Modifier and Type	Method	Description
void	addToSubset(int codePoint)	Adds the given Unicode code point to this subset.
void	buildFontFile2(InputStream ttfStream)
protected abstract void	buildSubset(InputStream ttfSubset, String tag, Map<Integer,Integer> gidToCid)	Rebuild a font subset.
private PDFontDescriptor	createFontDescriptor(TrueTypeFont ttf)	Creates a new font descriptor dictionary for the given TTF.
PDFontDescriptor	getFontDescriptor()	Returns the font descriptor.
String	getTag(Map<Integer,Integer> gidToCid)	Returns an uppercase 6-character unique tag for the given subset.
TrueTypeFont	getTrueTypeFont()	Deprecated.
(package private) boolean	isEmbeddingPermitted(TrueTypeFont ttf)	Returns true if the fsType in the OS/2 table permits embedding.
private boolean	isSubsettingPermitted(TrueTypeFont ttf)	Returns true if the fsType in the OS/2 table permits subsetting.
boolean	needsSubset()	Returns true if the font needs to be subset.
void	subset()	Subset this font now.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ITALIC

private static final int ITALIC

See Also:

• Constant Field Values

OBLIQUE

private static final int OBLIQUE

See Also:

• Constant Field Values

BASE25

private static final String BASE25

See Also:

• Constant Field Values

document

private final PDDocument document

ttf

protected TrueTypeFont ttf

fontDescriptor

protected PDFontDescriptor fontDescriptor

cmap

@Deprecated
protected final CmapSubtable cmap

Deprecated.

For API backwards compatibility.

cmapLookup

protected final CmapLookup cmapLookup

subsetCodePoints

private final Set<Integer> subsetCodePoints

embedSubset

private final boolean embedSubset

Constructor Details

TrueTypeEmbedder

TrueTypeEmbedder(PDDocument document,
 COSDictionary dict,
 TrueTypeFont ttf,
 boolean embedSubset)
          throws IOException

Creates a new TrueType font for embedding.

Throws:

IOException

Method Details

buildFontFile2

public void buildFontFile2(InputStream ttfStream)
                    throws IOException

Throws:

IOException

isEmbeddingPermitted

boolean isEmbeddingPermitted(TrueTypeFont ttf)
                      throws IOException

Returns true if the fsType in the OS/2 table permits embedding.

Throws:

IOException

isSubsettingPermitted

private boolean isSubsettingPermitted(TrueTypeFont ttf)
                               throws IOException

Returns true if the fsType in the OS/2 table permits subsetting.

Throws:

IOException

createFontDescriptor

private PDFontDescriptor createFontDescriptor(TrueTypeFont ttf)
                                       throws IOException

Creates a new font descriptor dictionary for the given TTF.

Throws:

IOException

getTrueTypeFont

@Deprecated
public TrueTypeFont getTrueTypeFont()

Deprecated.

Returns the FontBox font.

getFontDescriptor

public PDFontDescriptor getFontDescriptor()

Returns the font descriptor.

addToSubset

public void addToSubset(int codePoint)

Description copied from interface: Subsetter

Adds the given Unicode code point to this subset.

Specified by:

addToSubset in interface Subsetter

Parameters:

codePoint - Unicode code point

subset

public void subset()
            throws IOException

Description copied from interface: Subsetter

Subset this font now.

Specified by:

subset in interface Subsetter

Throws:

IOException - if the font could not be read

needsSubset

public boolean needsSubset()

Returns true if the font needs to be subset.

buildSubset

protected abstract void buildSubset(InputStream ttfSubset,
 String tag,
 Map<Integer,Integer> gidToCid)
                             throws IOException

Rebuild a font subset.

Throws:

IOException

getTag

public String getTag(Map<Integer,Integer> gidToCid)

Returns an uppercase 6-character unique tag for the given subset.