com.adobe.fontengine.font.cff

Class NameKeyedFont

java.lang.Object

com.adobe.fontengine.font.FontData

com.adobe.fontengine.font.cff.CFFFont

com.adobe.fontengine.font.cff.NameKeyedFont

public final class NameKeyedFont
extends CFFFont

Represents a name-keyed font.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NameKeyedFont.GlyphNameFetcher

Constructor Summary

Constructors

Constructor and Description
NameKeyedFont(String fontName, Dict topDict, CharStrings charStrings, Dict privateDict) Create a somewhat lobotimized name keyed font for subsetting a type1 font to CFF
NameKeyedFont(String fontName, Dict topDict, CharStrings charStrings, Dict privateDict, CharStrings lSubrs, CharStrings gSubrs) Create an extended lobotimized name keyed font for subsetting a TrueType font to CFF with subroutines
NameKeyedFont(com.adobe.fontengine.font.cff.StringIndex stringIndex, CharStrings globalSubrs, String name, Dict topDict, com.adobe.fontengine.font.cff.CFFByteArray data, byte[] digest) Construct a NameKeyedFont.

Method Summary

Modifier and Type	Method and Description
int	charCode2gid(int charCode)
Subset	createSubset() Create a subset for this font.
LineMetrics	getCoolTypeLineMetrics() Emulates the CoolType API CTFontDict:GetHorizontalMetrics CoolType API.
Rect	getCoolTypeRawFontBBox()
Permission	getEmbeddingPermission(boolean wasEmbedded)
int	getFirstChar()
Rect	getFontBBox()
Matrix	getFontMatrix()
int	getGlyphCid(int glyphID) Get the CID associated with glyph glyphID.
int	getGlyphForChar(int usv) Return the glyph to use to display a character.
String	getGlyphName(int gid) Return the name of glyph gid.
void	getGlyphOutline(int gid, OutlineConsumer consumer) Get the outline of glyph gid.
double	getHorizontalAdvance(int gid) Get the horizontal advance of a glyph.
int	getLastChar()
int	getNumGlyphs() Return the number of glyphs in this font.
void	getOutline(int gid, Type2OutlineParser parser, OutlineConsumer consumer) Get the outline of glyph gid, using a specified parser.
PDFFontDescription	getPDFFontDescription(Font font)
ROS	getROS() Get the ROS associated with this font.
double	getStemVForGlyph(int gid)
XDCFontDescription	getXDCFontDescription(Font font)
int	glyphName2gid(String glyphName)
void	stream(OutputStream out, Integer fsType)
void	stream(OutputStream out, Integer fsType, NameKeyedFont.GlyphNameFetcher fetcher)
void	subsetAndStream(Subset subset, OutputStream out, boolean preserveROS, Integer fsType) Subset and stream this font for PDF use.
void	subsetAndStream(Subset subset, OutputStream out, boolean preserveROS, Integer fsType, boolean enableSubrizer) Added new subsetAndStream method as part of changes to force DF4 output to be Identity-CID always.
void	subsetAndStream(Subset subset, OutputStream out, Integer fsType, boolean rebuildCharstrings, NameKeyedFont.GlyphNameFetcher fetcher) Create a subset name-keyed cff based on the given parameters
void	subsetAndStream(Subset subset, OutputStream out, Integer fsType, boolean rebuildCharstrings, NameKeyedFont.GlyphNameFetcher fetcher, boolean enableSubrizer)

Methods inherited from class com.adobe.fontengine.font.cff.CFFFont

getCacheSupportInfo, getCoolTypeIcfBox, getCoolTypeIdeoEmBox, getCoolTypeProportionalRomanFromFontProperties, getCoolTypeScript, getCoolTypeUnderlineMetrics, getCoolTypeUnderlineMetrics, getCSSFamilyNames, getCSSStretchValue, getCSSWeight, getFXGFontDescription, getGlyphBBox, getName, getPlatformFontDescription, getPostscriptFontDescription, getPreferredCSSFamilyName, getScaler, getSelectionDescription, getSWFFont4Description, getSWFFontDescription, getUnitsPerEmX, getUnitsPerEmY, isCSSStyleItalic, isCSSStyleNormal, isCSSStyleOblique, isCSSVariantNormal, isCSSVariantSmallCaps, isFixedPitch, subsetAndStream

Methods inherited from class com.adobe.fontengine.font.FontData

getContainerFingerprint, getCoolTypeCapHeight, getCoolTypeFontBBox, getCoolTypeGlyphBBox, getCoolTypeGlyphForChar, getCoolTypeUnitsPerEm, getCoolTypeXHeight, getCSS20FontDescription, getLineMetrics, getPointSizeRange, getPreferredCSS20FontDescription, getScaler, hasCoolTypeProportionalRoman, isSymbolic

Methods inherited from class java.lang.Object

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

Constructor Detail

NameKeyedFont

public NameKeyedFont(com.adobe.fontengine.font.cff.StringIndex stringIndex,
                     CharStrings globalSubrs,
                     String name,
                     Dict topDict,
                     com.adobe.fontengine.font.cff.CFFByteArray data,
                     byte[] digest)
              throws IOException,
                     InvalidFontException,
                     UnsupportedFontException

Construct a NameKeyedFont.

Parameters:

stringIndex - the StringIndex for this font

globalSubrs - the global subroutines for this font

name - the name of this font

topDict - the top Dict of this font.

data - the underlying bytes from which the structures pointed by the top dict will be parsed

digest - the digest for the container of this font

Throws:

IOException

InvalidFontException

UnsupportedFontException

NameKeyedFont

public NameKeyedFont(String fontName,
                     Dict topDict,
                     CharStrings charStrings,
                     Dict privateDict)
              throws InvalidFontException,
                     UnsupportedFontException

Create a somewhat lobotimized name keyed font for subsetting a type1 font to CFF

Throws:

InvalidFontException

UnsupportedFontException

NameKeyedFont

public NameKeyedFont(String fontName,
                     Dict topDict,
                     CharStrings charStrings,
                     Dict privateDict,
                     CharStrings lSubrs,
                     CharStrings gSubrs)
              throws InvalidFontException,
                     UnsupportedFontException

Create an extended lobotimized name keyed font for subsetting a TrueType font to CFF with subroutines

Throws:

InvalidFontException

UnsupportedFontException

Method Detail

getNumGlyphs

public int getNumGlyphs()

Description copied from class: FontData

Return the number of glyphs in this font.

Specified by:

getNumGlyphs in class FontData

glyphName2gid

public int glyphName2gid(String glyphName)
                  throws InvalidFontException,
                         UnsupportedFontException

Throws:

InvalidFontException

UnsupportedFontException

charCode2gid

public int charCode2gid(int charCode)
                 throws InvalidFontException,
                        UnsupportedFontException

Throws:

InvalidFontException

UnsupportedFontException

getGlyphName

public String getGlyphName(int gid)
                    throws InvalidFontException,
                           UnsupportedFontException

Return the name of glyph gid.

Specified by:

getGlyphName in class CFFFont

Throws:

InvalidFontException

UnsupportedFontException

getROS

public ROS getROS()

Description copied from class: CFFFont

Get the ROS associated with this font. If the font does not have an ROS, return null.

Specified by:

getROS in class CFFFont

getGlyphCid

public int getGlyphCid(int glyphID)

Description copied from class: CFFFont

Get the CID associated with glyph glyphID. Returns -1 if getROS() returns null.

Specified by:

getGlyphCid in class CFFFont

Returns:

the CID in the ROS associated with the font.

getGlyphOutline

public void getGlyphOutline(int gid,
                            OutlineConsumer consumer)
                     throws InvalidFontException,
                            UnsupportedFontException

Get the outline of glyph gid.

Specified by:

getGlyphOutline in class CFFFont

Parameters:

gid - the glyph id of the glyph

consumer - the OutlineConsumer to receive the outline

Throws:

InvalidFontException

UnsupportedFontException

getOutline

public void getOutline(int gid,
                       Type2OutlineParser parser,
                       OutlineConsumer consumer)
                throws InvalidFontException,
                       UnsupportedFontException

Get the outline of glyph gid, using a specified parser.

Specified by:

getOutline in class CFFFont

Parameters:

gid - the glyph id of the glyph

parser - the Type2OutlineParser parser to use

consumer - the OutlineConsumer to receive the outline

Throws:

InvalidFontException

UnsupportedFontException

getStemVForGlyph

public double getStemVForGlyph(int gid)

Specified by:

getStemVForGlyph in class CFFFont

getHorizontalAdvance

public double getHorizontalAdvance(int gid)
                            throws InvalidFontException,
                                   UnsupportedFontException

Description copied from class: FontData

Get the horizontal advance of a glyph. The returned value is in metric space.

Specified by:

getHorizontalAdvance in class CFFFont

Throws:

InvalidFontException

UnsupportedFontException

getFontMatrix

public Matrix getFontMatrix()

Specified by:

getFontMatrix in class CFFFont

getFontBBox

public Rect getFontBBox()
                 throws InvalidFontException,
                        UnsupportedFontException

Specified by:

getFontBBox in class FontData

Throws:

InvalidFontException

UnsupportedFontException

getCoolTypeRawFontBBox

public Rect getCoolTypeRawFontBBox()
                            throws InvalidFontException,
                                   UnsupportedFontException

Throws:

InvalidFontException

UnsupportedFontException

getCoolTypeLineMetrics

public LineMetrics getCoolTypeLineMetrics()
                                   throws UnsupportedFontException,
                                          InvalidFontException

Emulates the CoolType API CTFontDict:GetHorizontalMetrics CoolType API.

The metrics are expressed in the design space of the font, i.e. they need to be converted through the metrics matrix.

This methods never returns null.

See also the FontData.getLineMetrics() method.

Specified by:

getCoolTypeLineMetrics in class FontData

Throws:

UnsupportedFontException

InvalidFontException

getFirstChar

public int getFirstChar()
                 throws InvalidFontException,
                        UnsupportedFontException

Throws:

InvalidFontException

UnsupportedFontException

getLastChar

public int getLastChar()
                throws InvalidFontException,
                       UnsupportedFontException

Throws:

InvalidFontException

UnsupportedFontException

getGlyphForChar

public int getGlyphForChar(int usv)
                    throws InvalidFontException,
                           UnsupportedFontException

Return the glyph to use to display a character. Depending on the layout technology of the font, the returned gid may be further processed.

Specified by:

getGlyphForChar in class CFFFont

Parameters:

usv - the Unicode scalar value of the character; (by definition, surrogate code points are not Unicode scalar values).

Returns:

the gid of the glyph to use

Throws:

InvalidFontException

UnsupportedFontException

getEmbeddingPermission

public Permission getEmbeddingPermission(boolean wasEmbedded)

Specified by:

getEmbeddingPermission in class FontData

subsetAndStream

public void subsetAndStream(Subset subset,
                            OutputStream out,
                            boolean preserveROS,
                            Integer fsType)
                     throws InvalidFontException,
                            UnsupportedFontException,
                            IOException

Subset and stream this font for PDF use. The stream is a CID-keyed CFF stream.

Specified by:

subsetAndStream in class CFFFont

Parameters:

out - the OutputStream to which the bytes are streamed

fsType - if non-null an integer as described in technote 5147 http://partners.adobe.com/public/developer/en/acrobat/sdk/FontPolicies.pdf "Font Embedding Guidelines for Adobe Third-party Developers".

Throws:

InvalidFontException

UnsupportedFontException

IOException

subsetAndStream

public void subsetAndStream(Subset subset,
                            OutputStream out,
                            boolean preserveROS,
                            Integer fsType,
                            boolean enableSubrizer)
                     throws InvalidFontException,
                            UnsupportedFontException,
                            IOException

Added new subsetAndStream method as part of changes to force DF4 output to be Identity-CID always.

Throws:

InvalidFontException

UnsupportedFontException

IOException

stream

public void stream(OutputStream out,
                   Integer fsType)
            throws InvalidFontException,
                   UnsupportedFontException,
                   IOException

Specified by:

stream in class CFFFont

Throws:

InvalidFontException

UnsupportedFontException

IOException

stream

public void stream(OutputStream out,
                   Integer fsType,
                   NameKeyedFont.GlyphNameFetcher fetcher)
            throws InvalidFontException,
                   UnsupportedFontException,
                   IOException

Throws:

InvalidFontException

UnsupportedFontException

IOException

subsetAndStream

public void subsetAndStream(Subset subset,
                            OutputStream out,
                            Integer fsType,
                            boolean rebuildCharstrings,
                            NameKeyedFont.GlyphNameFetcher fetcher)
                     throws InvalidFontException,
                            UnsupportedFontException,
                            IOException

Create a subset name-keyed cff based on the given parameters

Parameters:

subset - The set of glyphs to include in the subset

out - The OutputStream to which we will write the new font

fsType - The fsType to include in the new font

rebuildCharstrings - Tells if the charstrings in the current font already take into account the Subset. If they do, then we don't need to recreate the charstrings. Otherwise, we do.

fetcher - Provides a way to get from gid to glyphName for cases where there is no charset (for example, because this NameKeyedFont is a temporary font converted from Type1). Can be null if this's charset and string index are valid.

Throws:

InvalidFontException

UnsupportedFontException

IOException

subsetAndStream

public void subsetAndStream(Subset subset,
                            OutputStream out,
                            Integer fsType,
                            boolean rebuildCharstrings,
                            NameKeyedFont.GlyphNameFetcher fetcher,
                            boolean enableSubrizer)
                     throws InvalidFontException,
                            UnsupportedFontException,
                            IOException

Throws:

InvalidFontException

UnsupportedFontException

IOException

getPDFFontDescription

public PDFFontDescription getPDFFontDescription(Font font)
                                         throws UnsupportedFontException,
                                                InvalidFontException

Specified by:

getPDFFontDescription in class FontData

Throws:

UnsupportedFontException

InvalidFontException

getXDCFontDescription

public XDCFontDescription getXDCFontDescription(Font font)
                                         throws UnsupportedFontException,
                                                InvalidFontException

Specified by:

getXDCFontDescription in class FontData

Throws:

UnsupportedFontException

InvalidFontException

createSubset

public Subset createSubset()
                    throws InvalidFontException,
                           UnsupportedFontException

Create a subset for this font.

Specified by:

createSubset in class FontData

Throws:

InvalidFontException

UnsupportedFontException