|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.ss.formula.EvaluationConditionalFormatRule
public class EvaluationConditionalFormatRule
Abstracted and cached version of a Conditional Format rule for use with a
ConditionalFormattingEvaluator
. This references a rule, its owning
ConditionalFormatting
, its priority order (lower index = higher priority in Excel),
and the information needed to evaluate the rule for a given cell.
Nested Class Summary | |
---|---|
static class |
EvaluationConditionalFormatRule.OperatorEnum
Not calling it OperatorType to avoid confusion for now with other classes. |
protected class |
EvaluationConditionalFormatRule.ValueAndFormat
Note: this class has a natural ordering that is inconsistent with equals. |
protected static interface |
EvaluationConditionalFormatRule.ValueFunction
instances evaluate the values for a region and return the positive matches for the function type. |
Constructor Summary | |
---|---|
EvaluationConditionalFormatRule(WorkbookEvaluator workbookEvaluator,
Sheet sheet,
ConditionalFormatting formatting,
int formattingIndex,
ConditionalFormattingRule rule,
int ruleIndex,
CellRangeAddress[] regions)
|
Method Summary | |
---|---|
int |
compareTo(EvaluationConditionalFormatRule o)
Per Excel Help, XSSF rule priority is sheet-wide, not just within the owning ConditionalFormatting object. |
boolean |
equals(java.lang.Object obj)
Defined as equal sheet name and formatting and rule indexes |
ConditionalFormatting |
getFormatting()
|
int |
getFormattingIndex()
|
java.lang.String |
getFormula1()
|
java.lang.String |
getFormula2()
|
EvaluationConditionalFormatRule.OperatorEnum |
getOperator()
|
int |
getPriority()
|
CellRangeAddress[] |
getRegions()
|
ConditionalFormattingRule |
getRule()
|
int |
getRuleIndex()
|
Sheet |
getSheet()
|
ConditionType |
getType()
|
int |
hashCode()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public EvaluationConditionalFormatRule(WorkbookEvaluator workbookEvaluator, Sheet sheet, ConditionalFormatting formatting, int formattingIndex, ConditionalFormattingRule rule, int ruleIndex, CellRangeAddress[] regions)
workbookEvaluator
- sheet
- formatting
- formattingIndex
- for priority, zero basedrule
- ruleIndex
- for priority, zero based, if this is an HSSF rule. Unused for XSSF rulesregions
- could be read from formatting, but every call creates new objects in a new array.
this allows calling it once per formatting instance, and re-using the array.Method Detail |
---|
public Sheet getSheet()
public ConditionalFormatting getFormatting()
public int getFormattingIndex()
public ConditionalFormattingRule getRule()
public int getRuleIndex()
public CellRangeAddress[] getRegions()
public int getPriority()
public java.lang.String getFormula1()
public java.lang.String getFormula2()
public EvaluationConditionalFormatRule.OperatorEnum getOperator()
public ConditionType getType()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Object.equals(java.lang.Object)
public int compareTo(EvaluationConditionalFormatRule o)
compareTo
in interface java.lang.Comparable<EvaluationConditionalFormatRule>
o
-
public int hashCode()
hashCode
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |