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

public abstract Class HeaderFooterBase

extends StandardRecord
Class Inheritance
Known Direct Subclasses
org.apache.poi.hssf.record.HeaderRecord, org.apache.poi.hssf.record.FooterRecord
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput, .StringUtil
Common header/footer base class

Field Summary

Modifier and TypeField and Description
private boolean
field_2_hasMultibyte

private String
field_3_text

Constructor Summary

AccessConstructor and Description
protected
HeaderFooterBase(String text)

protected
HeaderFooterBase(HeaderFooterBase other)

protected
HeaderFooterBase(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public abstract HeaderFooterBase
copy()

Redeclares org.apache.poi.common.Duplicatable.copy.

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

protected final 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 final String
getText()

private int

Returns:

length of the footer string
getTextLength()

get the length of the footer string

public final 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 final void
setText(String
string to display
text)

set the footer string

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

Field Detail

field_2_hasMultibyteback to summary
private boolean field_2_hasMultibyte
field_3_textback to summary
private String field_3_text

Constructor Detail

HeaderFooterBaseback to summary
protected HeaderFooterBase(String text)
HeaderFooterBaseback to summary
protected HeaderFooterBase(HeaderFooterBase other)
HeaderFooterBaseback to summary
protected HeaderFooterBase(RecordInputStream in)

Method Detail

copyback to summary
public abstract HeaderFooterBase copy()

Redeclares org.apache.poi.common.Duplicatable.copy.

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

Returns:HeaderFooterBase

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

a deep copy of the implementing class / instance

Annotations
@Override
getDataSizeback to summary
protected final 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
getTextback to summary
public final String getText()
getTextLengthback to summary
private int getTextLength()

get the length of the footer string

Returns:int

length of the footer string

serializeback to summary
public final 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

setTextback to summary
public final void setText(String text)

set the footer string

Parameters
text:String

string to display