Package org.apache.poi.hssf.record.cf

Class ColorGradientFormatting

java.lang.Object

org.apache.poi.hssf.record.cf.ColorGradientFormatting

All Implemented Interfaces:

Duplicatable, GenericRecord

public final class ColorGradientFormatting
extends Object
implements Duplicatable, GenericRecord

Color Gradient / Color Scale Conditional Formatting Rule Record. (Called Color Gradient in the file format docs, but more commonly Color Scale in the UI)

Constructor Summary

Constructors

Constructor	Description
ColorGradientFormatting()
ColorGradientFormatting(ColorGradientFormatting other)
ColorGradientFormatting(LittleEndianInput in)

Method Summary

Modifier and Type	Method	Description
ColorGradientFormatting	copy()
ExtendedColor[]	getColors()
int	getDataLength()
Map<String,Supplier<?>>	getGenericProperties()
int	getNumControlPoints()
ColorGradientThreshold[]	getThresholds()
boolean	isAppliesToBackground()
boolean	isClampToCurve()
void	serialize(LittleEndianOutput out)
void	setColors(ExtendedColor[] colors)
void	setNumControlPoints(int num)
void	setThresholds(ColorGradientThreshold[] thresholds)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord

getGenericChildren, getGenericRecordType

Constructor Detail

ColorGradientFormatting

public ColorGradientFormatting()

ColorGradientFormatting

public ColorGradientFormatting(ColorGradientFormatting other)

ColorGradientFormatting

public ColorGradientFormatting(LittleEndianInput in)

Method Detail

getNumControlPoints

public int getNumControlPoints()

setNumControlPoints

public void setNumControlPoints(int num)

getThresholds

public ColorGradientThreshold[] getThresholds()

setThresholds

public void setThresholds(ColorGradientThreshold[] thresholds)

getColors

public ExtendedColor[] getColors()

setColors

public void setColors(ExtendedColor[] colors)

isClampToCurve

public boolean isClampToCurve()

isAppliesToBackground

public boolean isAppliesToBackground()

getGenericProperties

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

Specified by:

getGenericProperties in interface GenericRecord

toString

public String toString()

Overrides:

toString in class Object

copy

public ColorGradientFormatting copy()

Specified by:

copy in interface Duplicatable

Returns:

a deep copy of the implementing class / instance

getDataLength

public int getDataLength()

serialize

public void serialize(LittleEndianOutput out)