Package org.apache.poi.hssf.record.chart
Class AreaFormatRecord
java.lang.Object
org.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.StandardRecord
org.apache.poi.hssf.record.chart.AreaFormatRecord
- All Implemented Interfaces:
Cloneable
The area format record is used to define the colours and patterns for an area.
- Author:
- Glen Stampoultzis (glens at apache.org)
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()shortGet the backcolor index field for the AreaFormat record.intGet the background color field for the AreaFormat record.protected intshortGet the forecolor index field for the AreaFormat record.intGet the foreground color field for the AreaFormat record.shortGet the format flags field for the AreaFormat record.shortGet the pattern field for the AreaFormat record.shortgetSid()return the non static version of the id for this record.booleanautomatic formattingbooleanisInvert()swap foreground and background colours when data is negativevoidWrite the data content of this BIFF record.voidsetAutomatic(boolean value) Sets the automatic field value.voidsetBackcolorIndex(short field_6_backcolorIndex) Set the backcolor index field for the AreaFormat record.voidsetBackgroundColor(int field_2_backgroundColor) Set the background color field for the AreaFormat record.voidsetForecolorIndex(short field_5_forecolorIndex) Set the forecolor index field for the AreaFormat record.voidsetForegroundColor(int field_1_foregroundColor) Set the foreground color field for the AreaFormat record.voidsetFormatFlags(short field_4_formatFlags) Set the format flags field for the AreaFormat record.voidsetInvert(boolean value) Sets the invert field value.voidsetPattern(short field_3_pattern) Set the pattern field for the AreaFormat record.toString()get a string representation of the record (for biffview/debugging)Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serializeMethods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
AreaFormatRecord
public AreaFormatRecord() -
AreaFormatRecord
-
-
Method Details
-
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
serialize
Description copied from class:StandardRecordWrite 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
RecordBase.getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).- Specified by:
serializein classStandardRecord- Parameters:
out- the output object
-
getDataSize
protected int getDataSize()- Specified by:
getDataSizein classStandardRecord
-
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record. -
clone
-
getForegroundColor
public int getForegroundColor()Get the foreground color field for the AreaFormat record. -
setForegroundColor
public void setForegroundColor(int field_1_foregroundColor) Set the foreground color field for the AreaFormat record. -
getBackgroundColor
public int getBackgroundColor()Get the background color field for the AreaFormat record. -
setBackgroundColor
public void setBackgroundColor(int field_2_backgroundColor) Set the background color field for the AreaFormat record. -
getPattern
public short getPattern()Get the pattern field for the AreaFormat record. -
setPattern
public void setPattern(short field_3_pattern) Set the pattern field for the AreaFormat record. -
getFormatFlags
public short getFormatFlags()Get the format flags field for the AreaFormat record. -
setFormatFlags
public void setFormatFlags(short field_4_formatFlags) Set the format flags field for the AreaFormat record. -
getForecolorIndex
public short getForecolorIndex()Get the forecolor index field for the AreaFormat record. -
setForecolorIndex
public void setForecolorIndex(short field_5_forecolorIndex) Set the forecolor index field for the AreaFormat record. -
getBackcolorIndex
public short getBackcolorIndex()Get the backcolor index field for the AreaFormat record. -
setBackcolorIndex
public void setBackcolorIndex(short field_6_backcolorIndex) Set the backcolor index field for the AreaFormat record. -
setAutomatic
public void setAutomatic(boolean value) Sets the automatic field value. automatic formatting -
isAutomatic
public boolean isAutomatic()automatic formatting- Returns:
- the automatic field value.
-
setInvert
public void setInvert(boolean value) Sets the invert field value. swap foreground and background colours when data is negative -
isInvert
public boolean isInvert()swap foreground and background colours when data is negative- Returns:
- the invert field value.
-