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

public final Class DataFormatRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.hssf.record.HSSFRecordTypes, .RecordInputStream, .StandardRecord, org.apache.poi.util.BitField, .BitFieldFactory, .GenericRecordUtil, .LittleEndianOutput
The data format record is used to index into a series.

Field Summary

Modifier and TypeField and Description
private short
field_1_pointNumber

private short
field_2_seriesIndex

private short
field_3_seriesNumber

private short
field_4_formatFlags

public static final short
sid

private static final BitField
useExcel4Colors

Constructor Summary

AccessConstructor and Description
public
DataFormatRecord()

public
DataFormatRecord(DataFormatRecord other)

public
DataFormatRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public DataFormatRecord
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
getFormatFlags()

Get the format flags field for the DataFormat 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
getPointNumber()

Get the point number field for the DataFormat record.

public short
getSeriesIndex()

Get the series index field for the DataFormat record.

public short
getSeriesNumber()

Get the series number field for the DataFormat record.

public short
getSid()

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

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

public boolean

Returns:

the use excel 4 colors field value.
isUseExcel4Colors()

set true to use excel 4 colors.

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
setFormatFlags(short field_4_formatFlags)

Set the format flags field for the DataFormat record.

public void
setPointNumber(short field_1_pointNumber)

Set the point number field for the DataFormat record.

public void
setSeriesIndex(short field_2_seriesIndex)

Set the series index field for the DataFormat record.

public void
setSeriesNumber(short field_3_seriesNumber)

Set the series number field for the DataFormat record.

public void
setUseExcel4Colors(boolean value)

Sets the use excel 4 colors field value.

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

Field Detail

field_1_pointNumberback to summary
private short field_1_pointNumber
field_2_seriesIndexback to summary
private short field_2_seriesIndex
field_3_seriesNumberback to summary
private short field_3_seriesNumber
field_4_formatFlagsback to summary
private short field_4_formatFlags
sidback to summary
public static final short sid
useExcel4Colorsback to summary
private static final BitField useExcel4Colors

Constructor Detail

DataFormatRecordback to summary
public DataFormatRecord()
DataFormatRecordback to summary
public DataFormatRecord(DataFormatRecord other)
DataFormatRecordback to summary
public DataFormatRecord(RecordInputStream in)

Method Detail

copyback to summary
public DataFormatRecord copy()

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

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

Returns:DataFormatRecord

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.

getFormatFlagsback to summary
public short getFormatFlags()

Get the format flags field for the DataFormat 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
getPointNumberback to summary
public short getPointNumber()

Get the point number field for the DataFormat record.

getSeriesIndexback to summary
public short getSeriesIndex()

Get the series index field for the DataFormat record.

getSeriesNumberback to summary
public short getSeriesNumber()

Get the series number field for the DataFormat record.

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

isUseExcel4Colorsback to summary
public boolean isUseExcel4Colors()

set true to use excel 4 colors.

Returns:boolean

the use excel 4 colors field value.

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

setFormatFlagsback to summary
public void setFormatFlags(short field_4_formatFlags)

Set the format flags field for the DataFormat record.

setPointNumberback to summary
public void setPointNumber(short field_1_pointNumber)

Set the point number field for the DataFormat record.

setSeriesIndexback to summary
public void setSeriesIndex(short field_2_seriesIndex)

Set the series index field for the DataFormat record.

setSeriesNumberback to summary
public void setSeriesNumber(short field_3_seriesNumber)

Set the series number field for the DataFormat record.

setUseExcel4Colorsback to summary
public void setUseExcel4Colors(boolean value)

Sets the use excel 4 colors field value. set true to use excel 4 colors.