public final class AboveOrBelowAverageCondition extends FormatCondition
Modifier and Type | Method and Description |
---|---|
FormatConditionType |
getConditionType()
Gets the
FormatConditionType.ABOVE_OR_BELOW_AVERAGE value. |
int |
getStandardDeviations()
Gets the number of standard deviations above or below average.
|
CellStyle |
getStyle()
Gets the actual formatting which will be applied to a cell if its value satisfies this
AboveOrBelowAverageCondition . |
boolean |
isBelow()
Gets a value indicating whether to format cells with values below average.
|
boolean |
isEqual()
Gets a value indicating whether to format cells with values equal to average.
|
void |
setBelow(boolean below)
Sets a value indicating whether to format cells with values below average.
|
void |
setEqual(boolean equal)
Sets a value indicating whether to format cells with values equal to average.
|
void |
setStandardDeviations(int standardDeviations)
Sets the number of standard deviations above or below average.
|
String |
toString()
Returns a
String that represents this AboveOrBelowAverageCondition instance. |
getRule
public FormatConditionType getConditionType()
FormatConditionType.ABOVE_OR_BELOW_AVERAGE
value.getConditionType
in class FormatCondition
FormatConditionType.ABOVE_OR_BELOW_AVERAGE
value.public int getStandardDeviations()
Gets the number of standard deviations above or below average.
Only cells with values above or below average ± (standard deviations) * std are formatted.
Default value is 0.
public CellStyle getStyle()
AboveOrBelowAverageCondition
.AboveOrBelowAverageCondition
.public boolean isBelow()
Gets a value indicating whether to format cells with values below average.
Default value is false
(formats cells with values above average).
true
to format cells with values below average; otherwise, false
.public boolean isEqual()
Gets a value indicating whether to format cells with values equal to average.
Default value is false
(formats cells with values exclusively above or below average).
true
to format cells with values equal to average; otherwise, false
.public void setBelow(boolean below)
Sets a value indicating whether to format cells with values below average.
Default value is false
(formats cells with values above average).
below
- true
to format cells with values below average; otherwise, false
.public void setEqual(boolean equal)
Sets a value indicating whether to format cells with values equal to average.
Default value is false
(formats cells with values exclusively above or below average).
equal
- true
to format cells with values equal to average; otherwise, false
.public void setStandardDeviations(int standardDeviations)
Sets the number of standard deviations above or below average.
Only cells with values above or below average ± (standard deviations)
* std are formatted.
Default value is 0.
standardDeviations
- The number of standard deviations above or below average.IndexOutOfBoundsException
- Value is less than zero.public String toString()
String
that represents this AboveOrBelowAverageCondition
instance.
This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).
toString
in class FormatCondition
String
that represents this AboveOrBelowAverageCondition
instance.© GemBox d.o.o. — All rights reserved.