Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate


com.aspose.cells
Class AboveAverage

java.lang.Object
  extended by com.aspose.cells.AboveAverage

public class AboveAverage
extends java.lang.Object

Describes the AboveAverage conditional formatting rule. This conditional formatting rule highlights cells that are above or below the average for all values in the range.


Constructor Summary
AboveAverage()
           
 
Method Summary
 int getStdDev()
          Gets the number of standard deviations to include above or below the average in the conditional formatting rule.
 boolean isAboveAverage()
          Gets the flag indicating whether the rule is an "above average" rule.
 boolean isEqualAverage()
          Gets the flag indicating whether the 'aboveAverage' and 'belowAverage' criteria is inclusive of the average itself, or exclusive of that value.
 void setAboveAverage(boolean b)
          Sets the flag indicating whether the rule is an "above average" rule.
 void setEqualAverage(boolean b)
          Sets the flag indicating whether the 'aboveAverage' and 'belowAverage' criteria is inclusive of the average itself, or exclusive of that value.
 void setStdDev(int value)
          Sets the number of standard deviations to include above or below the average in the conditional formatting rule.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AboveAverage

public AboveAverage()
Method Detail

isAboveAverage

public boolean isAboveAverage()
Gets the flag indicating whether the rule is an "above average" rule. Default value is true.


setAboveAverage

public void setAboveAverage(boolean b)
Sets the flag indicating whether the rule is an "above average" rule. Default value is true.

Parameters:
b - 'true' indicates 'above average'.

isEqualAverage

public boolean isEqualAverage()
Gets the flag indicating whether the 'aboveAverage' and 'belowAverage' criteria is inclusive of the average itself, or exclusive of that value. Default value is false.


setEqualAverage

public void setEqualAverage(boolean b)
Sets the flag indicating whether the 'aboveAverage' and 'belowAverage' criteria is inclusive of the average itself, or exclusive of that value. Default value is false.

Parameters:
b - 'true' indicates to include the average value in the criteria.

getStdDev

public int getStdDev()
Gets the number of standard deviations to include above or below the average in the conditional formatting rule. Default value is 0.


setStdDev

public void setStdDev(int value)
               throws java.lang.IllegalArgumentException
Sets the number of standard deviations to include above or below the average in the conditional formatting rule. Default value is 0.

Parameters:
value - must be between 0 and 3 (include 0 and 3), 0 means stdDev is not set.
Throws:
java.lang.IllegalArgumentException