org.apache.poi.hssf.record
Class PlotAreaRecord
java.lang.Object
|
+--org.apache.poi.hssf.record.Record
|
+--org.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)
Field Summary |
static short |
sid
|
Constructor Summary |
PlotAreaRecord()
|
PlotAreaRecord(short id,
short size,
byte[] data)
Constructs a PlotArea record and sets its fields appropriately. |
PlotAreaRecord(short id,
short size,
byte[] data,
int offset)
Constructs a PlotArea 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. |
int |
getRecordSize()
Size of record (exluding 4 byte header) |
short |
getSid()
return the non static version of the id for this record. |
int |
serialize(int offset,
byte[] data)
called by the class that is responsible for writing this sucker. |
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 java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
sid
public static final short sid
PlotAreaRecord
public PlotAreaRecord()
PlotAreaRecord
public PlotAreaRecord(short id,
short size,
byte[] data)
- Constructs a PlotArea record and sets its fields appropriately.
- Parameters:
id
- id must be 0x1035 or an exception
will be throw upon validationsize
- size the size of the data area of the recorddata
- data of the record (should not contain sid/len)
PlotAreaRecord
public PlotAreaRecord(short id,
short size,
byte[] data,
int offset)
- Constructs a PlotArea record and sets its fields appropriately.
- Parameters:
id
- id must be 0x1035 or an exception
will be throw upon validationsize
- size the size of the data area of the recorddata
- data of the record (should not contain sid/len)offset
- of the record's data
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 datasize
- size of dataoffset
- 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 atdata
- 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
Copyright © 2002 Apache jakarta-poi project. All Rights Reserved.