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

## org.apache.poi.hssf.usermodel
Class HSSFConditionalFormattingRule

    java.lang.Object
      org.apache.poi.hssf.usermodel.HSSFConditionalFormattingRule

All Implemented Interfaces:
  ConditionalFormattingRule

    public final class HSSFConditionalFormattingRule

extends java.lang.Object
implements ConditionalFormattingRule

High level representation of Conditional Formatting Rule. It allows to specify formula based conditions for the Conditional Formatting and the formatting settings such as font, border and pattern.

Author:
  Dmitriy Kumshayev

Field Summary

Fields inherited from interface org.apache.poi.ss.usermodel.ConditionalFormattingRule
`CONDITION_TYPE_CELL_VALUE_IS, CONDITION_TYPE_FORMULA`

Method Summary
`BorderFormatting` | `createBorderFormatting()` create a new border formatting structure if it does not exist, otherwise just return existing object.
`FontFormatting` | `createFontFormatting()` create a new font formatting structure if it does not exist, otherwise just return existing object.
`PatternFormatting` | `createPatternFormatting()` create a new pattern formatting structure if it does not exist, otherwise just return existing object.
`BorderFormatting` | `getBorderFormatting()`
`byte` | `getComparisonOperation()` The comparison function used when the type of conditional formatting is set to `ConditionalFormattingRule.CONDITION_TYPE_CELL_VALUE_IS`
`byte` | `getConditionType()` Type of conditional formatting rule.
`FontFormatting` | `getFontFormatting()`
`java.lang.String` | `getFormula1()` The formula used to evaluate the first operand for the conditional formatting rule.
`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`
`PatternFormatting` | `getPatternFormatting()`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

### getFontFormatting

    public FontFormatting getFontFormatting()

  Specified by:
    `getFontFormatting` in interface `ConditionalFormattingRule`
  Returns:
    - font formatting object if defined, `null` otherwise

### createFontFormatting

    public FontFormatting 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`.

### getBorderFormatting

    public BorderFormatting getBorderFormatting()

  Specified by:
    `getBorderFormatting` in interface `ConditionalFormattingRule`
  Returns:
    - border formatting object if defined, `null` otherwise

### createBorderFormatting

    public BorderFormatting 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`.

### getPatternFormatting

    public PatternFormatting getPatternFormatting()

  Specified by:
    `getPatternFormatting` in interface `ConditionalFormattingRule`
  Returns:
    - pattern formatting object if defined, `null` otherwise

### createPatternFormatting

    public PatternFormatting 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`.

### getConditionType

    public byte getConditionType()

  Description copied from interface: `ConditionalFormattingRule`
  Type of conditional formatting rule.

  MUST be either `ConditionalFormattingRule.CONDITION_TYPE_CELL_VALUE_IS` or `ConditionalFormattingRule.CONDITION_TYPE_FORMULA`

  Specified by:
    `getConditionType` in interface `ConditionalFormattingRule`
  Returns:
    - the conditiontype for the cfrule

### getComparisonOperation

    public byte getComparisonOperation()

  Description copied from interface: `ConditionalFormattingRule`
  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 comparisionoperatation for the cfrule

### getFormula1

    public java.lang.String getFormula1()

  Description copied from interface: `ConditionalFormattingRule`
  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()

  Description copied from interface: `ConditionalFormattingRule`
  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

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