public interface SConditionalFormattingRule
Modifier and Type | Interface and Description |
---|---|
static class |
SConditionalFormattingRule.RuleOperator |
static class |
SConditionalFormattingRule.RuleTimePeriod |
static class |
SConditionalFormattingRule.RuleType |
Modifier and Type | Method and Description |
---|---|
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)
|
SDataBar |
getDataBar()
Returns the data bar (used with "dataBar" type)
|
java.lang.String |
getEscapedFormula1() |
java.lang.String |
getEscapedFormula2() |
java.lang.String |
getEscapedFormula3() |
SExtraStyle |
getExtraStyle()
Returns the applied color if match
|
SConditionalFormatting |
getFormatting() |
java.lang.String |
getFormula1()
Returns the associated formulas (used with "cellIs" type)
|
java.lang.String |
getFormula2()
Returns the associated formulas (used with "cellIs" type)
|
java.lang.String |
getFormula3()
Returns the associated formulas (used with "cellIs" type)
|
java.util.List<java.lang.String> |
getFormulas()
Deprecated.
|
SIconSet |
getIconSet()
Returns the icon set (used with "iconSet" type)
|
SConditionalFormattingRule.RuleOperator |
getOperator()
Returns the comparison operator if needed
|
java.lang.Integer |
getPriority()
Returns the applying priority if covered region overlapped
|
java.lang.Long |
getRank()
Returns the rank used with "top10" type; rank is the 10 in top10, 6 in top6...
|
java.util.Collection<CellRegion> |
getRegions()
Get applied regions.
|
SSheet |
getSheet() |
java.lang.Integer |
getStandardDeviation()
Returns 1st/2nd/3rd standard deviation average (used with "aboveAverage" type; aka. stdDev
|
java.lang.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
|
void |
setEscapedFormulas(java.lang.String formula1,
java.lang.String formula2,
java.lang.String formula3) |
void |
setFormula1(java.lang.String formula1) |
void |
setFormula2(java.lang.String formula2) |
void |
setFormula3(java.lang.String formula3) |
void |
setFormulas(java.lang.String formula1,
java.lang.String formula2,
java.lang.String formula3) |
void |
shiftFormulas(int rowOff,
int colOff) |
SConditionalFormattingRule.RuleType getType()
SConditionalFormattingRule.RuleOperator getOperator()
java.lang.Integer getPriority()
SExtraStyle getExtraStyle()
boolean isStopIfTrue()
java.util.List<java.lang.String> getFormulas()
SConditionalFormattingRule.RuleTimePeriod getTimePeriod()
java.lang.Long getRank()
boolean isPercent()
boolean isBottom()
SColorScale getColorScale()
SDataBar getDataBar()
SIconSet getIconSet()
java.lang.String getText()
#getFormula
will return the formula for doing the search operation.boolean isAboveAverage()
boolean isEqualAverage()
java.lang.Integer getStandardDeviation()
void copyFrom(SConditionalFormattingRule src, int rowOff, int colOff)
src
- rowOff
- colOff
- void destroy()
java.util.Collection<CellRegion> getRegions()
boolean isFormulaParsingError()
java.lang.String getFormula1()
java.lang.String getFormula2()
java.lang.String getFormula3()
void setFormula1(java.lang.String formula1)
formula1
- void setFormula2(java.lang.String formula2)
formula2
- void setFormula3(java.lang.String formula3)
formula3
- void setFormulas(java.lang.String formula1, java.lang.String formula2, java.lang.String formula3)
formula1
- formula2
- formula3
- void setEscapedFormulas(java.lang.String formula1, java.lang.String formula2, java.lang.String formula3)
formula1
- formula2
- formula3
- java.lang.String getEscapedFormula1()
java.lang.String getEscapedFormula2()
java.lang.String getEscapedFormula3()
SSheet getSheet()
void clearFormulaResultCache()
SConditionalFormatting getFormatting()
void shiftFormulas(int rowOff, int colOff)
rowOff
- colOff
- Copyright © 2005-2010 Potix Corporation. All Rights Reserved.