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

FnGroupCountRecord

public class FnGroupCountRecord extends Record
Title: Function Group Count Record

Description: Number of built in function groups in the current version of the Spreadsheet (probably only used on Windoze)

REFERENCE: PG 315 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

author
Andrew C. Oliver (acoliver at apache dot org)
version
2.0-pre

Fields Summary
public static final short
sid
public static final short
COUNT
suggested default (14 dec)
private short
field_1_count
Constructors Summary
public FnGroupCountRecord()


     
    
    
public FnGroupCountRecord(RecordInputStream in)
Constructs a FnGroupCount record and sets its fields appropriately.

param
id id must be 0x9c or an exception will be throw upon validation
param
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
protected voidfillFields(org.apache.poi.hssf.record.RecordInputStream in)

        field_1_count = in.readShort();
    
public shortgetCount()
get the number of built-in functions

return
number of built-in functions

        return field_1_count;
    
public intgetRecordSize()

        return 6;
    
public shortgetSid()

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

        LittleEndian.putShort(data, 0 + offset, sid);
        LittleEndian.putShort(data, 2 + offset,
                              (( short ) 0x02));   // 2 bytes (6 total)
        LittleEndian.putShort(data, 4 + offset, getCount());
        return getRecordSize();
    
public voidsetCount(short count)
set the number of built-in functions

param
count - number of functions

        field_1_count = count;
    
public java.lang.StringtoString()

        StringBuffer buffer = new StringBuffer();

        buffer.append("[FNGROUPCOUNT]\n");
        buffer.append("    .count            = ").append(getCount())
            .append("\n");
        buffer.append("[/FNGROUPCOUNT]\n");
        return buffer.toString();
    
protected voidvalidateSid(short id)

        if (id != sid)
        {
            throw new RecordFormatException("NOT A FNGROUPCOUNT RECORD");
        }