Top Description Fields Constructors Methods
org.apache.fontbox.ttf

public Class CmapTable

extends TTFTable
Class Inheritance
Imports
java.io.IOException
This 'cmap'-table is a required table in a TrueType font.
Author
Ben Litchfield

Field Summary

Modifier and TypeField and Description
private CmapSubtable[]
cmaps

public static final int
ENCODING_MAC_ROMAN

public static final int
ENCODING_UNICODE_1_0

public static final int
ENCODING_UNICODE_1_1

public static final int
ENCODING_UNICODE_2_0_BMP

public static final int
ENCODING_UNICODE_2_0_FULL

public static final int
ENCODING_WIN_BIG5

public static final int
ENCODING_WIN_JOHAB

public static final int
ENCODING_WIN_PRC

public static final int
ENCODING_WIN_SHIFT_JIS

public static final int
ENCODING_WIN_SYMBOL

public static final int
ENCODING_WIN_UNICODE_BMP

public static final int
ENCODING_WIN_UNICODE_FULL

public static final int
ENCODING_WIN_WANSUNG

public static final int
PLATFORM_MACINTOSH

public static final int
PLATFORM_UNICODE

public static final int
PLATFORM_WINDOWS

public static final String
TAG

A tag used to identify this table.

Inherited from org.apache.fontbox.ttf.TTFTable:
initialized

Constructor Summary

AccessConstructor and Description
pack-priv
CmapTable()

Method Summary

Modifier and TypeMethod and Description
public CmapSubtable[]

Returns:

Returns the cmaps.
getCmaps()

public CmapSubtable

Returns:

the subtable, if any, or null
getSubtable(int
the ID of the given platform
platformId, int
the ID of the given encoding
platformEncodingId)

Returns the subtable, if any, for the given platform and encoding.

pack-priv void
read(TrueTypeFont
The font that is being read.
ttf, TTFDataStream
The stream to read the data from.
data)

Overrides org.apache.fontbox.ttf.TTFTable.read.

This will read the required data from the stream.

public void
setCmaps(CmapSubtable[]
The cmaps to set.
cmapsValue)

Inherited from org.apache.fontbox.ttf.TTFTable:
getCheckSumgetInitializedgetLengthgetOffsetgetTagreadHeaderssetCheckSumsetLengthsetOffsetsetTag

Field Detail

cmapsback to summary
private CmapSubtable[] cmaps
ENCODING_MAC_ROMANback to summary
public static final int ENCODING_MAC_ROMAN
ENCODING_UNICODE_1_0back to summary
public static final int ENCODING_UNICODE_1_0
ENCODING_UNICODE_1_1back to summary
public static final int ENCODING_UNICODE_1_1
ENCODING_UNICODE_2_0_BMPback to summary
public static final int ENCODING_UNICODE_2_0_BMP
ENCODING_UNICODE_2_0_FULLback to summary
public static final int ENCODING_UNICODE_2_0_FULL
ENCODING_WIN_BIG5back to summary
public static final int ENCODING_WIN_BIG5
ENCODING_WIN_JOHABback to summary
public static final int ENCODING_WIN_JOHAB
ENCODING_WIN_PRCback to summary
public static final int ENCODING_WIN_PRC
ENCODING_WIN_SHIFT_JISback to summary
public static final int ENCODING_WIN_SHIFT_JIS
ENCODING_WIN_SYMBOLback to summary
public static final int ENCODING_WIN_SYMBOL
ENCODING_WIN_UNICODE_BMPback to summary
public static final int ENCODING_WIN_UNICODE_BMP
ENCODING_WIN_UNICODE_FULLback to summary
public static final int ENCODING_WIN_UNICODE_FULL
ENCODING_WIN_WANSUNGback to summary
public static final int ENCODING_WIN_WANSUNG
PLATFORM_MACINTOSHback to summary
public static final int PLATFORM_MACINTOSH
PLATFORM_UNICODEback to summary
public static final int PLATFORM_UNICODE
PLATFORM_WINDOWSback to summary
public static final int PLATFORM_WINDOWS
TAGback to summary
public static final String TAG

A tag used to identify this table.

Constructor Detail

CmapTableback to summary
pack-priv CmapTable()

Method Detail

getCmapsback to summary
public CmapSubtable[] getCmaps()
Returns:CmapSubtable[]

Returns the cmaps.

getSubtableback to summary
public CmapSubtable getSubtable(int platformId, int platformEncodingId)

Returns the subtable, if any, for the given platform and encoding.

Parameters
platformId:int

the ID of the given platform

platformEncodingId:int

the ID of the given encoding

Returns:CmapSubtable

the subtable, if any, or null

readback to summary
pack-priv void read(TrueTypeFont ttf, TTFDataStream data) throws IOException

Overrides org.apache.fontbox.ttf.TTFTable.read.

This will read the required data from the stream.

Parameters
ttf:TrueTypeFont

The font that is being read.

data:TTFDataStream

The stream to read the data from.

Annotations
@Override
Exceptions
IOException:
If there is an error reading the data.
setCmapsback to summary
public void setCmaps(CmapSubtable[] cmapsValue)
Parameters
cmapsValue:CmapSubtable[]

The cmaps to set.