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

public final Class HeaderFooterRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Arrays, .Map, java.util.function.Supplier, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput
The HEADERFOOTER record stores information added in Office Excel 2007 for headers/footers.

Field Summary

Modifier and TypeField and Description
private byte[]
_rawData

private static final byte[]
BLANK_GUID

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
HeaderFooterRecord(byte[] data)

public
HeaderFooterRecord(HeaderFooterRecord other)

public
HeaderFooterRecord(RecordInputStream
the RecordInputstream to read the record from
in)

construct a HeaderFooterRecord record.

Method Summary

Modifier and TypeMethod and Description
public HeaderFooterRecord
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 byte[]

Returns:

the sheet view?s GUID
getGuid()

If this header belongs to a specific sheet view , the sheet view?s GUID will be saved here.

public short
getSid()

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

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

public boolean

Returns:

whether this record belongs to the current sheet
isCurrentSheet()

public void
serialize(LittleEndianOutput
the output object
out)

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

spit the record out AS IS.

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

Field Detail

_rawDataback to summary
private byte[] _rawData
BLANK_GUIDback to summary
private static final byte[] BLANK_GUID
Annotations
@SuppressWarnings:MismatchedReadAndWriteOfArray
sidback to summary
public static final short sid

Constructor Detail

HeaderFooterRecordback to summary
public HeaderFooterRecord(byte[] data)
HeaderFooterRecordback to summary
public HeaderFooterRecord(HeaderFooterRecord other)
HeaderFooterRecordback to summary
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:RecordInputStream

the RecordInputstream to read the record from

Method Detail

copyback to summary
public HeaderFooterRecord copy()

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

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

Returns:HeaderFooterRecord

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
getGuidback to summary
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:byte[]

the sheet view?s GUID

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

isCurrentSheetback to summary
public boolean isCurrentSheet()
Returns:boolean

whether this record belongs to the current sheet

serializeback to summary
public void serialize(LittleEndianOutput out)

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

spit the record out AS IS. no interpretation or identification

Parameters
out:LittleEndianOutput

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

the output object