Class XSSFSheetConditionalFormatting
- All Implemented Interfaces:
SheetConditionalFormatting
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final StringOffice 2010 Conditional Formatting extensions namespace -
Method Summary
Modifier and TypeMethodDescriptionintAdds a copy of HSSFConditionalFormatting object to the sheetintaddConditionalFormatting(CellRangeAddress[] regions, ConditionalFormattingRule rule1) Add a new Conditional Formatting to the sheet.intaddConditionalFormatting(CellRangeAddress[] regions, ConditionalFormattingRule[] cfRules) Add a new Conditional Formatting set to the sheet.intaddConditionalFormatting(CellRangeAddress[] regions, ConditionalFormattingRule rule1, ConditionalFormattingRule rule2) Add a new Conditional Formatting consisting of two rules.Create a Color Scale / Color Gradient conditional formatting rule.createConditionalFormattingRule(byte comparisonOperation, String formula) Create a conditional formatting rule that compares a cell value to a formula calculated result, using an operator *createConditionalFormattingRule(byte comparisonOperation, String formula1, String formula2) A factory method allowing to create a conditional formatting rule with a cell comparison operatorcreateConditionalFormattingRule(String formula) A factory method allowing to create a conditional formatting rule with a formula.Create a Databar conditional formatting rule.A factory method allowing the creation of conditional formatting rules using an Icon Set / Multi-State formatting.Create a Databar conditional formatting rule.getConditionalFormattingAt(int index) gets Conditional Formatting object at a particular indexintvoidremoveConditionalFormatting(int index) removes a Conditional Formatting object by index
-
Field Details
-
CF_EXT_2009_NS_X14
Office 2010 Conditional Formatting extensions namespace- See Also:
-
-
Method Details
-
createConditionalFormattingRule
public XSSFConditionalFormattingRule createConditionalFormattingRule(byte comparisonOperation, String formula1, String formula2) A factory method allowing to create a conditional formatting rule with a cell comparison operatorTODO - formulas containing cell references are currently not parsed properly
- Specified by:
createConditionalFormattingRulein interfaceSheetConditionalFormatting- Parameters:
comparisonOperation- - a constant value fromCFRuleBase.ComparisonOperator:- BETWEEN
- NOT_BETWEEN
- EQUAL
- NOT_EQUAL
- GT
- LT
- GE
- LE
formula1- - formula for the valued, compared with the cellformula2- - second formula (only used withComparisonOperator.BETWEEN) andComparisonOperator.NOT_BETWEENoperations)
-
createConditionalFormattingRule
public XSSFConditionalFormattingRule createConditionalFormattingRule(byte comparisonOperation, String formula) Description copied from interface:SheetConditionalFormattingCreate a conditional formatting rule that compares a cell value to a formula calculated result, using an operator *The type of the created condition is
ConditionType.CELL_VALUE_IS- Specified by:
createConditionalFormattingRulein interfaceSheetConditionalFormatting- Parameters:
comparisonOperation- MUST be a constant value fromComparisonOperatorexcept BETWEEN and NOT_BETWEENformula- the formula to determine if the conditional formatting is applied
-
createConditionalFormattingRule
A factory method allowing to create a conditional formatting rule with a formula.- Specified by:
createConditionalFormattingRulein interfaceSheetConditionalFormatting- Parameters:
formula- - formula for the valued, compared with the cell
-
createConditionalFormattingRule
Create a Databar conditional formatting rule.The thresholds and colour for it will be created, but will be empty and require configuring with
XSSFConditionalFormattingRule.getDataBarFormatting()thenXSSFDataBarFormatting.getMinThreshold()andXSSFDataBarFormatting.getMaxThreshold() -
createConditionalFormattingRule
Description copied from interface:SheetConditionalFormattingCreate a Databar conditional formatting rule.The thresholds and colour for it will be created, but will be empty and require configuring with
ConditionalFormattingRule.getDataBarFormatting()thenDataBarFormatting.getMinThreshold()andDataBarFormatting.getMaxThreshold()- Specified by:
createConditionalFormattingRulein interfaceSheetConditionalFormatting
-
createConditionalFormattingRule
public XSSFConditionalFormattingRule createConditionalFormattingRule(IconMultiStateFormatting.IconSet iconSet) A factory method allowing the creation of conditional formatting rules using an Icon Set / Multi-State formatting. The thresholds for it will be created, but will be empty and require configuring withXSSFConditionalFormattingRule.getMultiStateFormatting()thenXSSFIconMultiStateFormatting.getThresholds()- Specified by:
createConditionalFormattingRulein interfaceSheetConditionalFormatting
-
createConditionalFormattingColorScaleRule
Create a Color Scale / Color Gradient conditional formatting rule.The thresholds and colours for it will be created, but will be empty and require configuring with
XSSFConditionalFormattingRule.getColorScaleFormatting()thenXSSFColorScaleFormatting.getThresholds()andXSSFColorScaleFormatting.getColors()- Specified by:
createConditionalFormattingColorScaleRulein interfaceSheetConditionalFormatting
-
addConditionalFormatting
public int addConditionalFormatting(CellRangeAddress[] regions, ConditionalFormattingRule[] cfRules) Description copied from interface:SheetConditionalFormattingAdd a new Conditional Formatting set to the sheet.- Specified by:
addConditionalFormattingin interfaceSheetConditionalFormatting- Parameters:
regions- - list of rectangular regions to apply conditional formatting rulescfRules- - set of up to conditional formatting rules (max 3 for Excel pre-2007)- Returns:
- index of the newly created Conditional Formatting object
-
addConditionalFormatting
Description copied from interface:SheetConditionalFormattingAdd a new Conditional Formatting to the sheet.- Specified by:
addConditionalFormattingin interfaceSheetConditionalFormatting- Parameters:
regions- - list of rectangular regions to apply conditional formatting rulesrule1- - the rule to apply- Returns:
- index of the newly created Conditional Formatting object
-
addConditionalFormatting
public int addConditionalFormatting(CellRangeAddress[] regions, ConditionalFormattingRule rule1, ConditionalFormattingRule rule2) Description copied from interface:SheetConditionalFormattingAdd a new Conditional Formatting consisting of two rules.- Specified by:
addConditionalFormattingin interfaceSheetConditionalFormatting- Parameters:
regions- - list of rectangular regions to apply conditional formatting rulesrule1- - the first rulerule2- - the second rule- Returns:
- index of the newly created Conditional Formatting object
-
addConditionalFormatting
Adds a copy of HSSFConditionalFormatting object to the sheetThis method could be used to copy HSSFConditionalFormatting object from one sheet to another. For example:
HSSFConditionalFormatting cf = sheet.getConditionalFormattingAt(index); newSheet.addConditionalFormatting(cf);
- Specified by:
addConditionalFormattingin interfaceSheetConditionalFormatting- Parameters:
cf- HSSFConditionalFormatting object- Returns:
- index of the new Conditional Formatting object
-
getConditionalFormattingAt
gets Conditional Formatting object at a particular index- Specified by:
getConditionalFormattingAtin interfaceSheetConditionalFormatting- Parameters:
index- of the Conditional Formatting object to fetch- Returns:
- Conditional Formatting object
-
getNumConditionalFormattings
public int getNumConditionalFormattings()- Specified by:
getNumConditionalFormattingsin interfaceSheetConditionalFormatting- Returns:
- number of Conditional Formatting objects of the sheet
-
removeConditionalFormatting
public void removeConditionalFormatting(int index) removes a Conditional Formatting object by index- Specified by:
removeConditionalFormattingin interfaceSheetConditionalFormatting- Parameters:
index- of a Conditional Formatting object to remove
-