Package org.apache.poi.hssf.usermodel
Class HSSFConditionalFormattingThreshold
java.lang.Object
org.apache.poi.hssf.usermodel.HSSFConditionalFormattingThreshold
- All Implemented Interfaces:
ConditionalFormattingThreshold
public final class HSSFConditionalFormattingThreshold
extends Object
implements ConditionalFormattingThreshold
High level representation for Icon / Multi-State / Databar /
Colour Scale change thresholds
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.poi.ss.usermodel.ConditionalFormattingThreshold
ConditionalFormattingThreshold.RangeType -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedHSSFConditionalFormattingThreshold(Threshold threshold, HSSFSheet sheet) -
Method Summary
Modifier and TypeMethodDescriptionFormula to use to calculate the threshold, ornullif no formulaGet the Range Type usedprotected ThresholdgetValue()Gets the value used for the threshold, ornullif there isn't one.voidsetFormula(String formula) Sets the formula used to calculate the threshold, or unsets it ifnullis given.voidChanges the Range Type usedvoidSets the value used for the threshold.
-
Constructor Details
-
HSSFConditionalFormattingThreshold
-
-
Method Details
-
getThreshold
-
getRangeType
Description copied from interface:ConditionalFormattingThresholdGet the Range Type used- Specified by:
getRangeTypein interfaceConditionalFormattingThreshold
-
setRangeType
Description copied from interface:ConditionalFormattingThresholdChanges 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
- Specified by:
setRangeTypein interfaceConditionalFormattingThreshold
-
getFormula
Description copied from interface:ConditionalFormattingThresholdFormula to use to calculate the threshold, ornullif no formula- Specified by:
getFormulain interfaceConditionalFormattingThreshold
-
setFormula
Description copied from interface:ConditionalFormattingThresholdSets the formula used to calculate the threshold, or unsets it ifnullis given.- Specified by:
setFormulain interfaceConditionalFormattingThreshold
-
getValue
Description copied from interface:ConditionalFormattingThresholdGets the value used for the threshold, ornullif there isn't one.- Specified by:
getValuein interfaceConditionalFormattingThreshold
-
setValue
Description copied from interface:ConditionalFormattingThresholdSets 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- Specified by:
setValuein interfaceConditionalFormattingThreshold
-