org.zkoss.poi.hssf.record

Class HeaderFooterRecord

java.lang.Object

org.zkoss.poi.hssf.record.RecordBase

org.zkoss.poi.hssf.record.Record

org.zkoss.poi.hssf.record.cont.ContinuableRecord

org.zkoss.poi.hssf.record.HeaderFooterRecord

public final class HeaderFooterRecord
extends ContinuableRecord

The HEADERFOOTER record stores information added in Office Excel 2007 for headers/footers. see [MS-XLS].pdf 2.4.137 HeaderFooter page 316

Author:

Yegor Kozlov

Field Summary

Fields

Modifier and Type	Field and Description
static short	sid

Constructor Summary

Constructors

Constructor and Description
HeaderFooterRecord()
HeaderFooterRecord(RecordInputStream in) construct a HeaderFooterRecord record.

Method Summary

Modifier and Type	Method and Description
Object	clone()
String	getFooterEven()
String	getFooterFirst()
byte[]	getGuid() If this header belongs to a specific sheet view , the sheet view?s GUID will be saved here.
String	getHeaderEven()
String	getHeaderFirst()
short	getSid() return the non static version of the id for this record.
boolean	isAlignMargins() Returns whether the left and right edges of the header and footer are lined up with the left and right margins of the sheet.
boolean	isCurrentSheet()
boolean	isDiffFirst() Returns whether the first page use a different header and footer.
boolean	isDiffOddEven() Returns whether the odd and even pages use a different header and footer
boolean	isScaleWithDoc() Returns whether the header and footer is scaled with the sheet.
protected void	serialize(ContinuableRecordOutput out) Serializes this record's content to the supplied data output. The standard BIFF header (ushort sid, ushort size) has been handled by the superclass, so only BIFF data should be written by this method.
void	setAlignMargins(boolean flag)
void	setDiffFirst(boolean flag) Sets whether the first page use a different header and footer.
void	setDiffOddEven(boolean flag) Set whether the odd and even pages use a different header and footer.
void	setFooterEven(String str)
void	setFooterFirst(String str)
void	setGuid(byte[] guid)
void	setHeaderEven(String str)
void	setHeaderFirst(String str)
void	setScaleWithDoc(boolean flag)
String	toString() get a string representation of the record (for biffview/debugging)

Methods inherited from class org.zkoss.poi.hssf.record.cont.ContinuableRecord

getRecordSize, serialize

Methods inherited from class org.zkoss.poi.hssf.record.Record

cloneViaReserialise, serialize

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

sid

public static final short sid

See Also:

Constant Field Values

Constructor Detail

HeaderFooterRecord

public HeaderFooterRecord()

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

getSid

public short getSid()

Description copied from class: Record

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

Specified by:

getSid in class 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

setGuid

public void setGuid(byte[] guid)

isCurrentSheet

public boolean isCurrentSheet()

Returns:

whether this record belongs to the current sheet

isDiffOddEven

public boolean isDiffOddEven()

Returns whether the odd and even pages use a different header and footer

setDiffOddEven

public void setDiffOddEven(boolean flag)

Set whether the odd and even pages use a different header and footer. It has the side effect which will clear HeaderEven and FooterEven string if set to false.

Parameters:

flag -

isDiffFirst

public boolean isDiffFirst()

Returns whether the first page use a different header and footer.

setDiffFirst

public void setDiffFirst(boolean flag)

Sets whether the first page use a different header and footer. It has the side effect which will clear HeaderFirst and FooterFirst string if set to false.

Parameters:

flag -

isScaleWithDoc

public boolean isScaleWithDoc()

Returns whether the header and footer is scaled with the sheet.

setScaleWithDoc

public void setScaleWithDoc(boolean flag)

isAlignMargins

public boolean isAlignMargins()

Returns whether the left and right edges of the header and footer are lined up with the left and right margins of the sheet.

setAlignMargins

public void setAlignMargins(boolean flag)

getHeaderEven

public String getHeaderEven()

setHeaderEven

public void setHeaderEven(String str)

getFooterEven

public String getFooterEven()

setFooterEven

public void setFooterEven(String str)

getHeaderFirst

public String getHeaderFirst()

setHeaderFirst

public void setHeaderFirst(String str)

getFooterFirst

public String getFooterFirst()

setFooterFirst

public void setFooterFirst(String str)

toString

public String toString()

Description copied from class: Record

get a string representation of the record (for biffview/debugging)

Overrides:

toString in class Record

clone

public Object clone()

Overrides:

clone in class Record

serialize

protected void serialize(ContinuableRecordOutput out)

Description copied from class: ContinuableRecord

Serializes this record's content to the supplied data output.
The standard BIFF header (ushort sid, ushort size) has been handled by the superclass, so only BIFF data should be written by this method. Simple data types can be written with the standard LittleEndianOutput methods. Methods from ContinuableRecordOutput can be used to serialize strings (with ContinueRecords being written as required). If necessary, implementors can explicitly start ContinueRecords (regardless of the amount of remaining space).

Specified by:

serialize in class ContinuableRecord

Parameters:

out - a data output stream