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

public final Class FeatRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, java.util.stream.Stream, org.apache.logging.log4j.LogManager, .Logger, org.apache.poi.hssf.record.common.FeatFormulaErr2, .FeatProtection, .FeatSmartTag, .FtrHeader, .SharedFeature, org.apache.poi.ss.util.CellRangeAddress, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput
Title: Feat (Feature) Record

This record specifies Shared Features data. It is normally paired up with a FeatHdrRecord.

Field Summary

Modifier and TypeField and Description
private long
cbFeatData

Only matters if type is ISFFEC2

private CellRangeAddress[]
cellRefs

private final FtrHeader
futureHeader

private int
isf_sharedFeatureType

See SHAREDFEATURES_* on FeatHdrRecord

private static final Logger
LOG

private byte
reserved1

private long
reserved2

private int
reserved3

private SharedFeature
sharedFeature

Contents depends on isf_sharedFeatureType : ISFPROTECTION -> FeatProtection ISFFEC2 -> FeatFormulaErr2 ISFFACTOID -> FeatSmartTag

public static final short
sid

public static final short
v11_sid

public static final short
v12_sid

Constructor Summary

AccessConstructor and Description
public
FeatRecord()

public
FeatRecord(FeatRecord other)

public
FeatRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public FeatRecord
copy()

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

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

public long
getCbFeatData()

public CellRangeAddress[]
getCellRefs()

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 int
getIsf_sharedFeatureType()

public SharedFeature
getSharedFeature()

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
setCbFeatData(long cbFeatData)

public void
setCellRefs(CellRangeAddress[] cellRefs)

public void
setSharedFeature(SharedFeature feature)

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

Field Detail

cbFeatDataback to summary
private long cbFeatData

Only matters if type is ISFFEC2

cellRefsback to summary
private CellRangeAddress[] cellRefs
futureHeaderback to summary
private final FtrHeader futureHeader
isf_sharedFeatureTypeback to summary
private int isf_sharedFeatureType

See SHAREDFEATURES_* on FeatHdrRecord

LOGback to summary
private static final Logger LOG
reserved1back to summary
private byte reserved1
reserved2back to summary
private long reserved2
reserved3back to summary
private int reserved3
sharedFeatureback to summary
private SharedFeature sharedFeature

Contents depends on isf_sharedFeatureType : ISFPROTECTION -> FeatProtection ISFFEC2 -> FeatFormulaErr2 ISFFACTOID -> FeatSmartTag

sidback to summary
public static final short sid
v11_sidback to summary
public static final short v11_sid
v12_sidback to summary
public static final short v12_sid

Constructor Detail

FeatRecordback to summary
public FeatRecord()
FeatRecordback to summary
public FeatRecord(FeatRecord other)
FeatRecordback to summary
public FeatRecord(RecordInputStream in)

Method Detail

copyback to summary
public FeatRecord copy()

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

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

Returns:FeatRecord

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

a deep copy of the implementing class / instance

Annotations
@Override
getCbFeatDataback to summary
public long getCbFeatData()
getCellRefsback to summary
public CellRangeAddress[] getCellRefs()
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
getIsf_sharedFeatureTypeback to summary
public int getIsf_sharedFeatureType()
getSharedFeatureback to summary
public SharedFeature getSharedFeature()
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

setCbFeatDataback to summary
public void setCbFeatData(long cbFeatData)
setCellRefsback to summary
public void setCellRefs(CellRangeAddress[] cellRefs)
setSharedFeatureback to summary
public void setSharedFeature(SharedFeature feature)