Package loci.poi.hssf.record
Class ObjRecord
- java.lang.Object
-
- loci.poi.hssf.record.Record
-
- loci.poi.hssf.record.ObjRecord
-
public class ObjRecord extends Record
The obj record is used to hold various graphic objects and controls.- Author:
- Glen Stampoultzis (glens at apache.org)
-
-
Field Summary
Fields Modifier and Type Field Description static short
sid
-
Constructor Summary
Constructors Constructor Description ObjRecord()
ObjRecord(RecordInputStream in)
Constructs a OBJ record and sets its fields appropriately.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addSubRecord(int index, Object element)
boolean
addSubRecord(Object o)
void
clearSubRecords()
Object
clone()
protected void
fillFields(RecordInputStream in)
called by the constructor, should set class level fields.int
getRecordSize()
Size of record (excluding 4 byte header)short
getSid()
return the non static version of the id for this record.List
getSubRecords()
int
serialize(int offset, byte[] data)
called by the class that is responsible for writing this sucker.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 loci.poi.hssf.record.Record
isInValueSection, isValue, serialize
-
-
-
-
Field Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ObjRecord
public ObjRecord()
-
ObjRecord
public ObjRecord(RecordInputStream in)
Constructs a OBJ record and sets its fields appropriately.- Parameters:
in
- the RecordInputstream to read the record from
-
-
Method Detail
-
validateSid
protected void validateSid(short id)
Checks the sid matches the expected side for this record- Specified by:
validateSid
in classRecord
- Parameters:
id
- the expected sid.
-
fillFields
protected void fillFields(RecordInputStream in)
Description copied from class:Record
called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFields
in classRecord
- Parameters:
in
- the RecordInputstream to read the record from
-
toString
public String toString()
Description copied from class:Record
get a string representation of the record (for biffview/debugging)
-
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.
-
getRecordSize
public int getRecordSize()
Size of record (excluding 4 byte header)- Overrides:
getRecordSize
in classRecord
-
getSid
public short getSid()
Description copied from class:Record
return the non static version of the id for this record.
-
getSubRecords
public List getSubRecords()
-
clearSubRecords
public void clearSubRecords()
-
addSubRecord
public void addSubRecord(int index, Object element)
-
addSubRecord
public boolean addSubRecord(Object o)
-
-