Package org.apache.poi.hssf.record
Class HeaderFooterRecord
- 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.HeaderFooterRecord
-
- All Implemented Interfaces:
org.apache.poi.common.Duplicatable
,GenericRecord
public final class HeaderFooterRecord extends StandardRecord
The HEADERFOOTER record stores information added in Office Excel 2007 for headers/footers.
-
-
Field Summary
Fields Modifier and Type Field Description static short
sid
-
Constructor Summary
Constructors Constructor Description HeaderFooterRecord(byte[] data)
HeaderFooterRecord(HeaderFooterRecord other)
HeaderFooterRecord(RecordInputStream in)
construct a HeaderFooterRecord record.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description HeaderFooterRecord
copy()
java.util.Map<java.lang.String,java.util.function.Supplier<?>>
getGenericProperties()
HSSFRecordTypes
getGenericRecordType()
byte[]
getGuid()
If this header belongs to a specific sheet view , the sheet view?s GUID will be saved here.short
getSid()
return the non static version of the id for this record.boolean
isCurrentSheet()
void
serialize(LittleEndianOutput out)
spit the record out AS IS.-
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
equals, 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
-
HeaderFooterRecord
public HeaderFooterRecord(byte[] data)
-
HeaderFooterRecord
public HeaderFooterRecord(HeaderFooterRecord other)
-
HeaderFooterRecord
public HeaderFooterRecord(RecordInputStream in)
construct a HeaderFooterRecord record. No fields are interpreted and the record will be serialized in its original form more or less- Parameters:
in
- the RecordInputstream to read the record from
-
-
Method Detail
-
serialize
public void serialize(LittleEndianOutput out)
spit the record out AS IS. no interpretation or identification
-
getSid
public short getSid()
Description copied from class:Record
return the non static version of the id for this record.
-
getGuid
public byte[] getGuid()
If this header belongs to a specific sheet view , the sheet view?s GUID will be saved here.If it is zero, it means the current sheet. Otherwise, this field MUST match the guid field of the preceding
UserSViewBegin
record.- Returns:
- the sheet view?s GUID
-
isCurrentSheet
public boolean isCurrentSheet()
- Returns:
- whether this record belongs to the current sheet
-
copy
public HeaderFooterRecord copy()
- Specified by:
copy
in interfaceorg.apache.poi.common.Duplicatable
- Specified by:
copy
in classStandardRecord
-
getGenericRecordType
public HSSFRecordTypes getGenericRecordType()
- Specified by:
getGenericRecordType
in interfaceGenericRecord
- Specified by:
getGenericRecordType
in classRecord
-
getGenericProperties
public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()
-
-