Package org.apache.poi.xssf.usermodel
Class XSSFConditionalFormattingThreshold
java.lang.Object
org.apache.poi.xssf.usermodel.XSSFConditionalFormattingThreshold
- All Implemented Interfaces:
ConditionalFormattingThreshold
public class XSSFConditionalFormattingThreshold
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
ConstructorsModifierConstructorDescriptionprotected
XSSFConditionalFormattingThreshold
(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCfvo cfvo) -
Method Summary
Modifier and TypeMethodDescriptionprotected org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCfvo
Formula to use to calculate the threshold, ornull
if no formulaGet the Range Type usedgetValue()
Gets the value used for the threshold, ornull
if there isn't one.void
setFormula
(String formula) Sets the formula used to calculate the threshold, or unsets it ifnull
is given.void
Changes the Range Type usedvoid
Sets the value used for the threshold.
-
Constructor Details
-
XSSFConditionalFormattingThreshold
protected XSSFConditionalFormattingThreshold(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCfvo cfvo)
-
-
Method Details
-
getCTCfvo
protected org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCfvo getCTCfvo() -
getRangeType
Description copied from interface:ConditionalFormattingThreshold
Get the Range Type used- Specified by:
getRangeType
in interfaceConditionalFormattingThreshold
-
setRangeType
Description copied from interface:ConditionalFormattingThreshold
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
- Specified by:
setRangeType
in interfaceConditionalFormattingThreshold
-
getFormula
Description copied from interface:ConditionalFormattingThreshold
Formula to use to calculate the threshold, ornull
if no formula- Specified by:
getFormula
in interfaceConditionalFormattingThreshold
-
setFormula
Description copied from interface:ConditionalFormattingThreshold
Sets the formula used to calculate the threshold, or unsets it ifnull
is given.- Specified by:
setFormula
in interfaceConditionalFormattingThreshold
-
getValue
Description copied from interface:ConditionalFormattingThreshold
Gets the value used for the threshold, ornull
if there isn't one.- Specified by:
getValue
in interfaceConditionalFormattingThreshold
-
setValue
Description copied from interface:ConditionalFormattingThreshold
Sets the value used for the threshold.If the type is
ConditionalFormattingThreshold.RangeType.PERCENT
orConditionalFormattingThreshold.RangeType.PERCENTILE
it must be between 0 and 100.If the type is
ConditionalFormattingThreshold.RangeType.MIN
orConditionalFormattingThreshold.RangeType.MAX
orConditionalFormattingThreshold.RangeType.FORMULA
it shouldn't be set.Use
null
to unset- Specified by:
setValue
in interfaceConditionalFormattingThreshold
-