Apache POI - Common 5.3.0 · org.apache.poi.hssf.record.chart.AreaFormatRecord

Modifier and Type	Field and Description
private static final BitField	automatic
private int	field_1_foregroundColor
private int	field_2_backgroundColor
private short	field_3_pattern
private short	field_4_formatFlags
private short	field_5_forecolorIndex
private short	field_6_backcolorIndex
private static final BitField	invert
public static final short	sid

Access	Constructor and Description
public	AreaFormatRecord()
public	AreaFormatRecord(RecordInputStream in)
public	AreaFormatRecord(AreaFormatRecord other)

Method Summary

Modifier and Type	Method and Description
public AreaFormatRecord	copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy.
public short	getBackcolorIndex() Get the backcolor index field for the AreaFormat record.
public int	getBackgroundColor() Get the background color field for the AreaFormat record.
protected int	getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.
public short	getForecolorIndex() Get the forecolor index field for the AreaFormat record.
public int	getForegroundColor() Get the foreground color field for the AreaFormat record.
public short	getFormatFlags() Get the format flags field for the AreaFormat 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	getPattern() Get the pattern field for the AreaFormat 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 automatic field value. isAutomatic() automatic formatting
public boolean	Returns: the invert field value. isInvert() swap foreground and background colours when data is negative
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	setAutomatic(boolean value) Sets the automatic field value.
public void	setBackcolorIndex(short field_6_backcolorIndex) Set the backcolor index field for the AreaFormat record.
public void	setBackgroundColor(int field_2_backgroundColor) Set the background color field for the AreaFormat record.
public void	setForecolorIndex(short field_5_forecolorIndex) Set the forecolor index field for the AreaFormat record.
public void	setForegroundColor(int field_1_foregroundColor) Set the foreground color field for the AreaFormat record.
public void	setFormatFlags(short field_4_formatFlags) Set the format flags field for the AreaFormat record.
public void	setInvert(boolean value) Sets the invert field value.
public void	setPattern(short field_3_pattern) Set the pattern field for the AreaFormat record.

Inherited from org.apache.poi.hssf.record.StandardRecord:: getRecordSize serialize

automatic	back to summary
private static final BitField automatic

field_1_foregroundColor	back to summary
private int field_1_foregroundColor

field_2_backgroundColor	back to summary
private int field_2_backgroundColor

field_3_pattern	back to summary
private short field_3_pattern

field_4_formatFlags	back to summary
private short field_4_formatFlags

field_5_forecolorIndex	back to summary
private short field_5_forecolorIndex

field_6_backcolorIndex	back to summary
private short field_6_backcolorIndex

invert	back to summary
private static final BitField invert

sid	back to summary
public static final short sid

AreaFormatRecord	back to summary
public AreaFormatRecord()

AreaFormatRecord	back to summary
public AreaFormatRecord(RecordInputStream in)

AreaFormatRecord	back to summary
public AreaFormatRecord(AreaFormatRecord other)

Method Detail

copy	back to summary
public AreaFormatRecord copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy. Returns:AreaFormatRecord Doc from org.apache.poi.common.Duplicatable.copy. a deep copy of the implementing class / instance Annotations @Override

copy

back to summary

public AreaFormatRecord copy()

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

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

Returns:AreaFormatRecord

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

a deep copy of the implementing class / instance

Annotations

@Override

getBackcolorIndex	back to summary
public short getBackcolorIndex() Get the backcolor index field for the AreaFormat record.

getBackgroundColor	back to summary
public int getBackgroundColor() Get the background color field for the AreaFormat record.

getDataSize	back to summary
protected int getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

getForecolorIndex	back to summary
public short getForecolorIndex() Get the forecolor index field for the AreaFormat record.

getForegroundColor	back to summary
public int getForegroundColor() Get the foreground color field for the AreaFormat record.

getFormatFlags	back to summary
public short getFormatFlags() Get the format flags field for the AreaFormat record.

getGenericProperties	back to summary
public Map<String, Supplier<?>> getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties. Annotations @Override

getGenericProperties

back to summary

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

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

Annotations

@Override

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

getGenericRecordType

back 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

getPattern	back to summary
public short getPattern() Get the pattern field for the AreaFormat record.

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

getSid

back 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

isAutomatic	back to summary
public boolean isAutomatic() automatic formatting Returns:boolean the automatic field value.

isAutomatic

back to summary

public boolean isAutomatic()

automatic formatting

Returns:boolean: the automatic field value.

isInvert	back to summary
public boolean isInvert() swap foreground and background colours when data is negative Returns:boolean the invert field value.

isInvert

back to summary

public boolean isInvert()

swap foreground and background colours when data is negative

Returns:boolean: the invert field value.

serialize back to summary

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

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

setAutomatic	back to summary
public void setAutomatic(boolean value) Sets the automatic field value. automatic formatting

setBackcolorIndex	back to summary
public void setBackcolorIndex(short field_6_backcolorIndex) Set the backcolor index field for the AreaFormat record.

setBackgroundColor	back to summary
public void setBackgroundColor(int field_2_backgroundColor) Set the background color field for the AreaFormat record.

setForecolorIndex	back to summary
public void setForecolorIndex(short field_5_forecolorIndex) Set the forecolor index field for the AreaFormat record.

setForegroundColor	back to summary
public void setForegroundColor(int field_1_foregroundColor) Set the foreground color field for the AreaFormat record.

setFormatFlags	back to summary
public void setFormatFlags(short field_4_formatFlags) Set the format flags field for the AreaFormat record.

setInvert	back to summary
public void setInvert(boolean value) Sets the invert field value. swap foreground and background colours when data is negative

setPattern	back to summary
public void setPattern(short field_3_pattern) Set the pattern field for the AreaFormat record.

public final Class AreaFormatRecord

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail