org.apache.poi.hssf.usermodel

Class HSSFColorScaleFormatting

java.lang.Object

org.apache.poi.hssf.usermodel.HSSFColorScaleFormatting

All Implemented Interfaces:

ColorScaleFormatting

public final class HSSFColorScaleFormatting
extends java.lang.Object
implements ColorScaleFormatting

High level representation for Color Scale / Color Gradient Formatting component of Conditional Formatting settings

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HSSFColorScaleFormatting(CFRule12Record cfRule12Record, HSSFSheet sheet)

Method Summary

Modifier and Type	Method and Description
HSSFConditionalFormattingThreshold	createThreshold() Creates a new, empty Threshold
HSSFExtendedColor[]	getColors() Gets the list of colours that are interpolated between.
int	getNumControlPoints() How many control points should be used to map the colours? Normally 2 or 3
HSSFConditionalFormattingThreshold[]	getThresholds() Gets the list of thresholds
void	setColors(Color[] colors) Sets the list of colours that are interpolated between.
void	setNumControlPoints(int num) Sets the number of control points to use to map the colours.
void	setThresholds(ConditionalFormattingThreshold[] thresholds) Sets the of thresholds.

Methods inherited from class java.lang.Object

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

Constructor Detail

HSSFColorScaleFormatting

protected HSSFColorScaleFormatting(CFRule12Record cfRule12Record,
                                   HSSFSheet sheet)

Method Detail

getNumControlPoints

public int getNumControlPoints()

Description copied from interface: ColorScaleFormatting

How many control points should be used to map the colours? Normally 2 or 3

Specified by:

getNumControlPoints in interface ColorScaleFormatting

setNumControlPoints

public void setNumControlPoints(int num)

Description copied from interface: ColorScaleFormatting

Sets the number of control points to use to map the colours. Should normally be 2 or 3.

After updating, you need to ensure that the Threshold count and Color count match

Specified by:

setNumControlPoints in interface ColorScaleFormatting

getColors

public HSSFExtendedColor[] getColors()

Description copied from interface: ColorScaleFormatting

Gets the list of colours that are interpolated between.

Specified by:

getColors in interface ColorScaleFormatting

setColors

public void setColors(Color[] colors)

Description copied from interface: ColorScaleFormatting

Sets the list of colours that are interpolated between. The number must match ColorScaleFormatting.getNumControlPoints()

Specified by:

setColors in interface ColorScaleFormatting

getThresholds

public HSSFConditionalFormattingThreshold[] getThresholds()

Description copied from interface: ColorScaleFormatting

Gets the list of thresholds

Specified by:

getThresholds in interface ColorScaleFormatting

setThresholds

public void setThresholds(ConditionalFormattingThreshold[] thresholds)

Description copied from interface: ColorScaleFormatting

Sets the of thresholds. The number must match ColorScaleFormatting.getNumControlPoints()

Specified by:

setThresholds in interface ColorScaleFormatting

createThreshold

public HSSFConditionalFormattingThreshold createThreshold()

Description copied from interface: ColorScaleFormatting

Creates a new, empty Threshold

Specified by:

createThreshold in interface ColorScaleFormatting