org.apache.poi.hssf.record.common

Class FtrHeader

java.lang.Object

org.apache.poi.hssf.record.common.FtrHeader

All Implemented Interfaces:

Duplicatable, GenericRecord

public final class FtrHeader
extends java.lang.Object
implements Duplicatable, GenericRecord

Title: FtrHeader (Future Record Header) common record part

This record part specifies a header for a Ftr (Future) style record, which includes extra attributes above and beyond those of a traditional record.

Constructor Summary

Constructors

Constructor and Description
FtrHeader()
FtrHeader(FtrHeader other)
FtrHeader(RecordInputStream in)

Method Summary

Modifier and Type	Method and Description
FtrHeader	copy()
CellRangeAddress	getAssociatedRange()
static int	getDataSize()
java.util.Map<java.lang.String,java.util.function.Supplier<?>>	getGenericProperties()
short	getGrbitFrt()
short	getRecordType()
void	serialize(LittleEndianOutput out)
void	setAssociatedRange(CellRangeAddress associatedRange)
void	setGrbitFrt(short grbitFrt)
void	setRecordType(short recordType)
java.lang.String	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, getGenericRecordType

Constructor Detail

FtrHeader

public FtrHeader()

FtrHeader

public FtrHeader(FtrHeader other)

FtrHeader

public FtrHeader(RecordInputStream in)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

serialize

public void serialize(LittleEndianOutput out)

getDataSize

public static int getDataSize()

getRecordType

public short getRecordType()

setRecordType

public void setRecordType(short recordType)

getGrbitFrt

public short getGrbitFrt()

setGrbitFrt

public void setGrbitFrt(short grbitFrt)

getAssociatedRange

public CellRangeAddress getAssociatedRange()

setAssociatedRange

public void setAssociatedRange(CellRangeAddress associatedRange)

copy

public FtrHeader copy()

Specified by:

copy in interface Duplicatable

Returns:

a deep copy of the implementing class / instance

getGenericProperties

public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()

Specified by:

getGenericProperties in interface GenericRecord