org.apache.poi.hssf.record
Class FontBasisRecord

java.lang.Object
  org.apache.poi.hssf.record.Record
      org.apache.poi.hssf.record.FontBasisRecord

public class FontBasisRecord
extends Record

The font basis record stores various font metrics. NOTE: This source is automatically generated please do not modify this file. Either subclass or remove the record in src/records/definitions.

Author:

Glen Stampoultzis (glens at apache.org)

Field Summary

static short

sid

Constructor Summary

FontBasisRecord()

FontBasisRecord(RecordInputStream in)
Constructs a FontBasis record and sets its fields appropriately.

Method Summary

java.lang.Object	clone()
protected void	fillFields(RecordInputStream in) called by the constructor, should set class level fields.
short	getHeightBasis() Get the height basis field for the FontBasis record.
short	getIndexToFontTable() Get the index to font table field for the FontBasis record.
int	getRecordSize() Size of record (exluding 4 byte header)
short	getScale() Get the scale field for the FontBasis record.
short	getSid() return the non static version of the id for this record.
short	getXBasis() Get the x Basis field for the FontBasis record.
short	getYBasis() Get the y Basis field for the FontBasis record.
int	serialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.
void	setHeightBasis(short field_3_heightBasis) Set the height basis field for the FontBasis record.
void	setIndexToFontTable(short field_5_indexToFontTable) Set the index to font table field for the FontBasis record.
void	setScale(short field_4_scale) Set the scale field for the FontBasis record.
void	setXBasis(short field_1_xBasis) Set the x Basis field for the FontBasis record.
void	setYBasis(short field_2_yBasis) Set the y Basis field for the FontBasis record.
java.lang.String	toString() get a string representation of the record (for biffview/debugging)
protected void	validateSid(short id) Checks the sid matches the expected side for this record

Methods inherited from class org.apache.poi.hssf.record.Record

cloneViaReserialise, isInValueSection, isValue, serialize

Methods inherited from class java.lang.Object

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

Field Detail

sid

public static final short sid

See Also:

Constant Field Values

Constructor Detail

FontBasisRecord

public FontBasisRecord()

FontBasisRecord

public FontBasisRecord(RecordInputStream in)

Constructs a FontBasis record and sets its fields appropriately.

Parameters:

in - the RecordInputstream to read the record from

Method Detail

validateSid

protected void validateSid(short id)

Checks the sid matches the expected side for this record

Specified by:

validateSid in class Record

Parameters:

id - the expected sid.

fillFields

protected void fillFields(RecordInputStream in)

Description copied from class: Record

called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.

Specified by:

fillFields in class Record

Parameters:

in - the RecordInputstream to read the record from

toString

public java.lang.String toString()

Description copied from class: Record

get a string representation of the record (for biffview/debugging)

Overrides:

toString in class Record

serialize

public int serialize(int offset,
                     byte[] data)

Description copied from class: Record

called by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array.

Specified by:

serialize in class Record

Parameters:

offset - to begin writing at

data - byte array containing instance data

Returns:

number of bytes written

getRecordSize

public int getRecordSize()

Size of record (exluding 4 byte header)

Overrides:

getRecordSize in class Record

getSid

public short getSid()

Description copied from class: Record

return the non static version of the id for this record.

Specified by:

getSid in class Record

clone

public java.lang.Object clone()

Overrides:

clone in class Record

getXBasis

public short getXBasis()

Get the x Basis field for the FontBasis record.

setXBasis

public void setXBasis(short field_1_xBasis)

Set the x Basis field for the FontBasis record.

getYBasis

public short getYBasis()

Get the y Basis field for the FontBasis record.

setYBasis

public void setYBasis(short field_2_yBasis)

Set the y Basis field for the FontBasis record.

getHeightBasis

public short getHeightBasis()

Get the height basis field for the FontBasis record.

setHeightBasis

public void setHeightBasis(short field_3_heightBasis)

Set the height basis field for the FontBasis record.

getScale

public short getScale()

Get the scale field for the FontBasis record.

setScale

public void setScale(short field_4_scale)

Set the scale field for the FontBasis record.

getIndexToFontTable

public short getIndexToFontTable()

Get the index to font table field for the FontBasis record.

setIndexToFontTable

public void setIndexToFontTable(short field_5_indexToFontTable)

Set the index to font table field for the FontBasis record.