Package io.keikai.model

Interface SConditionalFormattingRule

All Known Implementing Classes:
ConditionalFormattingRuleImpl
public interface SConditionalFormattingRule
Since:
3.8.2
Author:
henri

  • Method Details

    • getType

      SConditionalFormattingRule.RuleType getType()
      Returns type of this rule

    • getOperator

      SConditionalFormattingRule.RuleOperator getOperator()
      Returns the comparison operator if needed

    • getPriority

      Integer getPriority()
      Returns the applying priority if covered region overlapped

    • getExtraStyle

      SExtraStyle getExtraStyle()
      Returns the applied color if match

    • isStopIfTrue

      boolean isStopIfTrue()
      Returns whether stop if true

    • getTimePeriod

      SConditionalFormattingRule.RuleTimePeriod getTimePeriod()
      Returns the timePeriod operator (used with "timePeriod" type)

    • getRank

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

    • isPercent

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

    • isBottom

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

    • getColorScale

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

    • getDataBar

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

    • getIconSet

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

    • getText

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

    • isAboveAverage

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

    • isEqualAverage

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

    • getStandardDeviation

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

    • copyFrom

      void copyFrom(SConditionalFormattingRule src, int rowOff, int colOff)
      Copy state from the src rule with an row/column offset.
      Parameters:
      src -
      rowOff -
      colOff -
      Since:
      3.9.0

    • destroy

      void destroy()
      destroy this rule.
      Since:
      3.9.0

    • getRegions

      Collection<CellRegion> getRegions()
      Get applied regions.
      Returns:
      Since:
      3.9.0

    • isFormulaParsingError

      boolean isFormulaParsingError()
      Whether the formula parsed error
      Returns:
      Since:
      3.9.0

    • getFormula1

      String getFormula1()
      Returns the associated formulas (used with "cellIs" type)
      Since:
      3.9.0

    • getFormula2

      String getFormula2()
      Returns the associated formulas (used with "cellIs" type)
      Since:
      3.9.0

    • getFormula3

      String getFormula3()
      Returns the associated formulas (used with "cellIs" type)
      Returns:
      Since:
      3.9.0

    • setFormula1

      void setFormula1(String formula1)
      Parameters:
      formula1 -
      Since:
      3.9.0

    • setFormula2

      void setFormula2(String formula2)
      Parameters:
      formula2 -
      Since:
      3.9.0

    • setFormula3

      void setFormula3(String formula3)
      Parameters:
      formula3 -
      Since:
      3.9.0

    • setFormulas

      void setFormulas(String formula1, String formula2, String formula3)
      Parameters:
      formula1 -
      formula2 -
      formula3 -
      Since:
      3.9.0

    • setEscapedFormulas

      void setEscapedFormulas(String formula1, String formula2, String formula3)
      Parameters:
      formula1 -
      formula2 -
      formula3 -
      Since:
      3.9.0

    • getEscapedFormula1

      String getEscapedFormula1()
      Returns:
      Since:
      3.9.0

    • getEscapedFormula2

      String getEscapedFormula2()
      Returns:
      Since:
      3.9.0

    • getEscapedFormula3

      String getEscapedFormula3()
      Returns:
      Since:
      3.9.0

    • getSheet

      SSheet getSheet()
      Returns:
      Since:
      3.9.0

    • clearFormulaResultCache

      void clearFormulaResultCache()
      Since:
      3.9.0

    • getFormatting

      SConditionalFormatting getFormatting()
      Returns:
      Since:
      3.9.0

    • shiftFormulas

      void shiftFormulas(int rowOff, int colOff)
      Parameters:
      rowOff -
      colOff -
      Since:
      3.9.0

    • getId

      String getId()
      Returns the id (used when it is under ext)
      Since:
      5.8.1

    • setId

      void setId(String id)
      Set the id (used when it is under ext)
      Since:
      5.8.1

    • setExtId

      void setExtId(String extId)
      Set the ext id (used when it associates with a rule under ext)
      Since:
      5.9.0

    • getExtId

      String getExtId()
      Returns the ext id (used when it associates with a rule under ext)
      Since:
      5.9.0