Package org.apache.poi.ss.usermodel
Interface ConditionalFormattingThreshold
- 
- All Known Implementing Classes:
 HSSFConditionalFormattingThreshold,XSSFConditionalFormattingThreshold
public interface ConditionalFormattingThresholdThe Threshold / CFVO / Conditional Formatting Value Object.This defines how to calculate the ranges for a conditional formatting rule, eg which values get a Green Traffic Light icon and which Yellow or Red.
 
- 
- 
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classConditionalFormattingThreshold.RangeType 
- 
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringgetFormula()Formula to use to calculate the threshold, ornullif no formulaConditionalFormattingThreshold.RangeTypegetRangeType()Get the Range Type usedjava.lang.DoublegetValue()Gets the value used for the threshold, ornullif there isn't one.voidsetFormula(java.lang.String formula)Sets the formula used to calculate the threshold, or unsets it ifnullis given.voidsetRangeType(ConditionalFormattingThreshold.RangeType type)Changes the Range Type usedvoidsetValue(java.lang.Double value)Sets the value used for the threshold. 
 - 
 
- 
- 
Method Detail
- 
getRangeType
ConditionalFormattingThreshold.RangeType getRangeType()
Get the Range Type used 
- 
setRangeType
void setRangeType(ConditionalFormattingThreshold.RangeType type)
Changes the Range Type usedIf you change the range type, you need to ensure that the Formula and Value parameters are compatible with it before saving
 
- 
getFormula
java.lang.String getFormula()
Formula to use to calculate the threshold, ornullif no formula 
- 
setFormula
void setFormula(java.lang.String formula)
Sets the formula used to calculate the threshold, or unsets it ifnullis given. 
- 
getValue
java.lang.Double getValue()
Gets the value used for the threshold, ornullif there isn't one. 
- 
setValue
void setValue(java.lang.Double value)
Sets the value used for the threshold.If the type is
ConditionalFormattingThreshold.RangeType.PERCENTorConditionalFormattingThreshold.RangeType.PERCENTILEit must be between 0 and 100.If the type is
ConditionalFormattingThreshold.RangeType.MINorConditionalFormattingThreshold.RangeType.MAXorConditionalFormattingThreshold.RangeType.FORMULAit shouldn't be set.Use
nullto unset 
 - 
 
 -