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

public final Class HSSFConditionalFormattingThreshold

extends Object
implements ConditionalFormattingThreshold
Class Inheritance
All Implemented Interfaces
org.apache.poi.ss.usermodel.ConditionalFormattingThreshold
Static Imports
org.apache.poi.hssf.record.CFRuleBase.parseFormula, org.apache.poi.hssf.usermodel.HSSFConditionalFormattingRule.toFormulaString
High level representation for Icon / Multi-State / Databar / Colour Scale change thresholds

Field Summary

Modifier and TypeField and Description
private final HSSFSheet
sheet

private final Threshold
threshold

private final HSSFWorkbook
workbook

Constructor Summary

AccessConstructor and Description
pack-priv
HSSFConditionalFormattingThreshold(Threshold threshold, HSSFSheet sheet)

Method Summary

Modifier and TypeMethod and Description
public String
getFormula()

Implements org.apache.poi.ss.usermodel.ConditionalFormattingThreshold.getFormula.

Formula to use to calculate the threshold, or null if no formula

public ConditionalFormattingThreshold.RangeType
getRangeType()

Implements org.apache.poi.ss.usermodel.ConditionalFormattingThreshold.getRangeType.

Get the Range Type used

pack-priv Threshold
getThreshold()

public Double
getValue()

Implements org.apache.poi.ss.usermodel.ConditionalFormattingThreshold.getValue.

Gets the value used for the threshold, or null if there isn't one.

public void
setFormula(String formula)

Implements org.apache.poi.ss.usermodel.ConditionalFormattingThreshold.setFormula.

Sets the formula used to calculate the threshold, or unsets it if null is given.

public void
setRangeType(ConditionalFormattingThreshold.RangeType type)

Implements org.apache.poi.ss.usermodel.ConditionalFormattingThreshold.setRangeType.

Changes the Range Type used

If you change the range type, you need to ensure that the Formula and Value parameters are compatible with it before saving

public void
setValue(Double value)

Implements org.apache.poi.ss.usermodel.ConditionalFormattingThreshold.setValue.

Sets the value used for the threshold.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

sheetback to summary
private final HSSFSheet sheet
thresholdback to summary
private final Threshold threshold
workbookback to summary
private final HSSFWorkbook workbook

Constructor Detail

HSSFConditionalFormattingThresholdback to summary
pack-priv HSSFConditionalFormattingThreshold(Threshold threshold, HSSFSheet sheet)

Method Detail

getFormulaback to summary
public String getFormula()

Implements org.apache.poi.ss.usermodel.ConditionalFormattingThreshold.getFormula.

Doc from org.apache.poi.ss.usermodel.ConditionalFormattingThreshold.getFormula.

Formula to use to calculate the threshold, or null if no formula

Annotations
@Override
getRangeTypeback to summary
public ConditionalFormattingThreshold.RangeType getRangeType()

Implements org.apache.poi.ss.usermodel.ConditionalFormattingThreshold.getRangeType.

Doc from org.apache.poi.ss.usermodel.ConditionalFormattingThreshold.getRangeType.

Get the Range Type used

Annotations
@Override
getThresholdback to summary
pack-priv Threshold getThreshold()
getValueback to summary
public Double getValue()

Implements org.apache.poi.ss.usermodel.ConditionalFormattingThreshold.getValue.

Doc from org.apache.poi.ss.usermodel.ConditionalFormattingThreshold.getValue.

Gets the value used for the threshold, or null if there isn't one.

Annotations
@Override
setFormulaback to summary
public void setFormula(String formula)

Implements org.apache.poi.ss.usermodel.ConditionalFormattingThreshold.setFormula.

Doc from org.apache.poi.ss.usermodel.ConditionalFormattingThreshold.setFormula.

Sets the formula used to calculate the threshold, or unsets it if null is given.

Annotations
@Override
setRangeTypeback to summary
public void setRangeType(ConditionalFormattingThreshold.RangeType type)

Implements org.apache.poi.ss.usermodel.ConditionalFormattingThreshold.setRangeType.

Doc from org.apache.poi.ss.usermodel.ConditionalFormattingThreshold.setRangeType.

Changes the Range Type used

If you change the range type, you need to ensure that the Formula and Value parameters are compatible with it before saving

Annotations
@Override
setValueback to summary
public void setValue(Double value)

Implements org.apache.poi.ss.usermodel.ConditionalFormattingThreshold.setValue.

Doc from org.apache.poi.ss.usermodel.ConditionalFormattingThreshold.setValue.

Sets the value used for the threshold.

If the type is RangeType#PERCENT or RangeType#PERCENTILE it must be between 0 and 100.

If the type is RangeType#MIN or RangeType#MAX or RangeType#FORMULA it shouldn't be set.

Use null to unset

Annotations
@Override