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

public Class VerticalHeaderTable

extends TTFTable
Class Inheritance
Imports
java.io.IOException
A vertical header 'vhea' table in a TrueType or OpenType font. Supports versions 1.0 and 1.1, for which the only difference is changing the specification names and descriptions of the ascender, descender, and lineGap fields to vertTypoAscender, vertTypoDescender, vertTypeLineGap. This table is required by the OpenType CJK Font Guidelines for "all OpenType fonts that are used for vertical writing". This table is specified in both the TrueType and OpenType specifications.
Author
Glenn Adams

Field Summary

Modifier and TypeField and Description
private int
advanceHeightMax

private short
ascender

private short
caretOffset

private short
caretSlopeRise

private short
caretSlopeRun

private short
descender

private short
lineGap

private short
metricDataFormat

private short
minBottomSideBearing

private short
minTopSideBearing

private int
numberOfVMetrics

private short
reserved1

private short
reserved2

private short
reserved3

private short
reserved4

public static final String
TAG

A tag that identifies this table type.

private float
version

private short
yMaxExtent

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

Constructor Summary

AccessConstructor and Description
pack-priv
VerticalHeaderTable()

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

Returns the advanceHeightMax.
getAdvanceHeightMax()

public short

Returns:

Returns the ascender.
getAscender()

public short

Returns:

Returns the caretOffset.
getCaretOffset()

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 minBottomSideBearing.
getMinBottomSideBearing()

public short

Returns:

Returns the minTopSideBearing.
getMinTopSideBearing()

public int

Returns:

Returns the numberOfVMetrics.
getNumberOfVMetrics()

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 float

Returns:

Returns the version.
getVersion()

public short

Returns:

Returns the yMaxExtent.
getYMaxExtent()

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.

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

Field Detail

advanceHeightMaxback to summary
private int advanceHeightMax
ascenderback to summary
private short ascender
caretOffsetback to summary
private short caretOffset
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
minBottomSideBearingback to summary
private short minBottomSideBearing
minTopSideBearingback to summary
private short minTopSideBearing
numberOfVMetricsback to summary
private int numberOfVMetrics
reserved1back to summary
private short reserved1
reserved2back to summary
private short reserved2
reserved3back to summary
private short reserved3
reserved4back to summary
private short reserved4
TAGback to summary
public static final String TAG

A tag that identifies this table type.

versionback to summary
private float version
yMaxExtentback to summary
private short yMaxExtent

Constructor Detail

VerticalHeaderTableback to summary
pack-priv VerticalHeaderTable()

Method Detail

getAdvanceHeightMaxback to summary
public int getAdvanceHeightMax()
Returns:int

Returns the advanceHeightMax.

getAscenderback to summary
public short getAscender()
Returns:short

Returns the ascender.

getCaretOffsetback to summary
public short getCaretOffset()
Returns:short

Returns the caretOffset.

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.

getMinBottomSideBearingback to summary
public short getMinBottomSideBearing()
Returns:short

Returns the minBottomSideBearing.

getMinTopSideBearingback to summary
public short getMinTopSideBearing()
Returns:short

Returns the minTopSideBearing.

getNumberOfVMetricsback to summary
public int getNumberOfVMetrics()
Returns:int

Returns the numberOfVMetrics.

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.

getVersionback to summary
public float getVersion()
Returns:float

Returns the version.

getYMaxExtentback to summary
public short getYMaxExtent()
Returns:short

Returns the yMaxExtent.

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.