Top Description Fields Constructors Methods
org.apache.poi.hssf.record

public final Class MMSRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput

defines how many add menu and del menu options are stored in the file. Should always be set to 0 for HSSF workbooks.
Version
2.0-pre

Field Summary

Modifier and TypeField and Description
private byte
private byte
public static final short

Constructor Summary

AccessConstructor and Description
public
public
public

Method Summary

Modifier and TypeMethod and Description
public MMSRecord
public byte

Returns:

number of add menu options
getAddMenuCount
()

get number of add menu options (should be 0)

protected int
public byte

Returns:

number of add menu options
getDelMenuCount
()

get number of add del options (should be 0)

public Map<String, Supplier<?>>
public HSSFRecordTypes
public short
getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

public void
serialize(LittleEndianOutput
the output object
out
)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record.

public void
setAddMenuCount(byte
number of add menu options
am
)

set number of add menu options (set to 0)

public void
setDelMenuCount(byte
number of del menu options
dm
)

set number of del menu options (set to 0)

Inherited from org.apache.poi.hssf.record.StandardRecord:
getRecordSizeserialize

Field Detail

field_1_addMenuCountback to summary
private byte field_1_addMenuCount
field_2_delMenuCountback to summary
private byte field_2_delMenuCount
sidback to summary
public static final short sid

Constructor Detail

MMSRecordback to summary
public MMSRecord()
MMSRecordback to summary
public MMSRecord(MMSRecord other)
MMSRecordback to summary
public MMSRecord(RecordInputStream in)

Method Detail

copyback to summary
public MMSRecord copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:MMSRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
getAddMenuCountback to summary
public byte getAddMenuCount()

get number of add menu options (should be 0)

Returns:byte

number of add menu options

getDataSizeback to summary
protected int getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

getDelMenuCountback to summary
public byte getDelMenuCount()

get number of add del options (should be 0)

Returns:byte

number of add menu options

getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getGenericRecordTypeback to summary
public HSSFRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations
@Override
getSidback to summary
public short getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

Doc from org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

Returns:short

he id for this record

serializeback to summary
public void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.

The number of bytes written must equal the record size reported by org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters
out:LittleEndianOutput

the output object

setAddMenuCountback to summary
public void setAddMenuCount(byte am)

set number of add menu options (set to 0)

Parameters
am:byte

number of add menu options

setDelMenuCountback to summary
public void setDelMenuCount(byte dm)

set number of del menu options (set to 0)

Parameters
dm:byte

number of del menu options