Package org.apache.poi.hssf.record
Class FeatHdrRecord
- 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.FeatHdrRecord
-
- All Implemented Interfaces:
Duplicatable
,GenericRecord
public final class FeatHdrRecord extends StandardRecord
Title: FeatHdr (Feature Header) RecordThis 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
Fields Modifier and Type Field Description static int
SHAREDFEATURES_ISFFACTOID
Specifies the smart tag type.static int
SHAREDFEATURES_ISFFEC2
Specifies that formula errors should be ignoredstatic int
SHAREDFEATURES_ISFLIST
Specifies the shared list type.static int
SHAREDFEATURES_ISFPROTECTION
Specifies the enhanced protection type.static short
sid
-
Constructor Summary
Constructors Constructor Description FeatHdrRecord()
FeatHdrRecord(int sharedFutureType)
FeatHdrRecord(FeatHdrRecord other)
FeatHdrRecord(RecordInputStream in)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FeatHdrRecord
copy()
protected int
getDataSize()
EnhancedProtection
getEnhancedProtection()
Map<String,Supplier<?>>
getGenericProperties()
HSSFRecordTypes
getGenericRecordType()
short
getSid()
return the non static version of the id for this record.boolean
isEnhancedProtection()
void
serialize(LittleEndianOutput out)
Write the data content of this BIFF record.-
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
-
SHAREDFEATURES_ISFPROTECTION
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- See Also:
- Constant Field Values
-
SHAREDFEATURES_ISFFEC2
public static final int SHAREDFEATURES_ISFFEC2
Specifies that formula errors should be ignored- See Also:
- Constant Field Values
-
SHAREDFEATURES_ISFFACTOID
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- See Also:
- Constant Field Values
-
SHAREDFEATURES_ISFLIST
public static final int SHAREDFEATURES_ISFLIST
Specifies the shared list type. Used for a table within a sheet- See Also:
- Constant Field Values
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
FeatHdrRecord
public FeatHdrRecord()
-
FeatHdrRecord
public FeatHdrRecord(int sharedFutureType)
-
FeatHdrRecord
public FeatHdrRecord(FeatHdrRecord other)
-
FeatHdrRecord
public FeatHdrRecord(RecordInputStream in)
-
-
Method Detail
-
getSid
public short getSid()
Description copied from class:Record
return the non static version of the id for this record.
-
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
-
getDataSize
protected int getDataSize()
- Specified by:
getDataSize
in classStandardRecord
-
copy
public FeatHdrRecord 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
-
isEnhancedProtection
public boolean isEnhancedProtection()
-
getEnhancedProtection
public EnhancedProtection getEnhancedProtection()
-
-