Package org.apache.poi.xssf.usermodel
Class XSSFConditionalFormatting
java.lang.Object
org.apache.poi.xssf.usermodel.XSSFConditionalFormatting
- All Implemented Interfaces:
ConditionalFormatting
- Author:
- Yegor Kozlov
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addRule
(ConditionalFormattingRule cfRule) Add a Conditional Formatting rule.int
getRule
(int idx) void
setFormattingRanges
(CellRangeAddress[] ranges) Sets the cell ranges the rule conditional formatting must be applied to.void
setRule
(int idx, ConditionalFormattingRule cfRule) Replaces an existing Conditional Formatting rule at position idx.toString()
-
Method Details
-
getFormattingRanges
- Specified by:
getFormattingRanges
in interfaceConditionalFormatting
- Returns:
- array of CellRangeAddresss. Never
null
-
setFormattingRanges
Description copied from interface:ConditionalFormatting
Sets the cell ranges the rule conditional formatting must be applied to.- Specified by:
setFormattingRanges
in interfaceConditionalFormatting
- Parameters:
ranges
- non-null array of CellRangeAddresss
-
setRule
Replaces an existing Conditional Formatting rule at position idx. Excel allows to create up to 3 Conditional Formatting rules. This method can be useful to modify existing Conditional Formatting rules.- Specified by:
setRule
in interfaceConditionalFormatting
- Parameters:
idx
- position of the rule. Should be between 0 and 2.cfRule
- - Conditional Formatting rule
-
addRule
Add a Conditional Formatting rule. Excel allows to create up to 3 Conditional Formatting rules.- Specified by:
addRule
in interfaceConditionalFormatting
- Parameters:
cfRule
- - Conditional Formatting rule
-
getRule
- Specified by:
getRule
in interfaceConditionalFormatting
- Returns:
- the Conditional Formatting rule at position idx.
-
getNumberOfRules
public int getNumberOfRules()- Specified by:
getNumberOfRules
in interfaceConditionalFormatting
- Returns:
- number of Conditional Formatting rules.
-
toString
-