FileDocCategorySizeDatePackage
NumberFormatIndexRecord.javaAPI DocApache Poi 3.0.13960Mon Jan 01 12:39:40 GMT 2007org.apache.poi.hssf.record

NumberFormatIndexRecord

public class NumberFormatIndexRecord extends Record
The number format index record indexes format table. This applies to an axis. 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_formatIndex
Constructors Summary
public NumberFormatIndexRecord()
public NumberFormatIndexRecord(RecordInputStream in)
Constructs a NumberFormatIndex record and sets its fields appropriately.

param
id id must be 0x104e 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()

        NumberFormatIndexRecord rec = new NumberFormatIndexRecord();
    
        rec.field_1_formatIndex = field_1_formatIndex;
        return rec;
protected voidfillFields(org.apache.poi.hssf.record.RecordInputStream in)

        field_1_formatIndex            = in.readShort();
public shortgetFormatIndex()
Get the format index field for the NumberFormatIndex record.

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

        return 4  + 2;
public shortgetSid()

        return sid;
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_formatIndex);

        return getRecordSize();
public voidsetFormatIndex(short field_1_formatIndex)
Set the format index field for the NumberFormatIndex record.

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

        StringBuffer buffer = new StringBuffer();

        buffer.append("[IFMT]\n");
        buffer.append("    .formatIndex          = ")
            .append("0x").append(HexDump.toHex(  getFormatIndex ()))
            .append(" (").append( getFormatIndex() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 

        buffer.append("[/IFMT]\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 NumberFormatIndex record");
        }