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 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,
                                                              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

• 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