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

public final Class TabIdRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput
Contains an array of sheet id's. Sheets always keep their ID regardless of what their name is.

Field Summary

Modifier and TypeField and Description
private short[]
_tabids

private static final short[]
EMPTY_SHORT_ARRAY

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
TabIdRecord()

public
TabIdRecord(TabIdRecord other)

public
TabIdRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public TabIdRecord
copy()

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

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

protected int
getDataSize()

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

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

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

public HSSFRecordTypes
getGenericRecordType()

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

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

public short
getSid()

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

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

public short
getTabIdAt(int index)

public int
getTabIdSize()

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
setTabIdArray(short[]
of tab id's {0,1,2}
array)

set the tab array.

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

Field Detail

_tabidsback to summary
private short[] _tabids
EMPTY_SHORT_ARRAYback to summary
private static final short[] EMPTY_SHORT_ARRAY
sidback to summary
public static final short sid

Constructor Detail

TabIdRecordback to summary
public TabIdRecord()
TabIdRecordback to summary
public TabIdRecord(TabIdRecord other)
TabIdRecordback to summary
public TabIdRecord(RecordInputStream in)

Method Detail

copyback to summary
public TabIdRecord copy()

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

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

Returns:TabIdRecord

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

a deep copy of the implementing class / instance

Annotations
@Override
getDataSizeback to summary
protected int getDataSize()

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

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

getTabIdAtback to summary
public short getTabIdAt(int index)
getTabIdSizeback to summary
public int getTabIdSize()
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

setTabIdArrayback to summary
public void setTabIdArray(short[] array)

set the tab array. (0,1,2).

Parameters
array:short[]

of tab id's {0,1,2}