Package io.keikai.model.impl

Class ConditionalFormattingRuleImpl

java.lang.Object

io.keikai.model.impl.ConditionalFormattingRuleImpl

All Implemented Interfaces:

SConditionalFormattingRule, Serializable

public class ConditionalFormattingRuleImpl
extends Object
implements SConditionalFormattingRule, Serializable

Since:

3.8.2

Author:

henri

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface io.keikai.model.SConditionalFormattingRule

SConditionalFormattingRule.RuleOperator, SConditionalFormattingRule.RuleTimePeriod, SConditionalFormattingRule.RuleType

Constructor Summary

Constructors

Constructor	Description
ConditionalFormattingRuleImpl(SConditionalFormatting cfi)

Method Summary

Modifier and Type	Method	Description
void	addDependency(FormulaExpression fexpr)
void	clearFormulaResultCache()
void	copyFrom(SConditionalFormattingRule src, int rowOff, int colOff)	Copy state from the src rule with an row/column offset.
void	destroy()	destroy this rule.
SColorScale	getColorScale()	Returns the color scale (used with "colorScale" type)
SFill	getColorScaleFill(Double value0)
SDataBar	getDataBar()	Returns the data bar (used with "dataBar" type)
double	getDataBarPercent(Double value)
String	getEscapedFormula1()
String	getEscapedFormula2()
String	getEscapedFormula3()
String	getExtId()	Returns the ext id (used when it associates with a rule under ext)
SExtraStyle	getExtraStyle()	Returns the applied color if match
SConditionalFormatting	getFormatting()
String	getFormula1()	Returns the associated formulas (used with "cellIs" type)
String	getFormula2()	Returns the associated formulas (used with "cellIs" type)
String	getFormula3()	Returns the associated formulas (used with "cellIs" type)
FormulaExpression	getFormulaExpression1()
FormulaExpression	getFormulaExpression2()
FormulaExpression	getFormulaExpression3()
SIconSet	getIconSet()	Returns the icon set (used with "iconSet" type)
int	getIconSetId(Double value)
String	getId()	Returns the id (used when it is under ext)
SConditionalFormattingRule.RuleOperator	getOperator()	Returns the comparison operator if needed
Integer	getPriority()	Returns the applying priority if covered region overlapped
Long	getRank()	Returns the rank used with "top10" type; rank is the 10 in top10, 6 in top6...
Ref	getRef(String sheetName)
Collection<CellRegion>	getRegions()	Get applied regions.
RuleInfo	getRuleInfo1()
RuleInfo	getRuleInfo2()
SSheet	getSheet()
Integer	getStandardDeviation()	Returns 1st/2nd/3rd standard deviation average (used with "aboveAverage" type; aka. stdDev
String	getText()	Returns the text for comparison (used with "containsText" type).
SConditionalFormattingRule.RuleTimePeriod	getTimePeriod()	Returns the timePeriod operator (used with "timePeriod" type)
SConditionalFormattingRule.RuleType	getType()	Returns type of this rule
boolean	isAboveAverage()	Returns whether above average (used with "aboveAverage" type).
boolean	isBottom()	Returns whether bottom value (used with "top10" type).
boolean	isEqualAverage()	Returns whether equal average (used with "aboveAverage" type).
boolean	isFormulaParsingError()	Whether the formula parsed error
boolean	isPercent()	Returns whether a percentage (used with "top10" type)
boolean	isStopIfTrue()	Returns whether stop if true
boolean	isUnderExt()	Returns whether this ConditionalFormattingRule should be put under `<x14:conditionalFormattings><x14:conditionalFormatting>`
boolean	match(SCell cell)
FormulaExpression	parseFormula(String formula)
void	setAboveAverage(boolean b)
void	setBottom(boolean b)
void	setColorScale(SColorScale colorScale)
void	setDataBar(SDataBar dataBar)
void	setEqualAverage(boolean b)
void	setEscapedFormulas(String formula1, String formula2, String formula3)
void	setExtId(String extId)	Set the ext id (used when it associates with a rule under ext)
void	setExtraStyle(SExtraStyle style)
void	setFormula1(FormulaExpression formula1)
void	setFormula1(String formula1)
void	setFormula2(FormulaExpression formula2)
void	setFormula2(String formula2)
void	setFormula3(FormulaExpression formula3)
void	setFormula3(String formula3)
void	setFormulas(FormulaExpression fe1, FormulaExpression fe2, FormulaExpression fe3)
void	setFormulas(String formula1, String formula2, String formula3)
void	setIconSet(SIconSet iconSet)
void	setId(String id)	Set the id (used when it is under ext)
void	setOperator(SConditionalFormattingRule.RuleOperator operator)
void	setPercent(boolean b)
void	setPriority(int priority)
void	setRank(long rank)
void	setStandardDeviation(int s)
void	setStopIfTrue(boolean b)
void	setText(String text)
void	setTimePeriod(SConditionalFormattingRule.RuleTimePeriod timePeriod)
void	setType(SConditionalFormattingRule.RuleType type)
void	setUnderExt(boolean b)	Returns whether this ConditionalFormattingRule should be put under `<x14:conditionalFormattings><x14:conditionalFormatting>`
void	shiftFormulas(int rowOff, int colOff)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ConditionalFormattingRuleImpl

public ConditionalFormattingRuleImpl(SConditionalFormatting cfi)

Method Details

getFormatting

public SConditionalFormatting getFormatting()

Specified by:

getFormatting in interface SConditionalFormattingRule

Returns:

getSheet

public SSheet getSheet()

Specified by:

getSheet in interface SConditionalFormattingRule

Returns:

clearFormulaResultCache

public void clearFormulaResultCache()

Specified by:

clearFormulaResultCache in interface SConditionalFormattingRule

getType

public SConditionalFormattingRule.RuleType getType()

Description copied from interface: SConditionalFormattingRule

Returns type of this rule

Specified by:

getType in interface SConditionalFormattingRule

setType

public void setType(SConditionalFormattingRule.RuleType type)

getOperator

public SConditionalFormattingRule.RuleOperator getOperator()

Description copied from interface: SConditionalFormattingRule

Returns the comparison operator if needed

Specified by:

getOperator in interface SConditionalFormattingRule

setOperator

public void setOperator(SConditionalFormattingRule.RuleOperator operator)

getPriority

public Integer getPriority()

Description copied from interface: SConditionalFormattingRule

Returns the applying priority if covered region overlapped

Specified by:

getPriority in interface SConditionalFormattingRule

setPriority

public void setPriority(int priority)

getExtraStyle

public SExtraStyle getExtraStyle()

Description copied from interface: SConditionalFormattingRule

Returns the applied color if match

Specified by:

getExtraStyle in interface SConditionalFormattingRule

setExtraStyle

public void setExtraStyle(SExtraStyle style)

isStopIfTrue

public boolean isStopIfTrue()

Description copied from interface: SConditionalFormattingRule

Returns whether stop if true

Specified by:

isStopIfTrue in interface SConditionalFormattingRule

setStopIfTrue

public void setStopIfTrue(boolean b)

getTimePeriod

public SConditionalFormattingRule.RuleTimePeriod getTimePeriod()

Description copied from interface: SConditionalFormattingRule

Returns the timePeriod operator (used with "timePeriod" type)

Specified by:

getTimePeriod in interface SConditionalFormattingRule

setTimePeriod

public void setTimePeriod(SConditionalFormattingRule.RuleTimePeriod timePeriod)

getRank

public Long getRank()

Description copied from interface: SConditionalFormattingRule

Returns the rank used with "top10" type; rank is the 10 in top10, 6 in top6...

Specified by:

getRank in interface SConditionalFormattingRule

setRank

public void setRank(long rank)

isPercent

public boolean isPercent()

Description copied from interface: SConditionalFormattingRule

Returns whether a percentage (used with "top10" type)

Specified by:

isPercent in interface SConditionalFormattingRule

setPercent

public void setPercent(boolean b)

isBottom

public boolean isBottom()

Description copied from interface: SConditionalFormattingRule

Returns whether bottom value (used with "top10" type). false means check "above 10 ..."; true means check "below 10 ...".

Specified by:

isBottom in interface SConditionalFormattingRule

setBottom

public void setBottom(boolean b)

getColorScale

public SColorScale getColorScale()

Description copied from interface: SConditionalFormattingRule

Returns the color scale (used with "colorScale" type)

Specified by:

getColorScale in interface SConditionalFormattingRule

setColorScale

public void setColorScale(SColorScale colorScale)

getDataBar

public SDataBar getDataBar()

Description copied from interface: SConditionalFormattingRule

Returns the data bar (used with "dataBar" type)

Specified by:

getDataBar in interface SConditionalFormattingRule

setDataBar

public void setDataBar(SDataBar dataBar)

getIconSet

public SIconSet getIconSet()

Description copied from interface: SConditionalFormattingRule

Returns the icon set (used with "iconSet" type)

Specified by:

getIconSet in interface SConditionalFormattingRule

setIconSet

public void setIconSet(SIconSet iconSet)

getText

public String getText()

Description copied from interface: SConditionalFormattingRule

Returns the text for comparison (used with "containsText" type). #getFormula will return the formula for doing the search operation.

Specified by:

getText in interface SConditionalFormattingRule

setText

public void setText(String text)

isAboveAverage

public boolean isAboveAverage()

Description copied from interface: SConditionalFormattingRule

Returns whether above average (used with "aboveAverage" type). false means "check below average ..."; true means "check above average ..." (default true)

Specified by:

isAboveAverage in interface SConditionalFormattingRule

setAboveAverage

public void setAboveAverage(boolean b)

isEqualAverage

public boolean isEqualAverage()

Description copied from interface: SConditionalFormattingRule

Returns whether equal average (used with "aboveAverage" type).

Specified by:

isEqualAverage in interface SConditionalFormattingRule

setEqualAverage

public void setEqualAverage(boolean b)

getStandardDeviation

public Integer getStandardDeviation()

Description copied from interface: SConditionalFormattingRule

Returns 1st/2nd/3rd standard deviation average (used with "aboveAverage" type; aka. stdDev

Specified by:

getStandardDeviation in interface SConditionalFormattingRule

setStandardDeviation

public void setStandardDeviation(int s)

match

public boolean match(SCell cell)

destroy

public void destroy()

Description copied from interface: SConditionalFormattingRule

destroy this rule.

Specified by:

destroy in interface SConditionalFormattingRule

getRegions

public Collection<CellRegion> getRegions()

Description copied from interface: SConditionalFormattingRule

Get applied regions.

Specified by:

getRegions in interface SConditionalFormattingRule

Returns:

isFormulaParsingError

public boolean isFormulaParsingError()

Description copied from interface: SConditionalFormattingRule

Whether the formula parsed error

Specified by:

isFormulaParsingError in interface SConditionalFormattingRule

Returns:

getFormula1

public String getFormula1()

Description copied from interface: SConditionalFormattingRule

Returns the associated formulas (used with "cellIs" type)

Specified by:

getFormula1 in interface SConditionalFormattingRule

getFormula2

public String getFormula2()

Description copied from interface: SConditionalFormattingRule

Returns the associated formulas (used with "cellIs" type)

Specified by:

getFormula2 in interface SConditionalFormattingRule

getFormula3

public String getFormula3()

Description copied from interface: SConditionalFormattingRule

Returns the associated formulas (used with "cellIs" type)

Specified by:

getFormula3 in interface SConditionalFormattingRule

Returns:

getRef

public Ref getRef(String sheetName)

setFormula1

public void setFormula1(String formula1)

Specified by:

setFormula1 in interface SConditionalFormattingRule

setFormula2

public void setFormula2(String formula2)

Specified by:

setFormula2 in interface SConditionalFormattingRule

setFormula3

public void setFormula3(String formula3)

Specified by:

setFormula3 in interface SConditionalFormattingRule

parseFormula

public FormulaExpression parseFormula(String formula)

setFormulas

public void setFormulas(String formula1,
 String formula2,
 String formula3)

Specified by:

setFormulas in interface SConditionalFormattingRule

setEscapedFormulas

public void setEscapedFormulas(String formula1,
 String formula2,
 String formula3)

Specified by:

setEscapedFormulas in interface SConditionalFormattingRule

copyFrom

public void copyFrom(SConditionalFormattingRule src,
 int rowOff,
 int colOff)

Description copied from interface: SConditionalFormattingRule

Copy state from the src rule with an row/column offset.

Specified by:

copyFrom in interface SConditionalFormattingRule

setFormulas

public void setFormulas(FormulaExpression fe1,
 FormulaExpression fe2,
 FormulaExpression fe3)

Parameters:

fe1 -

fe2 -

Since:

3.9.0

getFormulaExpression1

public FormulaExpression getFormulaExpression1()

Returns:

Since:

3.9.0

getFormulaExpression2

public FormulaExpression getFormulaExpression2()

Returns:

Since:

3.9.0

getFormulaExpression3

public FormulaExpression getFormulaExpression3()

Returns:

Since:

3.9.0

setFormula1

public void setFormula1(FormulaExpression formula1)

Parameters:

formula1 -

Since:

3.9.0

setFormula2

public void setFormula2(FormulaExpression formula2)

Parameters:

formula2 -

Since:

3.9.0

setFormula3

public void setFormula3(FormulaExpression formula3)

Parameters:

formula3 -

Since:

3.9.0

getEscapedFormula1

public String getEscapedFormula1()

Specified by:

getEscapedFormula1 in interface SConditionalFormattingRule

Returns:

getEscapedFormula2

public String getEscapedFormula2()

Specified by:

getEscapedFormula2 in interface SConditionalFormattingRule

Returns:

getEscapedFormula3

public String getEscapedFormula3()

Specified by:

getEscapedFormula3 in interface SConditionalFormattingRule

Returns:

getColorScaleFill

public SFill getColorScaleFill(Double value0)

getDataBarPercent

public double getDataBarPercent(Double value)

getIconSetId

public int getIconSetId(Double value)

shiftFormulas

public void shiftFormulas(int rowOff,
 int colOff)

Specified by:

shiftFormulas in interface SConditionalFormattingRule

addDependency

public void addDependency(FormulaExpression fexpr)

getRuleInfo1

public RuleInfo getRuleInfo1()

getRuleInfo2

public RuleInfo getRuleInfo2()

isUnderExt

public boolean isUnderExt()

Returns whether this ConditionalFormattingRule should be put under `<x14:conditionalFormattings><x14:conditionalFormatting>`

Since:

5.7.0

setUnderExt

public void setUnderExt(boolean b)

Returns whether this ConditionalFormattingRule should be put under `<x14:conditionalFormattings><x14:conditionalFormatting>`

Since:

5.7.0

getId

public String getId()

Description copied from interface: SConditionalFormattingRule

Returns the id (used when it is under ext)

Specified by:

getId in interface SConditionalFormattingRule

setId

public void setId(String id)

Description copied from interface: SConditionalFormattingRule

Set the id (used when it is under ext)

Specified by:

setId in interface SConditionalFormattingRule

getExtId

public String getExtId()

Description copied from interface: SConditionalFormattingRule

Returns the ext id (used when it associates with a rule under ext)

Specified by:

getExtId in interface SConditionalFormattingRule

setExtId

public void setExtId(String extId)

Description copied from interface: SConditionalFormattingRule

Set the ext id (used when it associates with a rule under ext)

Specified by:

setExtId in interface SConditionalFormattingRule