org.apache.poi.xssf.usermodel

Class XSSFSheetConditionalFormatting

java.lang.Object

org.apache.poi.xssf.usermodel.XSSFSheetConditionalFormatting

All Implemented Interfaces:

SheetConditionalFormatting

public class XSSFSheetConditionalFormatting
extends Object
implements SheetConditionalFormatting

Author:

Yegor Kozlov

Method Summary

Methods

Modifier and Type	Method and Description
int	addConditionalFormatting(CellRangeAddress[] regions, ConditionalFormattingRule rule1)
int	addConditionalFormatting(CellRangeAddress[] regions, ConditionalFormattingRule[] cfRules)
int	addConditionalFormatting(CellRangeAddress[] regions, ConditionalFormattingRule rule1, ConditionalFormattingRule rule2)
int	addConditionalFormatting(ConditionalFormatting cf) Adds a copy of HSSFConditionalFormatting object to the sheet
XSSFConditionalFormattingRule	createConditionalFormattingRule(byte comparisonOperation, String formula)
XSSFConditionalFormattingRule	createConditionalFormattingRule(byte comparisonOperation, String formula1, String formula2) A factory method allowing to create a conditional formatting rule with a cell comparison operator TODO - formulas containing cell references are currently not parsed properly
XSSFConditionalFormattingRule	createConditionalFormattingRule(String formula) A factory method allowing to create a conditional formatting rule with a formula.
XSSFConditionalFormatting	getConditionalFormattingAt(int index) gets Conditional Formatting object at a particular index
int	getNumConditionalFormattings()
void	removeConditionalFormatting(int index) removes a Conditional Formatting object by index

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createConditionalFormattingRule

public XSSFConditionalFormattingRule createConditionalFormattingRule(byte comparisonOperation,
                                                            String formula1,
                                                            String formula2)

A factory method allowing to create a conditional formatting rule with a cell comparison operator

TODO - formulas containing cell references are currently not parsed properly

Specified by:

createConditionalFormattingRule in interface SheetConditionalFormatting

Parameters:

comparisonOperation - - a constant value from CFRuleRecord.ComparisonOperator:

• BETWEEN
• NOT_BETWEEN
• EQUAL
• NOT_EQUAL
• GT
• LT
• GE
• LE

formula1 - - formula for the valued, compared with the cell

formula2 - - second formula (only used with ComparisonOperator.BETWEEN) and ComparisonOperator.NOT_BETWEEN operations)

createConditionalFormattingRule

public XSSFConditionalFormattingRule createConditionalFormattingRule(byte comparisonOperation,
                                                            String formula)

Specified by:

createConditionalFormattingRule in interface SheetConditionalFormatting

createConditionalFormattingRule

public XSSFConditionalFormattingRule createConditionalFormattingRule(String formula)

A factory method allowing to create a conditional formatting rule with a formula.

Specified by:

createConditionalFormattingRule in interface SheetConditionalFormatting

Parameters:

formula - - formula for the valued, compared with the cell

addConditionalFormatting

public int addConditionalFormatting(CellRangeAddress[] regions,
                           ConditionalFormattingRule[] cfRules)

Specified by:

addConditionalFormatting in interface SheetConditionalFormatting

addConditionalFormatting

public int addConditionalFormatting(CellRangeAddress[] regions,
                           ConditionalFormattingRule rule1)

Specified by:

addConditionalFormatting in interface SheetConditionalFormatting

addConditionalFormatting

public int addConditionalFormatting(CellRangeAddress[] regions,
                           ConditionalFormattingRule rule1,
                           ConditionalFormattingRule rule2)

Specified by:

addConditionalFormatting in interface SheetConditionalFormatting

addConditionalFormatting

public int addConditionalFormatting(ConditionalFormatting cf)

Adds a copy of HSSFConditionalFormatting object to the sheet

This 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:

addConditionalFormatting in interface SheetConditionalFormatting

Parameters:

cf - HSSFConditionalFormatting object

Returns:

index of the new Conditional Formatting object

getConditionalFormattingAt

public XSSFConditionalFormatting getConditionalFormattingAt(int index)

gets Conditional Formatting object at a particular index

Specified by:

getConditionalFormattingAt in interface SheetConditionalFormatting

Parameters:

index - of the Conditional Formatting object to fetch

Returns:

Conditional Formatting object

getNumConditionalFormattings

public int getNumConditionalFormattings()

Specified by:

getNumConditionalFormattings in interface SheetConditionalFormatting

Returns:

number of Conditional Formatting objects of the sheet

removeConditionalFormatting

public void removeConditionalFormatting(int index)

removes a Conditional Formatting object by index

Specified by:

removeConditionalFormatting in interface SheetConditionalFormatting

Parameters:

index - of a Conditional Formatting object to remove