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

public Class HeaderTable

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

Field Summary

Modifier and TypeField and Description
private long
checkSumAdjustment

private Calendar
created

private int
flags

private short
fontDirectionHint

private float
fontRevision

private short
glyphDataFormat

private short
indexToLocFormat

private int
lowestRecPPEM

public static final int
MAC_STYLE_BOLD

Bold macStyle flag.

public static final int
MAC_STYLE_ITALIC

Italic macStyle flag.

private int
macStyle

private long
magicNumber

private Calendar
modified

public static final String
TAG

Tag to identify this table.

private int
unitsPerEm

private float
version

private short
xMax

private short
xMin

private short
yMax

private short
yMin

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

Constructor Summary

AccessConstructor and Description
pack-priv
HeaderTable()

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

Returns the checkSumAdjustment.
getCheckSumAdjustment()

public Calendar

Returns:

Returns the created.
getCreated()

public int

Returns:

Returns the flags.
getFlags()

public short

Returns:

Returns the fontDirectionHint.
getFontDirectionHint()

public float

Returns:

Returns the fontRevision.
getFontRevision()

public short

Returns:

Returns the glyphDataFormat.
getGlyphDataFormat()

public short

Returns:

Returns the indexToLocFormat.
getIndexToLocFormat()

public int

Returns:

Returns the lowestRecPPEM.
getLowestRecPPEM()

public int

Returns:

Returns the macStyle.
getMacStyle()

public long

Returns:

Returns the magicNumber.
getMagicNumber()

public Calendar

Returns:

Returns the modified.
getModified()

public int

Returns:

Returns the unitsPerEm.
getUnitsPerEm()

public float

Returns:

Returns the version.
getVersion()

public short

Returns:

Returns the xMax.
getXMax()

public short

Returns:

Returns the xMin.
getXMin()

public short

Returns:

Returns the yMax.
getYMax()

public short

Returns:

Returns the yMin.
getYMin()

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.

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

Overrides org.apache.fontbox.ttf.TTFTable.readHeaders.

This will read required headers from the stream into outHeaders.

public void
setCheckSumAdjustment(long
The checkSumAdjustment to set.
checkSumAdjustmentValue)

public void
setCreated(Calendar
The created to set.
createdValue)

public void
setFlags(int
The flags to set.
flagsValue)

public void
setFontDirectionHint(short
The fontDirectionHint to set.
fontDirectionHintValue)

public void
setFontRevision(float
The fontRevision to set.
fontRevisionValue)

public void
setGlyphDataFormat(short
The glyphDataFormat to set.
glyphDataFormatValue)

public void
setIndexToLocFormat(short
The indexToLocFormat to set.
indexToLocFormatValue)

public void
setLowestRecPPEM(int
The lowestRecPPEM to set.
lowestRecPPEMValue)

public void
setMacStyle(int
The macStyle to set.
macStyleValue)

public void
setMagicNumber(long
The magicNumber to set.
magicNumberValue)

public void
setModified(Calendar
The modified to set.
modifiedValue)

public void
setUnitsPerEm(int
The unitsPerEm to set.
unitsPerEmValue)

public void
setVersion(float
The version to set.
versionValue)

public void
setXMax(short
The xMax to set.
maxValue)

public void
setXMin(short
The xMin to set.
minValue)

public void
setYMax(short
The yMax to set.
maxValue)

public void
setYMin(short
The yMin to set.
minValue)

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

Field Detail

checkSumAdjustmentback to summary
private long checkSumAdjustment
createdback to summary
private Calendar created
flagsback to summary
private int flags
fontDirectionHintback to summary
private short fontDirectionHint
fontRevisionback to summary
private float fontRevision
glyphDataFormatback to summary
private short glyphDataFormat
indexToLocFormatback to summary
private short indexToLocFormat
lowestRecPPEMback to summary
private int lowestRecPPEM
MAC_STYLE_BOLDback to summary
public static final int MAC_STYLE_BOLD

Bold macStyle flag.

MAC_STYLE_ITALICback to summary
public static final int MAC_STYLE_ITALIC

Italic macStyle flag.

macStyleback to summary
private int macStyle
magicNumberback to summary
private long magicNumber
modifiedback to summary
private Calendar modified
TAGback to summary
public static final String TAG

Tag to identify this table.

unitsPerEmback to summary
private int unitsPerEm
versionback to summary
private float version
xMaxback to summary
private short xMax
xMinback to summary
private short xMin
yMaxback to summary
private short yMax
yMinback to summary
private short yMin

Constructor Detail

HeaderTableback to summary
pack-priv HeaderTable()

Method Detail

getCheckSumAdjustmentback to summary
public long getCheckSumAdjustment()
Returns:long

Returns the checkSumAdjustment.

getCreatedback to summary
public Calendar getCreated()
Returns:Calendar

Returns the created.

getFlagsback to summary
public int getFlags()
Returns:int

Returns the flags.

getFontDirectionHintback to summary
public short getFontDirectionHint()
Returns:short

Returns the fontDirectionHint.

getFontRevisionback to summary
public float getFontRevision()
Returns:float

Returns the fontRevision.

getGlyphDataFormatback to summary
public short getGlyphDataFormat()
Returns:short

Returns the glyphDataFormat.

getIndexToLocFormatback to summary
public short getIndexToLocFormat()
Returns:short

Returns the indexToLocFormat.

getLowestRecPPEMback to summary
public int getLowestRecPPEM()
Returns:int

Returns the lowestRecPPEM.

getMacStyleback to summary
public int getMacStyle()
Returns:int

Returns the macStyle.

getMagicNumberback to summary
public long getMagicNumber()
Returns:long

Returns the magicNumber.

getModifiedback to summary
public Calendar getModified()
Returns:Calendar

Returns the modified.

getUnitsPerEmback to summary
public int getUnitsPerEm()
Returns:int

Returns the unitsPerEm.

getVersionback to summary
public float getVersion()
Returns:float

Returns the version.

getXMaxback to summary
public short getXMax()
Returns:short

Returns the xMax.

getXMinback to summary
public short getXMin()
Returns:short

Returns the xMin.

getYMaxback to summary
public short getYMax()
Returns:short

Returns the yMax.

getYMinback to summary
public short getYMin()
Returns:short

Returns the yMin.

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.
readHeadersback to summary
pack-priv void readHeaders(TrueTypeFont ttf, TTFDataStream data, FontHeaders outHeaders) throws IOException

Overrides org.apache.fontbox.ttf.TTFTable.readHeaders.

Doc from org.apache.fontbox.ttf.TTFTable.readHeaders.

This will read required headers from the stream into outHeaders.

Parameters
ttf:TrueTypeFont

The font that is being read.

data:TTFDataStream

The stream to read the data from.

outHeaders:FontHeaders

The class to write the data to.

Annotations
@Override
Exceptions
IOException:
If there is an error reading the data.
setCheckSumAdjustmentback to summary
public void setCheckSumAdjustment(long checkSumAdjustmentValue)
Parameters
checkSumAdjustmentValue:long

The checkSumAdjustment to set.

setCreatedback to summary
public void setCreated(Calendar createdValue)
Parameters
createdValue:Calendar

The created to set.

setFlagsback to summary
public void setFlags(int flagsValue)
Parameters
flagsValue:int

The flags to set.

setFontDirectionHintback to summary
public void setFontDirectionHint(short fontDirectionHintValue)
Parameters
fontDirectionHintValue:short

The fontDirectionHint to set.

setFontRevisionback to summary
public void setFontRevision(float fontRevisionValue)
Parameters
fontRevisionValue:float

The fontRevision to set.

setGlyphDataFormatback to summary
public void setGlyphDataFormat(short glyphDataFormatValue)
Parameters
glyphDataFormatValue:short

The glyphDataFormat to set.

setIndexToLocFormatback to summary
public void setIndexToLocFormat(short indexToLocFormatValue)
Parameters
indexToLocFormatValue:short

The indexToLocFormat to set.

setLowestRecPPEMback to summary
public void setLowestRecPPEM(int lowestRecPPEMValue)
Parameters
lowestRecPPEMValue:int

The lowestRecPPEM to set.

setMacStyleback to summary
public void setMacStyle(int macStyleValue)
Parameters
macStyleValue:int

The macStyle to set.

setMagicNumberback to summary
public void setMagicNumber(long magicNumberValue)
Parameters
magicNumberValue:long

The magicNumber to set.

setModifiedback to summary
public void setModified(Calendar modifiedValue)
Parameters
modifiedValue:Calendar

The modified to set.

setUnitsPerEmback to summary
public void setUnitsPerEm(int unitsPerEmValue)
Parameters
unitsPerEmValue:int

The unitsPerEm to set.

setVersionback to summary
public void setVersion(float versionValue)
Parameters
versionValue:float

The version to set.

setXMaxback to summary
public void setXMax(short maxValue)
Parameters
maxValue:short

The xMax to set.

setXMinback to summary
public void setXMin(short minValue)
Parameters
minValue:short

The xMin to set.

setYMaxback to summary
public void setYMax(short maxValue)
Parameters
maxValue:short

The yMax to set.

setYMinback to summary
public void setYMin(short minValue)
Parameters
minValue:short

The yMin to set.