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

public final Class FtrHeader

extends Object
implements Duplicatable, GenericRecord
Class Inheritance
All Implemented Interfaces
org.apache.poi.common.usermodel.GenericRecord, org.apache.poi.common.Duplicatable
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.common.Duplicatable, org.apache.poi.common.usermodel.GenericRecord, org.apache.poi.hssf.record.RecordInputStream, org.apache.poi.ss.util.CellRangeAddress, org.apache.poi.util.GenericRecordJsonWriter, .GenericRecordUtil, .LittleEndianOutput
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.

Field Summary

Modifier and TypeField and Description
private CellRangeAddress
associatedRange

The range of cells the parent record applies to, or 0 if N/A

private short
grbitFrt

This is a FrtFlags

private short
recordType

This MUST match the type on the containing record

Constructor Summary

AccessConstructor and Description
public
FtrHeader()

public
FtrHeader(FtrHeader other)

public
FtrHeader(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public FtrHeader
copy()

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

public CellRangeAddress
getAssociatedRange()

public static int
getDataSize()

public Map<String, Supplier<?>>
getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public short
getGrbitFrt()

public short
getRecordType()

public void
serialize(LittleEndianOutput out)

public void
setAssociatedRange(CellRangeAddress associatedRange)

public void
setGrbitFrt(short grbitFrt)

public void
setRecordType(short recordType)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

associatedRangeback to summary
private CellRangeAddress associatedRange

The range of cells the parent record applies to, or 0 if N/A

grbitFrtback to summary
private short grbitFrt

This is a FrtFlags

recordTypeback to summary
private short recordType

This MUST match the type on the containing record

Constructor Detail

FtrHeaderback to summary
public FtrHeader()
FtrHeaderback to summary
public FtrHeader(FtrHeader other)
FtrHeaderback to summary
public FtrHeader(RecordInputStream in)

Method Detail

copyback to summary
public FtrHeader copy()

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

Returns:FtrHeader

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

a deep copy of the implementing class / instance

getAssociatedRangeback to summary
public CellRangeAddress getAssociatedRange()
getDataSizeback to summary
public static int getDataSize()
getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getGrbitFrtback to summary
public short getGrbitFrt()
getRecordTypeback to summary
public short getRecordType()
serializeback to summary
public void serialize(LittleEndianOutput out)
setAssociatedRangeback to summary
public void setAssociatedRange(CellRangeAddress associatedRange)
setGrbitFrtback to summary
public void setGrbitFrt(short grbitFrt)
setRecordTypeback to summary
public void setRecordType(short recordType)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object