Apache POI - Common 5.3.0 · org.apache.poi.hssf.usermodel.HSSFConditionalFormattingRule

Modifier and Type	Field and Description
private static final byte	CELL_COMPARISON
private final CFRuleBase	cfRuleRecord
private final HSSFSheet	sheet
private final HSSFWorkbook	workbook

Access	Constructor and Description
pack-priv	HSSFConditionalFormattingRule(HSSFSheet pSheet, CFRuleBase pRuleRecord)

Method Summary

Modifier and Type	Method and Description
public HSSFBorderFormatting	Returns: - border formatting object, never returns `null`. createBorderFormatting() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.createBorderFormatting. create a new border formatting structure if it does not exist, otherwise just return existing object.
public HSSFColorScaleFormatting	createColorScaleFormatting() create a new color scale / gradient formatting object if it does not exist, otherwise just return the existing object.
public HSSFDataBarFormatting	createDataBarFormatting() create a new databar / data-bar formatting object if it does not exist, otherwise just return the existing object.
public HSSFFontFormatting	Returns: - font formatting object, never returns `null`. createFontFormatting() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.createFontFormatting. create a new font formatting structure if it does not exist, otherwise just return existing object.
public HSSFIconMultiStateFormatting	createMultiStateFormatting() create a new icon / multi-state formatting object if it does not exist, otherwise just return the existing object.
public HSSFPatternFormatting	Returns: - pattern formatting object, never returns `null`. createPatternFormatting() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.createPatternFormatting. create a new pattern formatting structure if it does not exist, otherwise just return existing object.
private HSSFBorderFormatting	getBorderFormatting(boolean create)
public HSSFBorderFormatting	Returns: - border formatting object if defined, `null` otherwise getBorderFormatting() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getBorderFormatting.
private CFRule12Record	getCFRule12Record(boolean create)
pack-priv CFRuleBase	getCfRuleRecord()
private HSSFColorScaleFormatting	getColorScaleFormatting(boolean create)
public HSSFColorScaleFormatting	Returns: color scale / gradient formatting object if defined, `null` otherwise getColorScaleFormatting() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getColorScaleFormatting.
public byte	Returns: - the comparisionoperatation for the cfrule getComparisonOperation() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getComparisonOperation. The comparison function used when the type of conditional formatting is set to `ConditionType#CELL_VALUE_IS` MUST be a constant from `ComparisonOperator`
public ConditionFilterType	getConditionFilterType() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getConditionFilterType. always null (not a filter condition) or `ConditionFilterType#FILTER` if it is.
public ConditionType	Returns: - the conditiontype for the cfrule getConditionType() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getConditionType. Type of conditional formatting rule.
private HSSFDataBarFormatting	getDataBarFormatting(boolean create)
public HSSFDataBarFormatting	Returns: databar / data-bar formatting object if defined, `null` otherwise getDataBarFormatting() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getDataBarFormatting.
public ConditionFilterData	getFilterConfiguration() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getFilterConfiguration. This is null if `getConditionFilterType() == null` This means it is always null for HSSF, which does not define the extended condition types.
private HSSFFontFormatting	getFontFormatting(boolean create)
public HSSFFontFormatting	Returns: - font formatting object if defined, `null` otherwise getFontFormatting() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getFontFormatting.
public String	getFormula1() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getFormula1. The formula used to evaluate the first operand for the conditional formatting rule.
public String	getFormula2() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getFormula2. The formula used to evaluate the second operand of the comparison when comparison type is `ConditionType#CELL_VALUE_IS` and operator is either `ComparisonOperator#BETWEEN` or `ComparisonOperator#NOT_BETWEEN`
private HSSFIconMultiStateFormatting	getMultiStateFormatting(boolean create)
public HSSFIconMultiStateFormatting	Returns: icon / multi-state formatting object if defined, `null` otherwise getMultiStateFormatting() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getMultiStateFormatting.
public ExcelNumberFormat	getNumberFormat() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getNumberFormat. Always null for HSSF records, until someone figures out where to find it
private HSSFPatternFormatting	getPatternFormatting(boolean create)
public HSSFPatternFormatting	Returns: - pattern formatting object if defined, `null` otherwise getPatternFormatting() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getPatternFormatting.
public int	getPriority() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getPriority. Only newer style formatting rules have priorities.
public boolean	getStopIfTrue() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getStopIfTrue. Always true for HSSF files, per Microsoft Excel documentation
public int	getStripeSize() Implements org.apache.poi.ss.usermodel.DifferentialStyleProvider.getStripeSize. Conditional format rules don't define stripes, so always 0
public String	getText() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getText. XSSF rules store textual condition values as an attribute and also as a formula that needs shifting.
pack-priv String	toFormulaString(Ptg[] parsedExpression)
pack-priv static String	toFormulaString(Ptg[] parsedExpression, HSSFWorkbook workbook)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

CELL_COMPARISON	back to summary
private static final byte CELL_COMPARISON

cfRuleRecord	back to summary
private final CFRuleBase cfRuleRecord

sheet	back to summary
private final HSSFSheet sheet

workbook	back to summary
private final HSSFWorkbook workbook

HSSFConditionalFormattingRule	back to summary
pack-priv HSSFConditionalFormattingRule(HSSFSheet pSheet, CFRuleBase pRuleRecord)

Method Detail

createBorderFormatting back to summary

createBorderFormatting	back to summary
public HSSFBorderFormatting createBorderFormatting() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.createBorderFormatting. create a new border formatting structure if it does not exist, otherwise just return existing object. Returns:HSSFBorderFormatting - border formatting object, never returns `null`. Annotations @Override

public HSSFBorderFormatting createBorderFormatting()

Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.createBorderFormatting.

create a new border formatting structure if it does not exist, otherwise just return existing object.

Returns:HSSFBorderFormatting

- border formatting object, never returns null.

Annotations

@Override

createColorScaleFormatting	back to summary
public HSSFColorScaleFormatting createColorScaleFormatting() create a new color scale / gradient formatting object if it does not exist, otherwise just return the existing object.

createDataBarFormatting	back to summary
public HSSFDataBarFormatting createDataBarFormatting() create a new databar / data-bar formatting object if it does not exist, otherwise just return the existing object.

createFontFormatting back to summary

createFontFormatting	back to summary
public HSSFFontFormatting createFontFormatting() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.createFontFormatting. create a new font formatting structure if it does not exist, otherwise just return existing object. Returns:HSSFFontFormatting - font formatting object, never returns `null`. Annotations @Override

public HSSFFontFormatting createFontFormatting()

Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.createFontFormatting.

create a new font formatting structure if it does not exist, otherwise just return existing object.

Returns:HSSFFontFormatting

- font formatting object, never returns null.

Annotations

@Override

createMultiStateFormatting	back to summary
public HSSFIconMultiStateFormatting createMultiStateFormatting() create a new icon / multi-state formatting object if it does not exist, otherwise just return the existing object.

createPatternFormatting back to summary

createPatternFormatting	back to summary
public HSSFPatternFormatting createPatternFormatting() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.createPatternFormatting. create a new pattern formatting structure if it does not exist, otherwise just return existing object. Returns:HSSFPatternFormatting - pattern formatting object, never returns `null`. Annotations @Override

public HSSFPatternFormatting createPatternFormatting()

Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.createPatternFormatting.

create a new pattern formatting structure if it does not exist, otherwise just return existing object.

Returns:HSSFPatternFormatting

- pattern formatting object, never returns null.

Annotations

@Override

getBorderFormatting	back to summary
private HSSFBorderFormatting getBorderFormatting(boolean create)

getBorderFormatting back to summary

getBorderFormatting	back to summary
public HSSFBorderFormatting getBorderFormatting() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getBorderFormatting. Returns:HSSFBorderFormatting - border formatting object if defined, `null` otherwise Annotations @Override

public HSSFBorderFormatting getBorderFormatting()

Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getBorderFormatting.

Returns:HSSFBorderFormatting

- border formatting object if defined, null otherwise

Annotations

@Override

getCFRule12Record	back to summary
private CFRule12Record getCFRule12Record(boolean create)

getCfRuleRecord	back to summary
pack-priv CFRuleBase getCfRuleRecord()

getColorScaleFormatting	back to summary
private HSSFColorScaleFormatting getColorScaleFormatting(boolean create)

getColorScaleFormatting back to summary

getColorScaleFormatting	back to summary
public HSSFColorScaleFormatting getColorScaleFormatting() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getColorScaleFormatting. Returns:HSSFColorScaleFormatting color scale / gradient formatting object if defined, `null` otherwise Annotations @Override

public HSSFColorScaleFormatting getColorScaleFormatting()

Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getColorScaleFormatting.

Returns:HSSFColorScaleFormatting

color scale / gradient formatting object if defined, null otherwise

Annotations

@Override

getComparisonOperation back to summary

getComparisonOperation	back to summary
public byte getComparisonOperation() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getComparisonOperation. Doc from org.apache.poi.ss.usermodel.ConditionalFormattingRule.getComparisonOperation. The comparison function used when the type of conditional formatting is set to `ConditionType#CELL_VALUE_IS` MUST be a constant from `ComparisonOperator` Returns:byte - the comparisionoperatation for the cfrule Annotations @Override

public byte getComparisonOperation()

Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getComparisonOperation.

Doc from org.apache.poi.ss.usermodel.ConditionalFormattingRule.getComparisonOperation.

The comparison function used when the type of conditional formatting is set to ConditionType#CELL_VALUE_IS

MUST be a constant from ComparisonOperator

Returns:byte

- the comparisionoperatation for the cfrule

Annotations

@Override

getConditionFilterType back to summary

getConditionFilterType	back to summary
public ConditionFilterType getConditionFilterType() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getConditionFilterType. always null (not a filter condition) or `ConditionFilterType#FILTER` if it is. Returns:ConditionFilterType Doc from org.apache.poi.ss.usermodel.ConditionalFormattingRule.getConditionFilterType. filter type for filter rules, or null if not a filter rule. Annotations @Override

public ConditionFilterType getConditionFilterType()

Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getConditionFilterType.

always null (not a filter condition) or ConditionFilterType#FILTER if it is.

Returns:ConditionFilterType

Doc from org.apache.poi.ss.usermodel.ConditionalFormattingRule.getConditionFilterType.

filter type for filter rules, or null if not a filter rule.

Annotations

@Override

getConditionType	back to summary
public ConditionType getConditionType() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getConditionType. Doc from org.apache.poi.ss.usermodel.ConditionalFormattingRule.getConditionType. Type of conditional formatting rule. Returns:ConditionType - the conditiontype for the cfrule Annotations @Override

getConditionType

back to summary

public ConditionType getConditionType()

Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getConditionType.

Doc from org.apache.poi.ss.usermodel.ConditionalFormattingRule.getConditionType.

Type of conditional formatting rule.

Returns:ConditionType

- the conditiontype for the cfrule

Annotations

@Override

getDataBarFormatting	back to summary
private HSSFDataBarFormatting getDataBarFormatting(boolean create)

getDataBarFormatting back to summary

getDataBarFormatting	back to summary
public HSSFDataBarFormatting getDataBarFormatting() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getDataBarFormatting. Returns:HSSFDataBarFormatting databar / data-bar formatting object if defined, `null` otherwise Annotations @Override

public HSSFDataBarFormatting getDataBarFormatting()

Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getDataBarFormatting.

Returns:HSSFDataBarFormatting

databar / data-bar formatting object if defined, null otherwise

Annotations

@Override

getFilterConfiguration back to summary

getFilterConfiguration	back to summary
public ConditionFilterData getFilterConfiguration() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getFilterConfiguration. Doc from org.apache.poi.ss.usermodel.ConditionalFormattingRule.getFilterConfiguration. This is null if `getConditionFilterType() == null` This means it is always null for HSSF, which does not define the extended condition types. This object contains the additional configuration information for XSSF filter conditions. Returns:ConditionFilterData the Filter Configuration Data, or null if there isn't any Annotations @Override

public ConditionFilterData getFilterConfiguration()

Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getFilterConfiguration.

Doc from org.apache.poi.ss.usermodel.ConditionalFormattingRule.getFilterConfiguration.

This is null if

getConditionFilterType() == null

This means it is always null for HSSF, which does not define the extended condition types.

This object contains the additional configuration information for XSSF filter conditions.

Returns:ConditionFilterData

the Filter Configuration Data, or null if there isn't any

Annotations

@Override

getFontFormatting	back to summary
private HSSFFontFormatting getFontFormatting(boolean create)

getFontFormatting back to summary

getFontFormatting	back to summary
public HSSFFontFormatting getFontFormatting() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getFontFormatting. Returns:HSSFFontFormatting - font formatting object if defined, `null` otherwise Annotations @Override

public HSSFFontFormatting getFontFormatting()

Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getFontFormatting.

Returns:HSSFFontFormatting

- font formatting object if defined, null otherwise

Annotations

@Override

getFormula1 back to summary

getFormula1	back to summary
public String getFormula1() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getFormula1. Doc from org.apache.poi.ss.usermodel.ConditionalFormattingRule.getFormula1. The formula used to evaluate the first operand for the conditional formatting rule. If the condition type is `ConditionType#CELL_VALUE_IS`, this field is the first operand of the comparison. If type is `ConditionType#FORMULA`, this formula is used to determine if the conditional formatting is applied. If comparison type is `ConditionType#FORMULA` the formula MUST be a Boolean function Returns:String the first formula Annotations @Override

public String getFormula1()

Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getFormula1.

Doc from org.apache.poi.ss.usermodel.ConditionalFormattingRule.getFormula1.

The formula used to evaluate the first operand for the conditional formatting rule.

If the condition type is ConditionType#CELL_VALUE_IS, this field is the first operand of the comparison. If type is ConditionType#FORMULA, this formula is used to determine if the conditional formatting is applied.

If comparison type is ConditionType#FORMULA the formula MUST be a Boolean function

Returns:String

the first formula

Annotations

@Override

getFormula2 back to summary

getFormula2	back to summary
public String getFormula2() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getFormula2. Doc from org.apache.poi.ss.usermodel.ConditionalFormattingRule.getFormula2. The formula used to evaluate the second operand of the comparison when comparison type is `ConditionType#CELL_VALUE_IS` and operator is either `ComparisonOperator#BETWEEN` or `ComparisonOperator#NOT_BETWEEN` Returns:String the second formula Annotations @Override

public String getFormula2()

Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getFormula2.

Doc from org.apache.poi.ss.usermodel.ConditionalFormattingRule.getFormula2.

The formula used to evaluate the second operand of the comparison when comparison type is ConditionType#CELL_VALUE_IS and operator is either ComparisonOperator#BETWEEN or ComparisonOperator#NOT_BETWEEN

Returns:String

the second formula

Annotations

@Override

getMultiStateFormatting	back to summary
private HSSFIconMultiStateFormatting getMultiStateFormatting(boolean create)

getMultiStateFormatting back to summary

getMultiStateFormatting	back to summary
public HSSFIconMultiStateFormatting getMultiStateFormatting() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getMultiStateFormatting. Returns:HSSFIconMultiStateFormatting icon / multi-state formatting object if defined, `null` otherwise Annotations @Override

public HSSFIconMultiStateFormatting getMultiStateFormatting()

Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getMultiStateFormatting.

Returns:HSSFIconMultiStateFormatting

icon / multi-state formatting object if defined, null otherwise

Annotations

@Override

getNumberFormat	back to summary
public ExcelNumberFormat getNumberFormat() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getNumberFormat. Always null for HSSF records, until someone figures out where to find it Returns:ExcelNumberFormat Doc from org.apache.poi.ss.usermodel.ConditionalFormattingRule.getNumberFormat. number format defined for this rule, or null if the cell default should be used Annotations @Override

getNumberFormat

back to summary

public ExcelNumberFormat getNumberFormat()

Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getNumberFormat.

Always null for HSSF records, until someone figures out where to find it

Returns:ExcelNumberFormat

Doc from org.apache.poi.ss.usermodel.ConditionalFormattingRule.getNumberFormat.

number format defined for this rule, or null if the cell default should be used

Annotations

@Override

getPatternFormatting	back to summary
private HSSFPatternFormatting getPatternFormatting(boolean create)

getPatternFormatting back to summary

getPatternFormatting	back to summary
public HSSFPatternFormatting getPatternFormatting() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getPatternFormatting. Returns:HSSFPatternFormatting - pattern formatting object if defined, `null` otherwise Annotations @Override

public HSSFPatternFormatting getPatternFormatting()

Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getPatternFormatting.

Returns:HSSFPatternFormatting

- pattern formatting object if defined, null otherwise

Annotations

@Override

getPriority	back to summary
public int getPriority() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getPriority. Only newer style formatting rules have priorities. For older ones, we don't know priority for these, other than definition/model order, which appears to be what Excel uses. Returns:int Doc from org.apache.poi.ss.usermodel.ConditionalFormattingRule.getPriority. rule priority Annotations @Override

getPriority

back to summary

public int getPriority()

Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getPriority.

Only newer style formatting rules have priorities. For older ones, we don't know priority for these, other than definition/model order, which appears to be what Excel uses.

Returns:int

Doc from org.apache.poi.ss.usermodel.ConditionalFormattingRule.getPriority.

rule priority

Annotations

@Override

getStopIfTrue	back to summary
public boolean getStopIfTrue() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getStopIfTrue. Always true for HSSF files, per Microsoft Excel documentation Returns:boolean Doc from org.apache.poi.ss.usermodel.ConditionalFormattingRule.getStopIfTrue. true if conditional formatting rule processing stops when this one is true, false if not Annotations @Override

getStopIfTrue

back to summary

public boolean getStopIfTrue()

Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getStopIfTrue.

Always true for HSSF files, per Microsoft Excel documentation

Returns:boolean

Doc from org.apache.poi.ss.usermodel.ConditionalFormattingRule.getStopIfTrue.

true if conditional formatting rule processing stops when this one is true, false if not

Annotations

@Override

getStripeSize back to summary

getStripeSize	back to summary
public int getStripeSize() Implements org.apache.poi.ss.usermodel.DifferentialStyleProvider.getStripeSize. Conditional format rules don't define stripes, so always 0 Returns:int Doc from org.apache.poi.ss.usermodel.DifferentialStyleProvider.getStripeSize. number of rows/columns in a stripe for stripe styles, 0 for all others Annotations @Override See Also `org.apache.poi.ss.usermodel.DifferentialStyleProvider#getStripeSize()`

public int getStripeSize()

Implements org.apache.poi.ss.usermodel.DifferentialStyleProvider.getStripeSize.

Conditional format rules don't define stripes, so always 0

Returns:int

Doc from org.apache.poi.ss.usermodel.DifferentialStyleProvider.getStripeSize.

number of rows/columns in a stripe for stripe styles, 0 for all others

Annotations

@Override

getText	back to summary
public String getText() Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getText. Doc from org.apache.poi.ss.usermodel.ConditionalFormattingRule.getText. XSSF rules store textual condition values as an attribute and also as a formula that needs shifting. Using the attribute is simpler/faster. HSSF rules don't have this and return null. We can fall back on the formula for those (AFAIK). Returns:String condition text if it exists, or null Annotations @Override

getText

back to summary

public String getText()

Implements org.apache.poi.ss.usermodel.ConditionalFormattingRule.getText.

Doc from org.apache.poi.ss.usermodel.ConditionalFormattingRule.getText.

XSSF rules store textual condition values as an attribute and also as a formula that needs shifting. Using the attribute is simpler/faster. HSSF rules don't have this and return null. We can fall back on the formula for those (AFAIK).

Returns:String

condition text if it exists, or null

Annotations

@Override

toFormulaString	back to summary
pack-priv String toFormulaString(Ptg[] parsedExpression)

toFormulaString	back to summary
pack-priv static String toFormulaString(Ptg[] parsedExpression, HSSFWorkbook workbook)

public final Class HSSFConditionalFormattingRule

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail