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

public final Class NumberFormatIndexRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.hssf.record.HSSFRecordTypes, .RecordInputStream, .StandardRecord, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput
The number format index record indexes format table. This applies to an axis.

Field Summary

Modifier and TypeField and Description
private short
field_1_formatIndex

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
NumberFormatIndexRecord()

public
NumberFormatIndexRecord(NumberFormatIndexRecord other)

public
NumberFormatIndexRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public NumberFormatIndexRecord
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 short
getFormatIndex()

Get the format index field for the NumberFormatIndex record.

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 short
getSid()

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

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

public 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 void
setFormatIndex(short field_1_formatIndex)

Set the format index field for the NumberFormatIndex record.

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

Field Detail

field_1_formatIndexback to summary
private short field_1_formatIndex
sidback to summary
public static final short sid

Constructor Detail

NumberFormatIndexRecordback to summary
public NumberFormatIndexRecord()
NumberFormatIndexRecordback to summary
public NumberFormatIndexRecord(NumberFormatIndexRecord other)
NumberFormatIndexRecordback to summary
public NumberFormatIndexRecord(RecordInputStream in)

Method Detail

copyback to summary
public NumberFormatIndexRecord copy()

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

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

Returns:NumberFormatIndexRecord

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.

getFormatIndexback to summary
public short getFormatIndex()

Get the format index field for the NumberFormatIndex record.

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
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

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

setFormatIndexback to summary
public void setFormatIndex(short field_1_formatIndex)

Set the format index field for the NumberFormatIndex record.