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

public final Class FeatHdrRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.hssf.record.common.FtrHeader, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput
Title: FeatHdr (Feature Header) Record

This record specifies common information for Shared Features, and specifies the beginning of a collection of records to define them. The collection of data (Globals Substream ABNF, macro sheet substream ABNF or worksheet substream ABNF) specifies Shared Feature data.

Field Summary

Modifier and TypeField and Description
private long
cbHdrData

0x00000000 = rgbHdrData not present 0xffffffff = rgbHdrData present

private final FtrHeader
futureHeader

private int
isf_sharedFeatureType

private byte
reserved

private byte[]
rgbHdrData

We need a BOFRecord to make sense of this...

public static final int
SHAREDFEATURES_ISFFACTOID

Specifies the smart tag type.

public static final int
SHAREDFEATURES_ISFFEC2

Specifies that formula errors should be ignored

public static final int
SHAREDFEATURES_ISFLIST

Specifies the shared list type.

public static final int
SHAREDFEATURES_ISFPROTECTION

Specifies the enhanced protection type.

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
FeatHdrRecord()

public
FeatHdrRecord(FeatHdrRecord other)

public
FeatHdrRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public FeatHdrRecord
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 void
serialize(LittleEndianOutput
the output object
out)

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

Write the data content of this BIFF record.

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

Field Detail

cbHdrDataback to summary
private long cbHdrData

0x00000000 = rgbHdrData not present 0xffffffff = rgbHdrData present

futureHeaderback to summary
private final FtrHeader futureHeader
isf_sharedFeatureTypeback to summary
private int isf_sharedFeatureType
reservedback to summary
private byte reserved
rgbHdrDataback to summary
private byte[] rgbHdrData

We need a BOFRecord to make sense of this...

SHAREDFEATURES_ISFFACTOIDback to summary
public static final int SHAREDFEATURES_ISFFACTOID

Specifies the smart tag type. Recognises certain types of entries (proper names, dates/times etc) and flags them for action

SHAREDFEATURES_ISFFEC2back to summary
public static final int SHAREDFEATURES_ISFFEC2

Specifies that formula errors should be ignored

SHAREDFEATURES_ISFLISTback to summary
public static final int SHAREDFEATURES_ISFLIST

Specifies the shared list type. Used for a table within a sheet

SHAREDFEATURES_ISFPROTECTIONback to summary
public static final int SHAREDFEATURES_ISFPROTECTION

Specifies the enhanced protection type. Used to protect a shared workbook by restricting access to some areas of it

sidback to summary
public static final short sid

Constructor Detail

FeatHdrRecordback to summary
public FeatHdrRecord()
FeatHdrRecordback to summary
public FeatHdrRecord(FeatHdrRecord other)
FeatHdrRecordback to summary
public FeatHdrRecord(RecordInputStream in)

Method Detail

copyback to summary
public FeatHdrRecord copy()

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

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

Returns:FeatHdrRecord

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

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