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

PlotAreaRecord

public class PlotAreaRecord extends Record
preceeds and identifies a frame as belonging to the plot area. NOTE: This source is automatically generated please do not modify this file. Either subclass or remove the record in src/records/definitions.
author
Andrew C. Oliver (acoliver at apache.org)

Fields Summary
public static final short
sid
Constructors Summary
public PlotAreaRecord()
public PlotAreaRecord(RecordInputStream in)
Constructs a PlotArea record and sets its fields appropriately.

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

        PlotAreaRecord rec = new PlotAreaRecord();
    
        return rec;
protected voidfillFields(org.apache.poi.hssf.record.RecordInputStream in)
public intgetRecordSize()
Size of record (exluding 4 byte header)

        return 4 ;
public shortgetSid()

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

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


        return getRecordSize();
public java.lang.StringtoString()

        StringBuffer buffer = new StringBuffer();

        buffer.append("[PLOTAREA]\n");

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