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

    public final class HSSFConditionalFormattingRule

extends java.lang.Object

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

Method Summary
`HSSFBorderFormatting` | `createBorderFormatting()` create a new border formatting structure if it does not exist, otherwise just return existing object.
`HSSFFontFormatting` | `createFontFormatting()` create a new font formatting structure if it does not exist, otherwise just return existing object.
`HSSFPatternFormatting` | `createPatternFormatting()` create a new pattern formatting structure if it does not exist, otherwise just return existing object.
`HSSFBorderFormatting` | `getBorderFormatting()`
`byte` | `getComparisonOperation()`
`byte` | `getConditionType()`
`HSSFFontFormatting` | `getFontFormatting()`
`java.lang.String` | `getFormula1()`
`java.lang.String` | `getFormula2()`
`HSSFPatternFormatting` | `getPatternFormatting()`

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

Method Detail

### getFontFormatting

    public HSSFFontFormatting getFontFormatting()

  Returns:
    - font formatting object if defined, `null` otherwise

### createFontFormatting

    public HSSFFontFormatting createFontFormatting()

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

  Returns:
    - font formatting object, never returns `null`.

### getBorderFormatting

    public HSSFBorderFormatting getBorderFormatting()

  Returns:
    - border formatting object if defined, `null` otherwise

### createBorderFormatting

    public HSSFBorderFormatting createBorderFormatting()

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

  Returns:
    - border formatting object, never returns `null`.

### getPatternFormatting

    public HSSFPatternFormatting getPatternFormatting()

  Returns:
    - pattern formatting object if defined, `null` otherwise

### createPatternFormatting

    public HSSFPatternFormatting createPatternFormatting()

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

  Returns:
    - pattern formatting object, never returns `null`.

### getConditionType

    public byte getConditionType()

  Returns:
    - the conditiontype for the cfrule

### getComparisonOperation

    public byte getComparisonOperation()

  Returns:
    - the comparisionoperatation for the cfrule

### getFormula1

    public java.lang.String getFormula1()

### getFormula2

    public java.lang.String getFormula2()

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