|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.poi.hssf.usermodel.HSSFConditionalFormattingRule
public final class HSSFConditionalFormattingRule
High level representation of Conditional Formatting Rule. It allows to specify formula based conditions for the Conditional Formatting and the formatting settings such as font, border and pattern.
| Field Summary |
|---|
| Fields inherited from interface org.apache.poi.ss.usermodel.ConditionalFormattingRule |
|---|
CONDITION_TYPE_CELL_VALUE_IS, CONDITION_TYPE_FORMULA |
| Method Summary | |
|---|---|
HSSFBorderFormatting |
createBorderFormatting()
create a new border formatting structure if it does not exist, otherwise just return existing object. |
HSSFFontFormatting |
createFontFormatting()
create a new font formatting structure if it does not exist, otherwise just return existing object. |
HSSFPatternFormatting |
createPatternFormatting()
create a new pattern formatting structure if it does not exist, otherwise just return existing object. |
HSSFBorderFormatting |
getBorderFormatting()
|
byte |
getComparisonOperation()
The comparison function used when the type of conditional formatting is set to ConditionalFormattingRule.CONDITION_TYPE_CELL_VALUE_IS |
byte |
getConditionType()
Type of conditional formatting rule. |
HSSFFontFormatting |
getFontFormatting()
|
java.lang.String |
getFormula1()
The formula used to evaluate the first operand for the conditional formatting rule. |
java.lang.String |
getFormula2()
The formula used to evaluate the second operand of the comparison when comparison type is ConditionalFormattingRule.CONDITION_TYPE_CELL_VALUE_IS and operator
is either ComparisonOperator.BETWEEN or ComparisonOperator.NOT_BETWEEN |
HSSFPatternFormatting |
getPatternFormatting()
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Method Detail |
|---|
public HSSFFontFormatting getFontFormatting()
getFontFormatting in interface ConditionalFormattingRulenull otherwisepublic HSSFFontFormatting createFontFormatting()
createFontFormatting in interface ConditionalFormattingRulenull.public HSSFBorderFormatting getBorderFormatting()
getBorderFormatting in interface ConditionalFormattingRulenull otherwisepublic HSSFBorderFormatting createBorderFormatting()
createBorderFormatting in interface ConditionalFormattingRulenull.public HSSFPatternFormatting getPatternFormatting()
getPatternFormatting in interface ConditionalFormattingRulenull otherwisepublic HSSFPatternFormatting createPatternFormatting()
createPatternFormatting in interface ConditionalFormattingRulenull.public byte getConditionType()
ConditionalFormattingRule
MUST be either ConditionalFormattingRule.CONDITION_TYPE_CELL_VALUE_IS or ConditionalFormattingRule.CONDITION_TYPE_FORMULA
getConditionType in interface ConditionalFormattingRulepublic byte getComparisonOperation()
ConditionalFormattingRuleConditionalFormattingRule.CONDITION_TYPE_CELL_VALUE_IS
MUST be a constant from ComparisonOperator
getComparisonOperation in interface ConditionalFormattingRulepublic java.lang.String getFormula1()
ConditionalFormattingRule
If the condition type is ConditionalFormattingRule.CONDITION_TYPE_CELL_VALUE_IS,
this field is the first operand of the comparison.
If type is ConditionalFormattingRule.CONDITION_TYPE_FORMULA, this formula is used
to determine if the conditional formatting is applied.
If comparison type is ConditionalFormattingRule.CONDITION_TYPE_FORMULA the formula MUST be a Boolean function
getFormula1 in interface ConditionalFormattingRulepublic java.lang.String getFormula2()
ConditionalFormattingRuleConditionalFormattingRule.CONDITION_TYPE_CELL_VALUE_IS and operator
is either ComparisonOperator.BETWEEN or ComparisonOperator.NOT_BETWEEN
getFormula2 in interface ConditionalFormattingRule
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||