org.apache.poi.xssf.usermodel
Class XSSFConditionalFormattingRule

java.lang.Object
  org.apache.poi.xssf.usermodel.XSSFConditionalFormattingRule

All Implemented Interfaces:

ConditionalFormattingRule

public class XSSFConditionalFormattingRule
extends java.lang.Object
implements ConditionalFormattingRule

XSSF suport for Conditional Formatting rules

createBorderFormatting

public XSSFBorderFormatting createBorderFormatting()

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

Specified by:

createBorderFormatting in interface ConditionalFormattingRule

Returns:

- border formatting object, never returns null.

getBorderFormatting

public XSSFBorderFormatting getBorderFormatting()

Specified by:

getBorderFormatting in interface ConditionalFormattingRule

Returns:

- border formatting object if defined, null otherwise

createFontFormatting

public XSSFFontFormatting createFontFormatting()

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

Specified by:

createFontFormatting in interface ConditionalFormattingRule

Returns:

- font formatting object, never returns null.

getFontFormatting

public XSSFFontFormatting getFontFormatting()

Specified by:

getFontFormatting in interface ConditionalFormattingRule

Returns:

- font formatting object if defined, null otherwise

createPatternFormatting

public XSSFPatternFormatting createPatternFormatting()

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

Specified by:

createPatternFormatting in interface ConditionalFormattingRule

Returns:

- pattern formatting object, never returns null.

getPatternFormatting

public XSSFPatternFormatting getPatternFormatting()

Specified by:

getPatternFormatting in interface ConditionalFormattingRule

Returns:

- pattern formatting object if defined, null otherwise

createDataBarFormatting

public XSSFDataBarFormatting createDataBarFormatting(XSSFColor color)

getDataBarFormatting

public XSSFDataBarFormatting getDataBarFormatting()

Specified by:

getDataBarFormatting in interface ConditionalFormattingRule

createMultiStateFormatting

public XSSFIconMultiStateFormatting createMultiStateFormatting(IconMultiStateFormatting.IconSet iconSet)

getMultiStateFormatting

public XSSFIconMultiStateFormatting getMultiStateFormatting()

Specified by:

getMultiStateFormatting in interface ConditionalFormattingRule

createColorScaleFormatting

public XSSFColorScaleFormatting createColorScaleFormatting()

getColorScaleFormatting

public XSSFColorScaleFormatting getColorScaleFormatting()

Specified by:

getColorScaleFormatting in interface ConditionalFormattingRule

getConditionType

public byte getConditionType()

Type of conditional formatting rule.

MUST be one of the IDs of a ConditionType

Specified by:

getConditionType in interface ConditionalFormattingRule

Returns:

the type of condition

getConditionTypeType

public ConditionType getConditionTypeType()

Type of conditional formatting rule.

Specified by:

getConditionTypeType in interface ConditionalFormattingRule

getComparisonOperation

public byte getComparisonOperation()

The comparison function used when the type of conditional formatting is set to ConditionalFormattingRule.CONDITION_TYPE_CELL_VALUE_IS

MUST be a constant from ComparisonOperator

Specified by:

getComparisonOperation in interface ConditionalFormattingRule

Returns:

the conditional format operator

getFormula1

public java.lang.String getFormula1()

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

If the condition type is ConditionalFormattingRule.CONDITION_TYPE_CELL_VALUE_IS, this field is the first operand of the comparison. If type is ConditionalFormattingRule.CONDITION_TYPE_FORMULA, this formula is used to determine if the conditional formatting is applied.

If comparison type is ConditionalFormattingRule.CONDITION_TYPE_FORMULA the formula MUST be a Boolean function

Specified by:

getFormula1 in interface ConditionalFormattingRule

Returns:

the first formula

getFormula2

public java.lang.String getFormula2()

The formula used to evaluate the second operand of the comparison when comparison type is ConditionalFormattingRule.CONDITION_TYPE_CELL_VALUE_IS and operator is either ComparisonOperator.BETWEEN or ComparisonOperator.NOT_BETWEEN

Specified by:

getFormula2 in interface ConditionalFormattingRule

Returns:

the second formula