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

public Class HorizontalHeaderTable

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

Field Summary

Modifier and TypeField and Description
private int
advanceWidthMax

private short
ascender

private short
caretSlopeRise

private short
caretSlopeRun

private short
descender

private short
lineGap

private short
metricDataFormat

private short
minLeftSideBearing

private short
minRightSideBearing

private int
numberOfHMetrics

private short
reserved1

private short
reserved2

private short
reserved3

private short
reserved4

private short
reserved5

public static final String
TAG

A tag that identifies this table type.

private float
version

private short
xMaxExtent

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

Constructor Summary

AccessConstructor and Description
pack-priv
HorizontalHeaderTable()

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

Returns the advanceWidthMax.
getAdvanceWidthMax()

public short

Returns:

Returns the ascender.
getAscender()

public short

Returns:

Returns the caretSlopeRise.
getCaretSlopeRise()

public short

Returns:

Returns the caretSlopeRun.
getCaretSlopeRun()

public short

Returns:

Returns the descender.
getDescender()

public short

Returns:

Returns the lineGap.
getLineGap()

public short

Returns:

Returns the metricDataFormat.
getMetricDataFormat()

public short

Returns:

Returns the minLeftSideBearing.
getMinLeftSideBearing()

public short

Returns:

Returns the minRightSideBearing.
getMinRightSideBearing()

public int

Returns:

Returns the numberOfHMetrics.
getNumberOfHMetrics()

public short

Returns:

Returns the reserved1.
getReserved1()

public short

Returns:

Returns the reserved2.
getReserved2()

public short

Returns:

Returns the reserved3.
getReserved3()

public short

Returns:

Returns the reserved4.
getReserved4()

public short

Returns:

Returns the reserved5.
getReserved5()

public float

Returns:

Returns the version.
getVersion()

public short

Returns:

Returns the xMaxExtent.
getXMaxExtent()

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
setAdvanceWidthMax(int
The advanceWidthMax to set.
advanceWidthMaxValue)

public void
setAscender(short
The ascender to set.
ascenderValue)

public void
setCaretSlopeRise(short
The caretSlopeRise to set.
caretSlopeRiseValue)

public void
setCaretSlopeRun(short
The caretSlopeRun to set.
caretSlopeRunValue)

public void
setDescender(short
The descender to set.
descenderValue)

public void
setLineGap(short
The lineGap to set.
lineGapValue)

public void
setMetricDataFormat(short
The metricDataFormat to set.
metricDataFormatValue)

public void
setMinLeftSideBearing(short
The minLeftSideBearing to set.
minLeftSideBearingValue)

public void
setMinRightSideBearing(short
The minRightSideBearing to set.
minRightSideBearingValue)

public void
setNumberOfHMetrics(int
The numberOfHMetrics to set.
numberOfHMetricsValue)

public void
setReserved1(short
The reserved1 to set.
reserved1Value)

public void
setReserved2(short
The reserved2 to set.
reserved2Value)

public void
setReserved3(short
The reserved3 to set.
reserved3Value)

public void
setReserved4(short
The reserved4 to set.
reserved4Value)

public void
setReserved5(short
The reserved5 to set.
reserved5Value)

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

public void
setXMaxExtent(short
The xMaxExtent to set.
maxExtentValue)

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

Field Detail

advanceWidthMaxback to summary
private int advanceWidthMax
ascenderback to summary
private short ascender
caretSlopeRiseback to summary
private short caretSlopeRise
caretSlopeRunback to summary
private short caretSlopeRun
descenderback to summary
private short descender
lineGapback to summary
private short lineGap
metricDataFormatback to summary
private short metricDataFormat
minLeftSideBearingback to summary
private short minLeftSideBearing
minRightSideBearingback to summary
private short minRightSideBearing
numberOfHMetricsback to summary
private int numberOfHMetrics
reserved1back to summary
private short reserved1
reserved2back to summary
private short reserved2
reserved3back to summary
private short reserved3
reserved4back to summary
private short reserved4
reserved5back to summary
private short reserved5
TAGback to summary
public static final String TAG

A tag that identifies this table type.

versionback to summary
private float version
xMaxExtentback to summary
private short xMaxExtent

Constructor Detail

HorizontalHeaderTableback to summary
pack-priv HorizontalHeaderTable()

Method Detail

getAdvanceWidthMaxback to summary
public int getAdvanceWidthMax()
Returns:int

Returns the advanceWidthMax.

getAscenderback to summary
public short getAscender()
Returns:short

Returns the ascender.

getCaretSlopeRiseback to summary
public short getCaretSlopeRise()
Returns:short

Returns the caretSlopeRise.

getCaretSlopeRunback to summary
public short getCaretSlopeRun()
Returns:short

Returns the caretSlopeRun.

getDescenderback to summary
public short getDescender()
Returns:short

Returns the descender.

getLineGapback to summary
public short getLineGap()
Returns:short

Returns the lineGap.

getMetricDataFormatback to summary
public short getMetricDataFormat()
Returns:short

Returns the metricDataFormat.

getMinLeftSideBearingback to summary
public short getMinLeftSideBearing()
Returns:short

Returns the minLeftSideBearing.

getMinRightSideBearingback to summary
public short getMinRightSideBearing()
Returns:short

Returns the minRightSideBearing.

getNumberOfHMetricsback to summary
public int getNumberOfHMetrics()
Returns:int

Returns the numberOfHMetrics.

getReserved1back to summary
public short getReserved1()
Returns:short

Returns the reserved1.

getReserved2back to summary
public short getReserved2()
Returns:short

Returns the reserved2.

getReserved3back to summary
public short getReserved3()
Returns:short

Returns the reserved3.

getReserved4back to summary
public short getReserved4()
Returns:short

Returns the reserved4.

getReserved5back to summary
public short getReserved5()
Returns:short

Returns the reserved5.

getVersionback to summary
public float getVersion()
Returns:float

Returns the version.

getXMaxExtentback to summary
public short getXMaxExtent()
Returns:short

Returns the xMaxExtent.

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.
setAdvanceWidthMaxback to summary
public void setAdvanceWidthMax(int advanceWidthMaxValue)
Parameters
advanceWidthMaxValue:int

The advanceWidthMax to set.

setAscenderback to summary
public void setAscender(short ascenderValue)
Parameters
ascenderValue:short

The ascender to set.

setCaretSlopeRiseback to summary
public void setCaretSlopeRise(short caretSlopeRiseValue)
Parameters
caretSlopeRiseValue:short

The caretSlopeRise to set.

setCaretSlopeRunback to summary
public void setCaretSlopeRun(short caretSlopeRunValue)
Parameters
caretSlopeRunValue:short

The caretSlopeRun to set.

setDescenderback to summary
public void setDescender(short descenderValue)
Parameters
descenderValue:short

The descender to set.

setLineGapback to summary
public void setLineGap(short lineGapValue)
Parameters
lineGapValue:short

The lineGap to set.

setMetricDataFormatback to summary
public void setMetricDataFormat(short metricDataFormatValue)
Parameters
metricDataFormatValue:short

The metricDataFormat to set.

setMinLeftSideBearingback to summary
public void setMinLeftSideBearing(short minLeftSideBearingValue)
Parameters
minLeftSideBearingValue:short

The minLeftSideBearing to set.

setMinRightSideBearingback to summary
public void setMinRightSideBearing(short minRightSideBearingValue)
Parameters
minRightSideBearingValue:short

The minRightSideBearing to set.

setNumberOfHMetricsback to summary
public void setNumberOfHMetrics(int numberOfHMetricsValue)
Parameters
numberOfHMetricsValue:int

The numberOfHMetrics to set.

setReserved1back to summary
public void setReserved1(short reserved1Value)
Parameters
reserved1Value:short

The reserved1 to set.

setReserved2back to summary
public void setReserved2(short reserved2Value)
Parameters
reserved2Value:short

The reserved2 to set.

setReserved3back to summary
public void setReserved3(short reserved3Value)
Parameters
reserved3Value:short

The reserved3 to set.

setReserved4back to summary
public void setReserved4(short reserved4Value)
Parameters
reserved4Value:short

The reserved4 to set.

setReserved5back to summary
public void setReserved5(short reserved5Value)
Parameters
reserved5Value:short

The reserved5 to set.

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

The version to set.

setXMaxExtentback to summary
public void setXMaxExtent(short maxExtentValue)
Parameters
maxExtentValue:short

The xMaxExtent to set.