Top Description Fields Constructors Methods
org.apache.poi.hssf.usermodel

public final Class HSSFSheetConditionalFormatting

extends Object
implements SheetConditionalFormatting
Class Inheritance
All Implemented Interfaces
org.apache.poi.ss.usermodel.SheetConditionalFormatting
Imports
org.apache.poi.hssf.record.CFRule12Record, .CFRuleBase, .CFRuleRecord, org.apache.poi.hssf.record.aggregates.CFRecordsAggregate, .ConditionalFormattingTable, org.apache.poi.ss.SpreadsheetVersion, org.apache.poi.ss.usermodel.ConditionalFormatting, .ConditionalFormattingRule, .ExtendedColor, .IconMultiStateFormatting.IconSet, .SheetConditionalFormatting, org.apache.poi.ss.util.CellRangeAddress
The 'Conditional Formatting' facet of HSSFSheet

Field Summary

Modifier and TypeField and Description
private final ConditionalFormattingTable
_conditionalFormattingTable

private final HSSFSheet
_sheet

Constructor Summary

AccessConstructor and Description
pack-priv
HSSFSheetConditionalFormatting(HSSFSheet sheet)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

index of the new Conditional Formatting object
addConditionalFormatting(HSSFConditionalFormatting
HSSFConditionalFormatting object
cf)

Adds a copy of HSSFConditionalFormatting object to the sheet

This method could be used to copy HSSFConditionalFormatting object from one sheet to another.

public int
addConditionalFormatting(ConditionalFormatting
the Conditional Formatting to clone
cf)

Implements org.apache.poi.ss.usermodel.SheetConditionalFormatting.addConditionalFormatting.

Adds a copy of a ConditionalFormatting object to the sheet

This method could be used to copy ConditionalFormatting object from one sheet to another.

public int

Returns:

index of the newly created Conditional Formatting object
addConditionalFormatting(CellRangeAddress[]
- list of rectangular regions to apply conditional formatting rules
regions, HSSFConditionalFormattingRule[]
- set of up to three conditional formatting rules
cfRules)

Allows to add a new Conditional Formatting set to the sheet.

public int
addConditionalFormatting(CellRangeAddress[]
- list of rectangular regions to apply conditional formatting rules
regions, ConditionalFormattingRule[]
- set of up to conditional formatting rules (max 3 for Excel pre-2007)
cfRules)

Implements org.apache.poi.ss.usermodel.SheetConditionalFormatting.addConditionalFormatting.

Add a new Conditional Formatting set to the sheet.

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

public int
addConditionalFormatting(CellRangeAddress[]
- list of rectangular regions to apply conditional formatting rules
regions, ConditionalFormattingRule
- the rule to apply
rule1)

Implements org.apache.poi.ss.usermodel.SheetConditionalFormatting.addConditionalFormatting.

Add a new Conditional Formatting to the sheet.

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

public int
addConditionalFormatting(CellRangeAddress[]
- list of rectangular regions to apply conditional formatting rules
regions, ConditionalFormattingRule
- the first rule
rule1, ConditionalFormattingRule
- the second rule
rule2)

Implements org.apache.poi.ss.usermodel.SheetConditionalFormatting.addConditionalFormatting.

Add a new Conditional Formatting consisting of two rules.

public HSSFConditionalFormattingRule
createConditionalFormattingColorScaleRule()

Implements org.apache.poi.ss.usermodel.SheetConditionalFormatting.createConditionalFormattingColorScaleRule.

Create a Color Scale / Color Gradient conditional formatting rule.

public HSSFConditionalFormattingRule
createConditionalFormattingRule(byte
- a constant value from {@link org.apache.poi.hssf.record.CFRuleBase.ComparisonOperator}:
  • BETWEEN
  • NOT_BETWEEN
  • EQUAL
  • NOT_EQUAL
  • GT
  • LT
  • GE
  • LE
comparisonOperation, String
- formula for the valued, compared with the cell
formula1, String
- second formula (only used with org.apache.poi.hssf.record.CFRuleBase.ComparisonOperator#BETWEEN) and org.apache.poi.hssf.record.CFRuleBase.ComparisonOperator#NOT_BETWEEN operations)
formula2)

Implements org.apache.poi.ss.usermodel.SheetConditionalFormatting.createConditionalFormattingRule.

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

public HSSFConditionalFormattingRule
createConditionalFormattingRule(byte
MUST be a constant value from ComparisonOperator except BETWEEN and NOT_BETWEEN
comparisonOperation, String
the formula to determine if the conditional formatting is applied
formula1)

Implements org.apache.poi.ss.usermodel.SheetConditionalFormatting.createConditionalFormattingRule.

Create 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

public HSSFConditionalFormattingRule
createConditionalFormattingRule(String
- formula for the valued, compared with the cell
formula)

Implements org.apache.poi.ss.usermodel.SheetConditionalFormatting.createConditionalFormattingRule.

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

public HSSFConditionalFormattingRule
createConditionalFormattingRule(IconMultiStateFormatting.IconSet iconSet)

Implements org.apache.poi.ss.usermodel.SheetConditionalFormatting.createConditionalFormattingRule.

A factory method allowing the creation of conditional formatting rules using an Icon Set / Multi-State formatting.

public HSSFConditionalFormattingRule
createConditionalFormattingRule(HSSFExtendedColor color)

Create a Databar conditional formatting rule.

public HSSFConditionalFormattingRule
createConditionalFormattingRule(ExtendedColor color)

Implements org.apache.poi.ss.usermodel.SheetConditionalFormatting.createConditionalFormattingRule.

Create a Databar conditional formatting rule.

public HSSFConditionalFormatting

Returns:

Conditional Formatting object
getConditionalFormattingAt(int
of the Conditional Formatting object to fetch
index)

Implements org.apache.poi.ss.usermodel.SheetConditionalFormatting.getConditionalFormattingAt.

gets Conditional Formatting object at a particular index

public int

Returns:

number of Conditional Formatting objects of the sheet
getNumConditionalFormattings()

Implements org.apache.poi.ss.usermodel.SheetConditionalFormatting.getNumConditionalFormattings.

public void
removeConditionalFormatting(int
of a Conditional Formatting object to remove
index)

Implements org.apache.poi.ss.usermodel.SheetConditionalFormatting.removeConditionalFormatting.

removes a Conditional Formatting object by index

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

_conditionalFormattingTableback to summary
private final ConditionalFormattingTable _conditionalFormattingTable
_sheetback to summary
private final HSSFSheet _sheet

Constructor Detail

HSSFSheetConditionalFormattingback to summary
pack-priv HSSFSheetConditionalFormatting(HSSFSheet sheet)

Method Detail

addConditionalFormattingback to summary
public int addConditionalFormatting(HSSFConditionalFormatting 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);
Parameters
cf:HSSFConditionalFormatting

HSSFConditionalFormatting object

Returns:int

index of the new Conditional Formatting object

addConditionalFormattingback to summary
public int addConditionalFormatting(ConditionalFormatting cf)

Implements org.apache.poi.ss.usermodel.SheetConditionalFormatting.addConditionalFormatting.

Doc from org.apache.poi.ss.usermodel.SheetConditionalFormatting.addConditionalFormatting.

Adds a copy of a ConditionalFormatting object to the sheet

This method could be used to copy ConditionalFormatting object from one sheet to another. For example: 

ConditionalFormatting cf = sheet.getConditionalFormattingAt(index);
newSheet.addConditionalFormatting(cf);
Parameters
cf:ConditionalFormatting

the Conditional Formatting to clone

Returns:int

index of the new Conditional Formatting object

Annotations
@Override
addConditionalFormattingback to summary
public int addConditionalFormatting(CellRangeAddress[] regions, HSSFConditionalFormattingRule[] cfRules)

Allows to add a new Conditional Formatting set to the sheet.

Parameters
regions:CellRangeAddress[]

- list of rectangular regions to apply conditional formatting rules

cfRules:HSSFConditionalFormattingRule[]

- set of up to three conditional formatting rules

Returns:int

index of the newly created Conditional Formatting object

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

Implements org.apache.poi.ss.usermodel.SheetConditionalFormatting.addConditionalFormatting.

Doc from org.apache.poi.ss.usermodel.SheetConditionalFormatting.addConditionalFormatting.

Add a new Conditional Formatting set to the sheet.

Parameters
regions:CellRangeAddress[]

- list of rectangular regions to apply conditional formatting rules

cfRules:ConditionalFormattingRule[]

- set of up to conditional formatting rules (max 3 for Excel pre-2007)

Returns:int

index of the newly created Conditional Formatting object

Annotations
@Override
addConditionalFormattingback to summary
public int addConditionalFormatting(CellRangeAddress[] regions, HSSFConditionalFormattingRule rule1)
addConditionalFormattingback to summary
public int addConditionalFormatting(CellRangeAddress[] regions, ConditionalFormattingRule rule1)

Implements org.apache.poi.ss.usermodel.SheetConditionalFormatting.addConditionalFormatting.

Doc from org.apache.poi.ss.usermodel.SheetConditionalFormatting.addConditionalFormatting.

Add a new Conditional Formatting to the sheet.

Parameters
regions:CellRangeAddress[]

- list of rectangular regions to apply conditional formatting rules

rule1:ConditionalFormattingRule

- the rule to apply

Returns:int

index of the newly created Conditional Formatting object

Annotations
@Override
addConditionalFormattingback to summary
public int addConditionalFormatting(CellRangeAddress[] regions, HSSFConditionalFormattingRule rule1, HSSFConditionalFormattingRule rule2)
addConditionalFormattingback to summary
public int addConditionalFormatting(CellRangeAddress[] regions, ConditionalFormattingRule rule1, ConditionalFormattingRule rule2)

Implements org.apache.poi.ss.usermodel.SheetConditionalFormatting.addConditionalFormatting.

Doc from org.apache.poi.ss.usermodel.SheetConditionalFormatting.addConditionalFormatting.

Add a new Conditional Formatting consisting of two rules.

Parameters
regions:CellRangeAddress[]

- list of rectangular regions to apply conditional formatting rules

rule1:ConditionalFormattingRule

- the first rule

rule2:ConditionalFormattingRule

- the second rule

Returns:int

index of the newly created Conditional Formatting object

Annotations
@Override
createConditionalFormattingColorScaleRuleback to summary
public HSSFConditionalFormattingRule createConditionalFormattingColorScaleRule()

Implements org.apache.poi.ss.usermodel.SheetConditionalFormatting.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 HSSFConditionalFormattingRule#getColorScaleFormatting() then HSSFColorScaleFormatting#getThresholds() and HSSFColorScaleFormatting#getColors()

Annotations
@Override
createConditionalFormattingRuleback to summary
public HSSFConditionalFormattingRule createConditionalFormattingRule(byte comparisonOperation, String formula1, String formula2)

Implements org.apache.poi.ss.usermodel.SheetConditionalFormatting.createConditionalFormattingRule.

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

Parameters
comparisonOperation:byte

- a constant value from {@link org.apache.poi.hssf.record.CFRuleBase.ComparisonOperator}:

  • BETWEEN
  • NOT_BETWEEN
  • EQUAL
  • NOT_EQUAL
  • GT
  • LT
  • GE
  • LE
formula1:String

- formula for the valued, compared with the cell

formula2:String

- second formula (only used with org.apache.poi.hssf.record.CFRuleBase.ComparisonOperator#BETWEEN) and org.apache.poi.hssf.record.CFRuleBase.ComparisonOperator#NOT_BETWEEN operations)

Annotations
@Override
createConditionalFormattingRuleback to summary
public HSSFConditionalFormattingRule createConditionalFormattingRule(byte comparisonOperation, String formula1)

Implements org.apache.poi.ss.usermodel.SheetConditionalFormatting.createConditionalFormattingRule.

Doc from org.apache.poi.ss.usermodel.SheetConditionalFormatting.createConditionalFormattingRule.

Create 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

Parameters
comparisonOperation:byte

MUST be a constant value from ComparisonOperator except BETWEEN and NOT_BETWEEN

formula1:String

the formula to determine if the conditional formatting is applied

Annotations
@Override
createConditionalFormattingRuleback to summary
public HSSFConditionalFormattingRule createConditionalFormattingRule(String formula)

Implements org.apache.poi.ss.usermodel.SheetConditionalFormatting.createConditionalFormattingRule.

A factory method allowing to create a conditional formatting rule with a formula.
The formatting rules are applied by Excel when the value of the formula not equal to 0.

TODO - formulas containing cell references are currently not parsed properly

Parameters
formula:String

- formula for the valued, compared with the cell

Annotations
@Override
createConditionalFormattingRuleback to summary
public HSSFConditionalFormattingRule createConditionalFormattingRule(IconMultiStateFormatting.IconSet iconSet)

Implements org.apache.poi.ss.usermodel.SheetConditionalFormatting.createConditionalFormattingRule.

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 HSSFConditionalFormattingRule#getMultiStateFormatting() then HSSFIconMultiStateFormatting#getThresholds()

Annotations
@Override
createConditionalFormattingRuleback to summary
public HSSFConditionalFormattingRule createConditionalFormattingRule(HSSFExtendedColor color)

Create a Databar conditional formatting rule.

The thresholds and colour for it will be created, but will be empty and require configuring with HSSFConditionalFormattingRule#getDataBarFormatting() then HSSFDataBarFormatting#getMinThreshold() and HSSFDataBarFormatting#getMaxThreshold()

createConditionalFormattingRuleback to summary
public HSSFConditionalFormattingRule createConditionalFormattingRule(ExtendedColor color)

Implements org.apache.poi.ss.usermodel.SheetConditionalFormatting.createConditionalFormattingRule.

Doc from org.apache.poi.ss.usermodel.SheetConditionalFormatting.createConditionalFormattingRule.

Create a Databar conditional formatting rule.

The thresholds and colour for it will be created, but will be empty and require configuring with ConditionalFormattingRule#getDataBarFormatting() then DataBarFormatting#getMinThreshold() and DataBarFormatting#getMaxThreshold()

Annotations
@Override
getConditionalFormattingAtback to summary
public HSSFConditionalFormatting getConditionalFormattingAt(int index)

Implements org.apache.poi.ss.usermodel.SheetConditionalFormatting.getConditionalFormattingAt.

gets Conditional Formatting object at a particular index

Parameters
index:int

of the Conditional Formatting object to fetch

Returns:HSSFConditionalFormatting

Conditional Formatting object

Annotations
@Override
getNumConditionalFormattingsback to summary
public int getNumConditionalFormattings()

Implements org.apache.poi.ss.usermodel.SheetConditionalFormatting.getNumConditionalFormattings.

Returns:int

number of Conditional Formatting objects of the sheet

Annotations
@Override
removeConditionalFormattingback to summary
public void removeConditionalFormatting(int index)

Implements org.apache.poi.ss.usermodel.SheetConditionalFormatting.removeConditionalFormatting.

removes a Conditional Formatting object by index

Parameters
index:int

of a Conditional Formatting object to remove

Annotations
@Override