Package org.apache.poi.hssf.record

Class LbsDataSubRecord

java.lang.Object

org.apache.poi.hssf.record.SubRecord

org.apache.poi.hssf.record.LbsDataSubRecord

All Implemented Interfaces:

Duplicatable, GenericRecord

public class LbsDataSubRecord
extends SubRecord

This structure specifies the properties of a list or drop-down list embedded object in a sheet.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LbsDataSubRecord.LbsDropData	This structure specifies properties of the dropdown list control

Nested classes/interfaces inherited from class org.apache.poi.hssf.record.SubRecord

SubRecord.SubRecordTypes

Field Summary

Fields

Modifier and Type	Field	Description
static int	sid

Constructor Summary

Constructors

Constructor	Description
LbsDataSubRecord(LbsDataSubRecord other)
LbsDataSubRecord(LittleEndianInput in, int cbFContinued, int cmoOt)

Method Summary

Modifier and Type	Method	Description
LbsDataSubRecord	copy()
protected int	getDataSize()
Ptg	getFormula()
Map<String,Supplier<?>>	getGenericProperties()
SubRecord.SubRecordTypes	getGenericRecordType()
int	getNumberOfItems()
boolean	isTerminating()	Whether this record terminates the sub-record stream.
static LbsDataSubRecord	newAutoFilterInstance()
void	serialize(LittleEndianOutput out)

Methods inherited from class org.apache.poi.hssf.record.SubRecord

createSubRecord, getMaxRecordLength, serialize, setMaxRecordLength, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord

getGenericChildren

Field Detail

sid

public static final int sid

See Also:

Constant Field Values

Constructor Detail

LbsDataSubRecord

public LbsDataSubRecord(LbsDataSubRecord other)

LbsDataSubRecord

public LbsDataSubRecord(LittleEndianInput in,
                        int cbFContinued,
                        int cmoOt)

Parameters:

in - the stream to read data from

cbFContinued - the seconf short in the record header

cmoOt - the containing Obj's CommonObjectDataSubRecord.field_1_objectType

Method Detail

newAutoFilterInstance

public static LbsDataSubRecord newAutoFilterInstance()

Returns:

a new instance of LbsDataSubRecord to construct auto-filters

See Also:

HSSFCombobox

isTerminating

public boolean isTerminating()

Description copied from class: SubRecord

Whether this record terminates the sub-record stream. There are two cases when this method must be overridden and return true - EndSubRecord (sid = 0x00) - LbsDataSubRecord (sid = 0x12)

Overrides:

isTerminating in class SubRecord

Returns:

true as LbsDataSubRecord is always the last sub-record

getDataSize

protected int getDataSize()

Specified by:

getDataSize in class SubRecord

Returns:

the size of the data for this record (which is always 4 bytes less than the total record size). Note however, that ushort encoded after the record sid is usually but not always the data size.

serialize

public void serialize(LittleEndianOutput out)

Specified by:

serialize in class SubRecord

copy

public LbsDataSubRecord copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class SubRecord

Returns:

a deep copy of the implementing class / instance

getFormula

public Ptg getFormula()

Returns:

the formula that specifies the range of cell values that are the items in this list.

getNumberOfItems

public int getNumberOfItems()

Returns:

the number of items in the list

getGenericRecordType

public SubRecord.SubRecordTypes getGenericRecordType()

Specified by:

getGenericRecordType in interface GenericRecord

Specified by:

getGenericRecordType in class SubRecord

getGenericProperties

public Map<String,Supplier<?>> getGenericProperties()