Package org.apache.poi.hssf.record
Class TabIdRecord
- java.lang.Object
-
- org.apache.poi.hssf.record.RecordBase
-
- org.apache.poi.hssf.record.Record
-
- org.apache.poi.hssf.record.StandardRecord
-
- org.apache.poi.hssf.record.TabIdRecord
-
- All Implemented Interfaces:
Duplicatable
,GenericRecord
public final class TabIdRecord extends StandardRecord
Contains an array of sheet id's. Sheets always keep their ID regardless of what their name is.
-
-
Field Summary
Fields Modifier and Type Field Description static short
sid
-
Constructor Summary
Constructors Constructor Description TabIdRecord()
TabIdRecord(RecordInputStream in)
TabIdRecord(TabIdRecord other)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TabIdRecord
copy()
protected int
getDataSize()
Map<String,Supplier<?>>
getGenericProperties()
HSSFRecordTypes
getGenericRecordType()
short
getSid()
return the non static version of the id for this record.short
getTabIdAt(int index)
int
getTabIdSize()
void
serialize(LittleEndianOutput out)
Write the data content of this BIFF record.void
setTabIdArray(short[] array)
set the tab array.-
Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
-
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize, 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 short sid
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
TabIdRecord
public TabIdRecord()
-
TabIdRecord
public TabIdRecord(TabIdRecord other)
-
TabIdRecord
public TabIdRecord(RecordInputStream in)
-
-
Method Detail
-
setTabIdArray
public void setTabIdArray(short[] array)
set the tab array. (0,1,2).- Parameters:
array
- of tab id's {0,1,2}
-
serialize
public void serialize(LittleEndianOutput out)
Description copied from class:StandardRecord
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
RecordBase.getRecordSize()
} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).- Specified by:
serialize
in classStandardRecord
- Parameters:
out
- the output object
-
getTabIdSize
public int getTabIdSize()
-
getTabIdAt
public short getTabIdAt(int index)
-
getDataSize
protected int getDataSize()
- Specified by:
getDataSize
in classStandardRecord
-
getSid
public short getSid()
Description copied from class:Record
return the non static version of the id for this record.
-
copy
public TabIdRecord copy()
- Specified by:
copy
in interfaceDuplicatable
- Specified by:
copy
in classStandardRecord
- Returns:
- a deep copy of the implementing class / instance
-
getGenericRecordType
public HSSFRecordTypes getGenericRecordType()
- Specified by:
getGenericRecordType
in interfaceGenericRecord
- Specified by:
getGenericRecordType
in classRecord
-
-