Method Detail

• createBorderFormatting

  BorderFormatting createBorderFormatting()

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

  Returns:

  - border formatting object, never returns null.

• getBorderFormatting

  BorderFormatting getBorderFormatting()

  Returns:

  - border formatting object if defined, null otherwise

• createFontFormatting

  FontFormatting createFontFormatting()

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

  Returns:

  - font formatting object, never returns null.

• getFontFormatting

  FontFormatting getFontFormatting()

  Returns:

  - font formatting object if defined, null otherwise

• createPatternFormatting

  PatternFormatting createPatternFormatting()

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

  Returns:

  - pattern formatting object, never returns null.

• getPatternFormatting

  PatternFormatting getPatternFormatting()

  Returns:

  - pattern formatting object if defined, null otherwise

• getDataBarFormatting

  DataBarFormatting getDataBarFormatting()

  Returns:

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

• getMultiStateFormatting

  IconMultiStateFormatting getMultiStateFormatting()

  Returns:

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

• getColorScaleFormatting

  ColorScaleFormatting getColorScaleFormatting()

  Returns:

  color scale / color grate formatting object if defined, null otherwise

• getConditionType

  ConditionType getConditionType()

  Type of conditional formatting rule.

  Returns:

  the type of condition

• getComparisonOperation

  byte 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:

  the conditional format operator

• getFormula1

  java.lang.String 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:

  the first formula

• getFormula2

  java.lang.String 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:

  the second formula