FileDocCategorySizeDatePackage
FontBasisRecord.javaAPI DocApache Poi 3.0.17112Mon Jan 01 12:39:40 GMT 2007org.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)

Fields Summary
public static final short
sid
private short
field_1_xBasis
private short
field_2_yBasis
private short
field_3_heightBasis
private short
field_4_scale
private short
field_5_indexToFontTable
Constructors Summary
public FontBasisRecord()



     
    

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

param
id id must be 0x1060 or an exception will be throw upon validation
param
size size the size of the data area of the record
param
data data of the record (should not contain sid/len)

        super(in);
    
    
Methods Summary
public java.lang.Objectclone()

        FontBasisRecord rec = new FontBasisRecord();
    
        rec.field_1_xBasis = field_1_xBasis;
        rec.field_2_yBasis = field_2_yBasis;
        rec.field_3_heightBasis = field_3_heightBasis;
        rec.field_4_scale = field_4_scale;
        rec.field_5_indexToFontTable = field_5_indexToFontTable;
        return rec;
    
protected voidfillFields(org.apache.poi.hssf.record.RecordInputStream in)

        field_1_xBasis                 = in.readShort();
        field_2_yBasis                 = in.readShort();
        field_3_heightBasis            = in.readShort();
        field_4_scale                  = in.readShort();
        field_5_indexToFontTable       = in.readShort();
    
public shortgetHeightBasis()
Get the height basis field for the FontBasis record.

        return field_3_heightBasis;
    
public shortgetIndexToFontTable()
Get the index to font table field for the FontBasis record.

        return field_5_indexToFontTable;
    
public intgetRecordSize()
Size of record (exluding 4 byte header)

        return 4  + 2 + 2 + 2 + 2 + 2;
    
public shortgetScale()
Get the scale field for the FontBasis record.

        return field_4_scale;
    
public shortgetSid()

        return sid;
    
public shortgetXBasis()
Get the x Basis field for the FontBasis record.

        return field_1_xBasis;
    
public shortgetYBasis()
Get the y Basis field for the FontBasis record.

        return field_2_yBasis;
    
public intserialize(int offset, byte[] data)

        int pos = 0;

        LittleEndian.putShort(data, 0 + offset, sid);
        LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));

        LittleEndian.putShort(data, 4 + offset + pos, field_1_xBasis);
        LittleEndian.putShort(data, 6 + offset + pos, field_2_yBasis);
        LittleEndian.putShort(data, 8 + offset + pos, field_3_heightBasis);
        LittleEndian.putShort(data, 10 + offset + pos, field_4_scale);
        LittleEndian.putShort(data, 12 + offset + pos, field_5_indexToFontTable);

        return getRecordSize();
    
public voidsetHeightBasis(short field_3_heightBasis)
Set the height basis field for the FontBasis record.

        this.field_3_heightBasis = field_3_heightBasis;
    
public voidsetIndexToFontTable(short field_5_indexToFontTable)
Set the index to font table field for the FontBasis record.

        this.field_5_indexToFontTable = field_5_indexToFontTable;
    
public voidsetScale(short field_4_scale)
Set the scale field for the FontBasis record.

        this.field_4_scale = field_4_scale;
    
public voidsetXBasis(short field_1_xBasis)
Set the x Basis field for the FontBasis record.

        this.field_1_xBasis = field_1_xBasis;
    
public voidsetYBasis(short field_2_yBasis)
Set the y Basis field for the FontBasis record.

        this.field_2_yBasis = field_2_yBasis;
    
public java.lang.StringtoString()

        StringBuffer buffer = new StringBuffer();

        buffer.append("[FBI]\n");
        buffer.append("    .xBasis               = ")
            .append("0x").append(HexDump.toHex(  getXBasis ()))
            .append(" (").append( getXBasis() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .yBasis               = ")
            .append("0x").append(HexDump.toHex(  getYBasis ()))
            .append(" (").append( getYBasis() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .heightBasis          = ")
            .append("0x").append(HexDump.toHex(  getHeightBasis ()))
            .append(" (").append( getHeightBasis() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .scale                = ")
            .append("0x").append(HexDump.toHex(  getScale ()))
            .append(" (").append( getScale() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .indexToFontTable     = ")
            .append("0x").append(HexDump.toHex(  getIndexToFontTable ()))
            .append(" (").append( getIndexToFontTable() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 

        buffer.append("[/FBI]\n");
        return buffer.toString();
    
protected voidvalidateSid(short id)
Checks the sid matches the expected side for this record

param
id the expected sid.

        if (id != sid)
        {
            throw new RecordFormatException("Not a FontBasis record");
        }