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(short id, short size, byte[] data)
          Constructs a FontBasis record and sets its fields appropriately.
FontBasisRecord(short id, short size, byte[] data, int offset)
          Constructs a FontBasis record and sets its fields appropriately.
 
Method Summary
protected  void fillFields(byte[] data, short size, int offset)
          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
fillFields, isInValueSection, isValue, processContinueRecord, serialize
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

sid

public static final short sid
Constructor Detail

FontBasisRecord

public FontBasisRecord()

FontBasisRecord

public FontBasisRecord(short id,
                       short size,
                       byte[] data)
Constructs a FontBasis record and sets its fields appropriately.
Parameters:
id - id must be 0x1060 or an exception will be throw upon validation
size - size the size of the data area of the record
data - data of the record (should not contain sid/len)

FontBasisRecord

public FontBasisRecord(short id,
                       short size,
                       byte[] data,
                       int offset)
Constructs a FontBasis record and sets its fields appropriately.
Parameters:
id - id must be 0x1060 or an exception will be throw upon validation
size - size the size of the data area of the record
data - data of the record (should not contain sid/len)
offset - of the record's data
Method Detail

validateSid

protected void validateSid(short id)
Checks the sid matches the expected side for this record
Overrides:
validateSid in class Record
Parameters:
id - the expected sid.

fillFields

protected void fillFields(byte[] data,
                          short size,
                          int offset)
Description copied from class: Record
called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.
Overrides:
fillFields in class Record
Following copied from class: org.apache.poi.hssf.record.Record
Parameters:
data - raw data
size - size of data
offset - of the record's data (provided a big array of the file)

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.
Overrides:
serialize in class Record
Following copied from class: org.apache.poi.hssf.record.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.
Overrides:
getSid 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.


Copyright © 2002 Apache jakarta-poi project. All Rights Reserved.