Top Description Fields Constructors Methods
org.apache.poi.hssf.usermodel

public final Class HSSFColorScaleFormatting

extends Object
implements ColorScaleFormatting
Class Inheritance
All Implemented Interfaces
org.apache.poi.ss.usermodel.ColorScaleFormatting
Imports
org.apache.poi.hssf.record.CFRule12Record, org.apache.poi.hssf.record.cf.ColorGradientFormatting, .ColorGradientThreshold, .Threshold, org.apache.poi.hssf.record.common.ExtendedColor, org.apache.poi.ss.usermodel.Color, .ConditionalFormattingThreshold
High level representation for Color Scale / Color Gradient Formatting component of Conditional Formatting settings

Field Summary

Modifier and TypeField and Description
private final CFRule12Record
cfRule12Record

private final ColorGradientFormatting
colorFormatting

private final HSSFSheet
sheet

Constructor Summary

AccessConstructor and Description
protected
HSSFColorScaleFormatting(CFRule12Record cfRule12Record, HSSFSheet sheet)

Method Summary

Modifier and TypeMethod and Description
public HSSFConditionalFormattingThreshold
createThreshold()

Implements org.apache.poi.ss.usermodel.ColorScaleFormatting.createThreshold.

Creates a new, empty Threshold

public HSSFExtendedColor[]
getColors()

Implements org.apache.poi.ss.usermodel.ColorScaleFormatting.getColors.

Gets the list of colours that are interpolated between.

public int
getNumControlPoints()

Implements org.apache.poi.ss.usermodel.ColorScaleFormatting.getNumControlPoints.

How many control points should be used to map the colours?

public HSSFConditionalFormattingThreshold[]
getThresholds()

Implements org.apache.poi.ss.usermodel.ColorScaleFormatting.getThresholds.

Gets the list of thresholds

public void
setColors(Color[] colors)

Implements org.apache.poi.ss.usermodel.ColorScaleFormatting.setColors.

Sets the list of colours that are interpolated between.

public void
setNumControlPoints(int num)

Implements org.apache.poi.ss.usermodel.ColorScaleFormatting.setNumControlPoints.

Sets the number of control points to use to map the colours.

public void
setThresholds(ConditionalFormattingThreshold[] thresholds)

Implements org.apache.poi.ss.usermodel.ColorScaleFormatting.setThresholds.

Sets the of thresholds.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

cfRule12Recordback to summary
private final CFRule12Record cfRule12Record
colorFormattingback to summary
private final ColorGradientFormatting colorFormatting
sheetback to summary
private final HSSFSheet sheet

Constructor Detail

HSSFColorScaleFormattingback to summary
protected HSSFColorScaleFormatting(CFRule12Record cfRule12Record, HSSFSheet sheet)

Method Detail

createThresholdback to summary
public HSSFConditionalFormattingThreshold createThreshold()

Implements org.apache.poi.ss.usermodel.ColorScaleFormatting.createThreshold.

Doc from org.apache.poi.ss.usermodel.ColorScaleFormatting.createThreshold.

Creates a new, empty Threshold

getColorsback to summary
public HSSFExtendedColor[] getColors()

Implements org.apache.poi.ss.usermodel.ColorScaleFormatting.getColors.

Doc from org.apache.poi.ss.usermodel.ColorScaleFormatting.getColors.

Gets the list of colours that are interpolated between.

getNumControlPointsback to summary
public int getNumControlPoints()

Implements org.apache.poi.ss.usermodel.ColorScaleFormatting.getNumControlPoints.

Doc from org.apache.poi.ss.usermodel.ColorScaleFormatting.getNumControlPoints.

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

getThresholdsback to summary
public HSSFConditionalFormattingThreshold[] getThresholds()

Implements org.apache.poi.ss.usermodel.ColorScaleFormatting.getThresholds.

Doc from org.apache.poi.ss.usermodel.ColorScaleFormatting.getThresholds.

Gets the list of thresholds

setColorsback to summary
public void setColors(Color[] colors)

Implements org.apache.poi.ss.usermodel.ColorScaleFormatting.setColors.

Doc from org.apache.poi.ss.usermodel.ColorScaleFormatting.setColors.

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

setNumControlPointsback to summary
public void setNumControlPoints(int num)

Implements org.apache.poi.ss.usermodel.ColorScaleFormatting.setNumControlPoints.

Doc from org.apache.poi.ss.usermodel.ColorScaleFormatting.setNumControlPoints.

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

setThresholdsback to summary
public void setThresholds(ConditionalFormattingThreshold[] thresholds)

Implements org.apache.poi.ss.usermodel.ColorScaleFormatting.setThresholds.

Doc from org.apache.poi.ss.usermodel.ColorScaleFormatting.setThresholds.

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