CellFormatCondition (POI API Documentation)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.poi.ss.format
Class CellFormatCondition

java.lang.Object
  org.apache.poi.ss.format.CellFormatCondition

This object represents a condition in a cell format.

Constructor Summary
`CellFormatCondition()`

Method Summary
`static CellFormatCondition`	`getInstance(java.lang.String opString, java.lang.String constStr)` Returns an instance of a condition object.
`abstract boolean`	`pass(double value)` Returns `true` if the given value passes the constraint's test.

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

Constructor Detail

public CellFormatCondition()

Method Detail

public static CellFormatCondition getInstance(java.lang.String opString,
                                              java.lang.String constStr)

Returns an instance of a condition object.

Parameters:: opString - The operator as a string. One of "<", "<=", ">", ">=", "=", "==", "!=", or "<>".; constStr - The constant (such as "12").
Returns:: A condition object for the given condition.

public abstract boolean pass(double value)

Returns true if the given value passes the constraint's test.