Package loci.poi.hssf.record
Class MMSRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.MMSRecord
Title: MMS Record
Description: defines how many add menu and del menu options are stored in the file. Should always be set to 0 for HSSF workbooks
REFERENCE: PG 328 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
- Version:
- 2.0-pre
- Author:
- Andrew C. Oliver (acoliver at apache dot org)
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a MMS record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidcalled by the constructor, should set class level fields.byteget number of add menu options (should be 0)byteget number of add del options (should be 0)intgives the current serialized size of the record.shortgetSid()return the non static version of the id for this record.intserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetAddMenuCount(byte am) set number of add menu options (set to 0)voidsetDelMenuCount(byte dm) set number of del menu options (set to 0)toString()get a string representation of the record (for biffview/debugging)protected voidvalidateSid(short id) called by constructor, should throw runtime exception in the event of a record passed with a differing ID.Methods inherited from class loci.poi.hssf.record.Record
clone, isInValueSection, isValue, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
MMSRecord
public MMSRecord() -
MMSRecord
Constructs a MMS record and sets its fields appropriately.- Parameters:
in- the RecordInputstream to read the record from
-
-
Method Details
-
validateSid
protected void validateSid(short id) Description copied from class:Recordcalled by constructor, should throw runtime exception in the event of a record passed with a differing ID.- Specified by:
validateSidin classRecord- Parameters:
id- alleged id for this record
-
fillFields
Description copied from class:Recordcalled by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFieldsin classRecord- Parameters:
in- the RecordInputstream to read the record from
-
setAddMenuCount
public void setAddMenuCount(byte am) set number of add menu options (set to 0)- Parameters:
am- number of add menu options
-
setDelMenuCount
public void setDelMenuCount(byte dm) set number of del menu options (set to 0)- Parameters:
dm- number of del menu options
-
getAddMenuCount
public byte getAddMenuCount()get number of add menu options (should be 0)- Returns:
- number of add menu options
-
getDelMenuCount
public byte getDelMenuCount()get number of add del options (should be 0)- Returns:
- number of add menu options
-
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
serialize
public int serialize(int offset, byte[] data) Description copied from class:Recordcalled 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()Description copied from class:Recordgives the current serialized size of the record. Should include the sid and reclength (4 bytes).- Overrides:
getRecordSizein classRecord
-
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record.
-