Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.poi.xssf.usermodel
Class XSSFSheetConditionalFormatting

java.lang.Object
  extended by org.apache.poi.xssf.usermodel.XSSFSheetConditionalFormatting
All Implemented Interfaces:
SheetConditionalFormatting
public class XSSFSheetConditionalFormatting
extends java.lang.Object
implements SheetConditionalFormatting

XSSF Conditional Formattings

Field Summary
protected static java.lang.String CF_EXT_2009_NS_X14
          Office 2010 Conditional Formatting extensions namespace
 
Method Summary
 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 createConditionalFormattingColorScaleRule()
          Create a Color Scale / Color Gradient conditional formatting rule.
 XSSFConditionalFormattingRule createConditionalFormattingRule(byte comparisonOperation, java.lang.String formula)
           
 XSSFConditionalFormattingRule createConditionalFormattingRule(byte comparisonOperation, java.lang.String formula1, java.lang.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(ExtendedColor color)
           
 XSSFConditionalFormattingRule createConditionalFormattingRule(IconMultiStateFormatting.IconSet iconSet)
          A factory method allowing the creation of conditional formatting rules using an Icon Set / Multi-State formatting.
 XSSFConditionalFormattingRule createConditionalFormattingRule(java.lang.String formula)
          A factory method allowing to create a conditional formatting rule with a formula.
 XSSFConditionalFormattingRule createConditionalFormattingRule(XSSFColor color)
          Create a Databar conditional formatting rule.
 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
 

Field Detail

CF_EXT_2009_NS_X14

protected static final java.lang.String CF_EXT_2009_NS_X14
Office 2010 Conditional Formatting extensions namespace

See Also:
Constant Field Values
Method Detail

createConditionalFormattingRule

public XSSFConditionalFormattingRule createConditionalFormattingRule(byte comparisonOperation,
                                                                     java.lang.String formula1,
                                                                     java.lang.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 CFRuleBase.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,
                                                                     java.lang.String formula)
Specified by:
createConditionalFormattingRule in interface SheetConditionalFormatting

createConditionalFormattingRule

public XSSFConditionalFormattingRule createConditionalFormattingRule(java.lang.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

createConditionalFormattingRule

public XSSFConditionalFormattingRule createConditionalFormattingRule(XSSFColor color)
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() then XSSFDataBarFormatting.getMinThreshold() and XSSFDataBarFormatting.getMaxThreshold()

createConditionalFormattingRule

public XSSFConditionalFormattingRule createConditionalFormattingRule(ExtendedColor color)
Specified by:
createConditionalFormattingRule in interface SheetConditionalFormatting

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 with XSSFConditionalFormattingRule.getMultiStateFormatting() then XSSFIconMultiStateFormatting.getThresholds()

Specified by:
createConditionalFormattingRule in interface SheetConditionalFormatting

createConditionalFormattingColorScaleRule

public XSSFConditionalFormattingRule 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() then XSSFColorScaleFormatting.getThresholds() and XSSFColorScaleFormatting.getColors()

Specified by:
createConditionalFormattingColorScaleRule in interface SheetConditionalFormatting

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
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD