Package org.apache.fontbox.ttf

Class GlyphSubstitutionTable

java.lang.Object

org.apache.fontbox.ttf.TTFTable

org.apache.fontbox.ttf.GlyphSubstitutionTable

public class GlyphSubstitutionTable
extends TTFTable

A glyph substitution 'GSUB' table in a TrueType or OpenType font.

Author:

Aaron Madlon-Kay

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	TAG

Fields inherited from class org.apache.fontbox.ttf.TTFTable

font, initialized

Method Summary

Modifier and Type	Method	Description
int	getSubstitution(int gid, java.lang.String[] scriptTags, java.util.List<java.lang.String> enabledFeatures)	Apply glyph substitutions to the supplied gid.
int	getUnsubstitution(int sgid)	For a substitute-gid (obtained from getSubstitution(int, String[], List)), retrieve the original gid.

Methods inherited from class java.lang.Object

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

Methods inherited from class org.apache.fontbox.ttf.TTFTable

getCheckSum, getInitialized, getLength, getOffset, getTag

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

Method Detail

getSubstitution

public int getSubstitution(int gid,
                           java.lang.String[] scriptTags,
                           java.util.List<java.lang.String> enabledFeatures)

Apply glyph substitutions to the supplied gid. The applicable substitutions are determined by the scriptTags which indicate the language of the gid, and by the enabledFeatures which acts as a whitelist. To ensure that a single gid isn't mapped to multiple substitutions, subsequent invocations with the same gid will return the same result as the first, regardless of script or enabled features.

Parameters:

gid - GID

scriptTags - Script tags applicable to the gid (see OpenTypeScript)

enabledFeatures - Whitelist of features to apply

getUnsubstitution

public int getUnsubstitution(int sgid)

For a substitute-gid (obtained from getSubstitution(int, String[], List)), retrieve the original gid. Only gids previously substituted by this instance can be un-substituted. If you are trying to unsubstitute before you substitute, something is wrong.

Parameters:

sgid - Substitute GID