Package org.apache.fontbox.ttf

Class NamingTable

java.lang.Object

org.apache.fontbox.ttf.TTFTable

org.apache.fontbox.ttf.NamingTable

public class NamingTable
extends TTFTable

This 'name'-table is a required table in a TrueType font.

Field Summary

Fields

Modifier and Type	Field	Description
private String	fontFamily
private String	fontSubFamily
private Map<Integer,Map<Integer,Map<Integer,Map<Integer,String>>>>	lookupTable
private List<NameRecord>	nameRecords
private String	psName
static final String	TAG	A tag that identifies this table type.

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

initialized

Constructor Summary

Constructors

Constructor	Description
NamingTable()

Method Summary

Modifier and Type	Method	Description
private void	fillLookupTable()
private Charset	getCharset(NameRecord nr)
private String	getEnglishName(int nameId)	Helper to get English names by best effort.
String	getFontFamily()	Returns the font family name, in English.
String	getFontSubFamily()	Returns the font sub family name, in English.
String	getName(int nameId, int platformId, int encodingId, int languageId)	Returns a name from the table, or null it it does not exist.
List<NameRecord>	getNameRecords()	This will get the name records for this naming table.
String	getPostScriptName()	Returns the PostScript name.
private static boolean	isUsefulForOnlyHeaders(NameRecord nr)
(package private) void	read(TrueTypeFont ttf, TTFDataStream data)	This will read the required data from the stream.
private void	read(TrueTypeFont ttf, TTFDataStream data, boolean onlyHeaders)
(package private) void	readHeaders(TrueTypeFont ttf, TTFDataStream data, FontHeaders outHeaders)	This will read required headers from the stream into outHeaders.
private void	readInterestingStrings()

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

getCheckSum, getInitialized, getLength, getOffset, getTag, setCheckSum, setLength, setOffset, setTag

Methods inherited from class java.lang.Object

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

Field Details

TAG

public static final String TAG

A tag that identifies this table type.

See Also:

• Constant Field Values

nameRecords

private List<NameRecord> nameRecords

lookupTable

private Map<Integer,Map<Integer,Map<Integer,Map<Integer,String>>>> lookupTable

fontFamily

private String fontFamily

fontSubFamily

private String fontSubFamily

psName

private String psName

Constructor Details

NamingTable

NamingTable()

Method Details

read

void read(TrueTypeFont ttf,
 TTFDataStream data)
   throws IOException

This will read the required data from the stream.

Overrides:

read in class TTFTable

Parameters:

ttf - The font that is being read.

data - The stream to read the data from.

Throws:

IOException - If there is an error reading the data.

readHeaders

void readHeaders(TrueTypeFont ttf,
 TTFDataStream data,
 FontHeaders outHeaders)
          throws IOException

This will read required headers from the stream into outHeaders.

Overrides:

readHeaders in class TTFTable

Parameters:

ttf - The font that is being read.

data - The stream to read the data from.

outHeaders - The class to write the data to.

Throws:

IOException - If there is an error reading the data.

read

private void read(TrueTypeFont ttf,
 TTFDataStream data,
 boolean onlyHeaders)
           throws IOException

Throws:

IOException

getCharset

private Charset getCharset(NameRecord nr)

fillLookupTable

private void fillLookupTable()

readInterestingStrings

private void readInterestingStrings()

isUsefulForOnlyHeaders

private static boolean isUsefulForOnlyHeaders(NameRecord nr)

getEnglishName

private String getEnglishName(int nameId)

Helper to get English names by best effort.

getName

public String getName(int nameId,
 int platformId,
 int encodingId,
 int languageId)

Returns a name from the table, or null it it does not exist.

Parameters:

nameId - Name ID from NameRecord constants.

platformId - Platform ID from NameRecord constants.

encodingId - Platform Encoding ID from NameRecord constants.

languageId - Language ID from NameRecord constants.

Returns:

name, or null

getNameRecords

public List<NameRecord> getNameRecords()

This will get the name records for this naming table.

Returns:

A list of NameRecord objects.

getFontFamily

public String getFontFamily()

Returns the font family name, in English.

Returns:

the font family name, in English

getFontSubFamily

public String getFontSubFamily()

Returns the font sub family name, in English.

Returns:

the font sub family name, in English

getPostScriptName

public String getPostScriptName()

Returns the PostScript name.

Returns:

the PostScript name