Cf (OpenXLS Java Spreadsheet SDK 11.0.4 API)

java.lang.Object
- io.starter.formats.XLS.XLSRecord
- - io.starter.formats.XLS.Cf

All Implemented Interfaces:

BlockByteConsumer, BiffRec, XLSConstants, Serializable
```
public final class Cf
extends XLSRecord
```
Cf: Conditional Formatting Conditions 0x1B1
This record stores a conditional formatting condition There are some restrictions in the usage of conditional formattings: In the user interface it is possible to modify the font style (boldness and posture), the text colour, the underline style and the strikeout style. It is not possible to change the used font, the font height, and the escapement style, though it is possible to specify a new font height and escapement style in this record which are correctly displayed It is not possible to change a border line style, but to preserve the line colour, and vice versa. Diagonal lines are not supported at all. The user interface only offers thin line styles, but files containing other line styles work correctly too. It is not possible to set the background pattern colour to No colour (using system window background OFFSET NAME SIZE CONTENTS ----- 4 ct 1 Conditional formatting type 5 cp 1 Conditional formatting operator 6 cce1 2 Count of bytes in rgce1 -- size of formula data for first value or formula 8 cce2 2 Count of bytes in rgce2 -- size of formula data for first value or formula: used for second part of 'between' and 'not between' comparison, else 0 10 4 Option flags (see below) 2 Not used 16 118 (optional, only if font = 1, see option flags) Font formatting block, see below var 8 (optional, only if bord = 1, see option flags) Border formatting block, see below var 4 (optional, only if patt = 1, see option flags) Pattern formatting block, see below var rgbdxf var Conditional format to apply var rgce1 var First formula for this condition (RPN token array without size field, ?4) var rgce2 var Second formula for this condition (RPN token array without size field, ?4) Conditional formatting operator: 00H = No comparison (only valid for formula type, see above) 01H = Between 05H = Greater than 02H = Not between 06H = Less than 03H = Equal 07H = Greater or equal 04H = Not equal 08H = Less or equal Option Flags If none of the formatting attributes is set, the option flags field contains 00000000H. The following table assumes that the conditional formatting contains at least one modified formatting attribute (it will occur at least one of the formatting information blocks in the record). In difference to the first case some of the bits are always set now. All flags specifying that an attribute is modified are 02, if the conditional formatting changes the respective attribute, and 12, if the original cell formatting is preserved. The flags for modified font attributes are not contained in this option flags field, but in the font formatting block itself. ! Bit Mask Contents 9-0 000003FFH Always 11.1111.11112 (but not used) 10 00000400H 0 = Left border style and colour modified (bord - left ) 11 00000800H 0 = Right border style and colour modified (bord - right ) 12 00001000H 0 = Top border style and colour modified (bord - top ) 13 00002000H 0 = Bottom border style and colour modified (bord - bot ) 15-14 0000C000H Always 112 (but not used) 16 00010000H 0 = Pattern style modified (patt - style ) 17 00020000H 0 = Pattern colour modified (patt - col ) 18 00040000H 0 = Pattern background colour modified (patt - bgcol ) 21-19 00380000H Always 1112 (but not used) 26 04000000H 1 = Record contains font formatting block (font) 28 10000000H 1 = Record contains border formatting block (bord) 29 20000000H 1 = Record contains pattern formatting block (patt)

See Also:

Condfmt, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BORDER_LINECOLOR_BOTTOM`
`static int`	`BORDER_LINECOLOR_LEFT`
`static int`	`BORDER_LINECOLOR_RIGHT`
`static int`	`BORDER_LINECOLOR_TOP`
`static int`	`BORDER_LINESTYLE_BOTTOM`
`static int`	`BORDER_LINESTYLE_LEFT` Border Formatting Block
`static int`	`BORDER_LINESTYLE_RIGHT`
`static int`	`BORDER_LINESTYLE_TOP`
`static int`	`BORDER_MODIFIED_BOTTOM`
`static int`	`BORDER_MODIFIED_LEFT`
`static int`	`BORDER_MODIFIED_RIGHT`
`static int`	`BORDER_MODIFIED_TOP`
`static int`	`FONT_ESCAPEMENT_NONE`
`static int`	`FONT_ESCAPEMENT_SUB`
`static int`	`FONT_ESCAPEMENT_SUPER`
`static int`	`FONT_MODIFIED_OPTIONS_CANCELLATIONS`
`static int`	`FONT_MODIFIED_OPTIONS_STYLE`
`static int`	`FONT_OPTIONS_CANCELLATION`
`static int`	`FONT_OPTIONS_CANCELLATION_OFF`
`static int`	`FONT_OPTIONS_CANCELLATION_ON`
`static int`	`FONT_OPTIONS_POSTURE`
`static int`	`FONT_OPTIONS_POSTURE_ITALIC`
`static int`	`FONT_OPTIONS_POSTURE_NORMAL`
`static int`	`FONT_UNDERLINE_DOUBLE`
`static int`	`FONT_UNDERLINE_DOUBLEACCOUNTING`
`static int`	`FONT_UNDERLINE_NONE`
`static int`	`FONT_UNDERLINE_SINGLE`
`static int`	`FONT_UNDERLINE_SINGLEACCOUNTING`
`static int`	`PATTERN_FILL_BACK_COLOR`
`static int`	`PATTERN_FILL_COLOR`
`static int`	`PATTERN_FILL_STYLE`

Fields inherited from class io.starter.formats.XLS.XLSRecord
col, continues, DEBUGLEVEL, hyperlink, idx, isBlank, isBoolean, isContinueMerged, isString, lastidx, myxf, offset, rw, streamer, wkbook, worksheet

Fields inherited from interface io.starter.formats.XLS.XLSConstants
AI, ALLOWDUPES, ALRUNS, AREA, AREAFORMAT, ARRAY, ATTACHEDLABEL, AUTOFILTER, AXCENT, AXESUSED, AXIS, AXISLINEFORMAT, AXISPARENT, BACKUP, BAR, BEGIN, BLANK, BOF, BOOKBOOL, BOOLERR, BOPPOP, BOPPOPCUSTOM, BOTTOM_MARGIN, BOTTOMMARGIN, BOUNDSHEET, CALC_MODE_PROP, CALCCOUNT, CALCMODE, CALCULATE_ALWAYS, CALCULATE_AUTO, CALCULATE_EXPLICIT, CATLAB, CATSERRANGE, CF, CF12, CHART, CHART3DBARSHAPE, CHARTFORMAT, CHARTFORMATLINK, CHARTFRTINFO, CHARTLINE, CODENAME, COLINFO, CONDFMT, CONDFMT12, CONTINUE, COUNTRY, CRN, CRTLAYOUT12, CRTLAYOUT12A, DAT, DATAFORMAT, DATALABEXT, DATALABEXTCONTENTS, DATE1904, DBCELL, DCON, DCONBIN, DCONNAME, DCONREF, DEBUG_HIGH, DEBUG_LOW, DEBUG_MEDIUM, DEFAULTENCODING, DEFAULTROWHEIGHT, DEFAULTTEXT, DEFCOLWIDTH, DELTA, DIMENSIONS, DROPBAR, DSF, DV, DVAL, END, ENDBLOCK, ENDEXTSST, ENDOBJECT, EOF, EXCEL2K, EXTERNCOUNT, EXTERNNAME, EXTERNSHEET, EXTSST, FBI, FEATHEADR, FILE_LOCK, FILEPASS, FONT, FONTBASIS, FONTX, FOOTERREC, FORMAT, FORMULA, FRAME, FRTFONTLIST, FRTWRAPPER, GARBAGE, GELFRAME, GUTS, HCENTER, HEADERREC, HLINK, HORIZONTAL_PAGE_BREAKS, IFMT, INDEX, INTERFACE_HDR, ITERATION, LABEL, LABELSST, LEFT_MARGIN, LEFTMARGIN, LEGEND, LEGENDXN, LINE, LINEFORMAT, MARKERFORMAT, MAXCOLS, MAXCOLS_BIFF8, MAXRECLEN, MAXROWS, MAXROWS_BIFF8, MERGEDCELLS, MSODRAWING, MSODRAWINGGROUP, MSODRAWINGSELECTION, MULBLANK, MULRK, NAME, NOTE, NUMBER, OBJ, OBJECTLINK, OBJPROTECT, OBPROJ, PALETTE, PANE, PASSWORD, PHONETIC, PICF, PIE, PIEFORMAT, PIVOTCHARTBITS, PIVOTCHARTLINK, PLOTAREA, PLOTGROWTH, PLS, PLV, POS, PRECISION, PRINT_GRIDLINES, PRINT_ROW_HEADERS, PRINTGRID, PRINTROWCOL, PROT4REV, PROTECT, QSISXTAG, RADAR, RADARAREA, RANGEPROTECTION, REFMODE, REFTRACK_PROP, RIGHT_MARGIN, RIGHTMARGIN, RK, ROW, RRD_HEAD, RRD_INFO, RSTRING, RTENTEXU, RTMERGECELLS, SBASEREF, SCATTER, SCENPROTECT, SCL, SELECTION, SERAUXERRBAR, SERAUXTREND, SERFMT, SERIES, SERIESLIST, SERIESTEXT, SERPARENT, SERTOCRT, SETUP, SHAREDUPES, SHEETLAYOUT, SHEETPROTECTION, SHRFMLA, SHTPROPS, SIIINDEX, SST, STARTBLOCK, STARTOBJECT, STRING_ENCODING_AUTO, STRING_ENCODING_COMPRESSED, STRING_ENCODING_UNICODE, STRINGREC, STYLE, SUPBOOK, SURFACE, SXADDL, SXBOOL, SXDB, SXDBB, SXDBEX, SXDI, SXEX, SXFDB, SXFDBTYPE, SXFORMAT, SXIVD, SXLI, SXNUM, SXPI, SXSTREAMID, SXSTRING, SXVD, SXVDEX, SXVI, SXVIEW, SXVIEWEX9, SXVIEWLINK, SXVS, TABID, TABLE, TABLESTYLES, TEXTDISP, THREED, TICK, TOP_MARGIN, TOPMARGIN, TXO, TYPE_BLANK, TYPE_BOOLEAN, TYPE_DOUBLE, TYPE_FORMULA, TYPE_FP, TYPE_INT, TYPE_STRING, UNICODEENCODING, UNITS, USERBVIEW, USERSVIEWBEGIN, USERSVIEWEND, USETEMPFILE_PROP, USR_EXCL, VALIDATEWORKBOOK, VALUERANGE, VB_MODULE, VCENTER, VERTICAL_PAGE_BREAKS, WINDOW_PROTECT, WINDOW1, WINDOW2, WK_CHART, WK_FILE, WK_GLOBALS, WK_MACROSHEET, WK_WORKSHEET, WSBOOL, XCT, XF, XLS_MAX_COLS, YMULT

Constructor Summary

Constructors
Constructor and Description
`Cf()` default constructor
`Cf(Condfmt f)` constructor which takes the cellrange of cells and the Condfmt that reference this conditional format rule

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`evaluate(Ptg refcell)` pass in the referenced cell and attempt to create a valid formula for this thing and calculate whether the criteria passes returns true or false
`int[]`	`getAllBorderColors()`
`Color[]`	`getBorderColors()`
`int`	`getBorderLineColorBottom()`
`int`	`getBorderLineColorLeft()`
`int`	`getBorderLineColorRight()`
`int`	`getBorderLineColorTop()`
`int`	`getBorderLineStylesBottom()`
`int`	`getBorderLineStylesLeft()`
`int`	`getBorderLineStylesRight()`
`int`	`getBorderLineStylesTop()`
`int[]`	`getBorderSizes()`
`int[]`	`getBorderStyles()` order= top, left, bottom, right
`Condfmt`	`getCondfmt()`
`static byte`	`getConditionFromString(String cx)` Returns the byte Condition type from a human-readable string
`String`	`getConditionString()` Returns the human-readable Condition type
`Fill`	`getFill()` return the 2007v Fill element, or null if not set
`Font`	`getFont()` returns the existing font record for this Cell
`int`	`getFontColorIndex()`
`int`	`getFontEscapement()`
`boolean`	`getFontEscapementSub()`
`boolean`	`getFontEscapementSuper()`
`int`	`getFontHeight()`
`boolean`	`getFontItalic()`
`int`	`getFontOptsCancellation()`
`int`	`getFontOptsPosture()`
`boolean`	`getFontStriken()`
`int`	`getFontUnderlineStyle()`
`int`	`getFontWeight()`
`int`	`getForegroundColor()`
`Formula`	`getFormula1()` return the first formula referenced by the Conditional Format
`Formula`	`getFormula2()` return the second formula referenced by the Conditional Format
`String`	`getOOXML(WorkBookHandle bk, int priority, ArrayList dxfs)` generate OOXML for this Cf (BIFF8->OOXML) attributes: type, dxfId, priority (REQ), stopIfTrue, aboveAverage, percent, bottom, operator, text, timePeriod, rank, stdDev, equalAverage children: SEQ: formula (0-3), colorScale, dataBar, iconSet
`short`	`getOperator()` returns the operator or qualifier of this Cf Rue as an int value possible values:
`String`	`getPatternBgColor()` returns the pattern background color, if any, as an HTML color String.
`String`	`getPatternFgColor()` returns the pattern color, if any, as an HTML color String.
`int`	`getPatternFillColor()`
`int`	`getPatternFillColorBack()`
`int`	`getPatternFillStyle()` Returns the patternFillStyle.
`protected static XLSRecord`	`getPrototype()` Create a Cf record & populate with prototype bytes
`short`	`getType()` return the type of this Cf Rule as an int
`String`	`getTypeString()` reutrn the string representation of this Cf Rule type
`String`	`getXML()` returns EXML (XMLSS) for the Conditional Format Rule R12C2:R16C2 Between 2 4 R6C2 NOT(ISERROR(SEARCH("yes",RC)))
`void`	`init()` initialize the Cf record
`static Cf`	`parseXML(org.xmlpull.v1.XmlPullParser xpp, Condfmt cfx, Boundsheet bs)` creates a Cf record from the EXML nodes Between 2 4
`void`	`setBorderLineColorBottom(int b)`
`void`	`setBorderLineColorLeft(int borderLineColorLeft)`
`void`	`setBorderLineColorRight(int borderLineColorRight)`
`void`	`setBorderLineColorTop(int b)`
`void`	`setBorderLineStylesBottom(int b)`
`void`	`setBorderLineStylesLeft(int b)`
`void`	`setBorderLineStylesRight(int b)`
`void`	`setBorderLineStylesTop(int b)`
`void`	`setCondfmt(Condfmt condfmt)`
`void`	`setCondition1(String s)` sets the first condition from a String
`void`	`setCondition2(String s)` sets the second condition from a String
`void`	`setContainsText(String s)` OOXML-specific, in a containsText-type condition, this field is the comparitor
`void`	`setFontColorIndex(int fontColorIndex)`
`void`	`setFontEscapement(int fontEscapementFlag)`
`void`	`setFontEscapementSub()` sets the font escapement for this conditional format to subscript
`void`	`setFontEscapementSuper()` sets the font escapement for this conditional format to superscript
`void`	`setFontHeight(int fontHeight)`
`void`	`setFontItalic(boolean italic)`
`void`	`setFontOptsPosture(int fontOptsPosture)`
`void`	`setFontStriken(boolean bStriken)`
`void`	`setFontUnderlineStyle(int fontUnderlineStyle)`
`void`	`setFontWeight(int f)`
`void`	`setOperator(int op)` sets the Operator of this Cf Rule possible values:
`void`	`setOperator(String s)` sets the operator for this Cf Rule from a String
`void`	`setPatternFillColor(int p, String custom)`
`void`	`setPatternFillColorBack(int p)`
`void`	`setPatternFillStyle(int p)`
`static void`	`setStylePropsFromDxf(Dxf dxf, Cf cf)` set the conditional format format settings from the OOXML dxf, or differential xf, format settings
`static void`	`setStylePropsFromString(String style, Cf cx)` helper method to set the style values on this object from a style string each name/value pair is delimited by ; possible tokens: pattern pattern fill # color pattern fg color patterncolor pattern bg color vertical vertical alignnment horizontal horizontal alignment border sub-tokens: border-top, border-left, border-bottom, border-top
`protected void`	`setType(int type)` sets the type of this Cf rule from the int value
`protected static int`	`translateOOXMLType(String type)` takes a String representing the type attribute and translates it to the corresponding integer representation IMPORTANT NOTE: OOXML-specific types are converted to an integer that is not valid in 2003 versions
`protected static int`	`translateOperator(String operator)` taks a String representing the Operator for this Cf Rule and translates it to an int NOTE: 2003 versions do not use types 0x9, 0xA, 0xB or 0xC
`protected static String`	`translateType(int type)` Given an int type, return it's string representation NOTE: if type is between 3 and 18, it is an OOXML-specific type.
`void`	`updateBorderLineColorsFlag()` Apply all the borderLineColor fields into the current border line colors flag
`void`	`updateBorderLineStylesFlag()` Apply all the borderLineStyle fields into the current border line styles flag
`void`	`updatePatternFillColorsFlag()` Apply all the patternFillColor fields into the current pattern colors flag

Methods inherited from class io.starter.formats.XLS.XLSRecord
addContinue, clone, close, copyFormat, getBooleanVal, getByteAt, getByteReader, getBytes, getBytesAt, getCellAddress, getCellAddressWithSheet, getCellType, getColNumber, getColorTable, getContinueVect, getData, getDataType, getDblVal, getDefaultVal, getEncryptedByteReader, getFirstBlock, getFloatVal, getFormatPattern, getFormulaRec, getHyperlink, getInternalVal, getIntLocation, getIntVal, getIxfe, getLastBlock, getLength, getMergeRange, getOffset, getOpcode, getRealRecordIndex, getRecDesc, getRecordIndex, getRow, getRowNumber, getSheet, getStreamer, getStringVal, getStringVal, getWorkBook, getXfRec, hasContinues, initRowCol, isFormula, isNumber, isReadOnly, isValueForCell, mergeContinues, postStream, preStream, remove, removeContinues, resetCacheBytes, setBooleanVal, setByteReader, setCol, setData, setDebugLevel, setDoubleVal, setEncryptedByteReader, setFirstBlock, setFloatVal, setHyperlink, setIndex, setIntVal, setIsValueForCell, setIxfe, setLastBlock, setLength, setMergeRange, setOffset, setOpcode, setRow, setRowCol, setRowNumber, setSheet, setStreamer, setStringVal, setValueForCell, setWorkBook, setXFRecord, setXFRecord, shouldEncrypt, toHexDump, toString

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

- Field Detail
  - PATTERN_FILL_STYLE
```
public static final int PATTERN_FILL_STYLE
```
    See Also:
    
    Constant Field Values
  - PATTERN_FILL_COLOR
```
public static final int PATTERN_FILL_COLOR
```
    See Also:
    
    Constant Field Values
  - PATTERN_FILL_BACK_COLOR
```
public static final int PATTERN_FILL_BACK_COLOR
```
    See Also:
    
    Constant Field Values
  - FONT_OPTIONS_POSTURE
```
public static final int FONT_OPTIONS_POSTURE
```
    See Also:
    
    Constant Field Values
  - FONT_OPTIONS_CANCELLATION
```
public static final int FONT_OPTIONS_CANCELLATION
```
    See Also:
    
    Constant Field Values
  - FONT_OPTIONS_POSTURE_NORMAL
```
public static final int FONT_OPTIONS_POSTURE_NORMAL
```
    See Also:
    
    Constant Field Values
  - FONT_OPTIONS_POSTURE_ITALIC
```
public static final int FONT_OPTIONS_POSTURE_ITALIC
```
    See Also:
    
    Constant Field Values
  - FONT_OPTIONS_CANCELLATION_OFF
```
public static final int FONT_OPTIONS_CANCELLATION_OFF
```
    See Also:
    
    Constant Field Values
  - FONT_OPTIONS_CANCELLATION_ON
```
public static final int FONT_OPTIONS_CANCELLATION_ON
```
    See Also:
    
    Constant Field Values
  - FONT_ESCAPEMENT_NONE
```
public static final int FONT_ESCAPEMENT_NONE
```
    See Also:
    
    Constant Field Values
  - FONT_ESCAPEMENT_SUPER
```
public static final int FONT_ESCAPEMENT_SUPER
```
    See Also:
    
    Constant Field Values
  - FONT_ESCAPEMENT_SUB
```
public static final int FONT_ESCAPEMENT_SUB
```
    See Also:
    
    Constant Field Values
  - FONT_UNDERLINE_NONE
```
public static final int FONT_UNDERLINE_NONE
```
    See Also:
    
    Constant Field Values
  - FONT_UNDERLINE_SINGLE
```
public static final int FONT_UNDERLINE_SINGLE
```
    See Also:
    
    Constant Field Values
  - FONT_UNDERLINE_DOUBLE
```
public static final int FONT_UNDERLINE_DOUBLE
```
    See Also:
    
    Constant Field Values
  - FONT_UNDERLINE_SINGLEACCOUNTING
```
public static final int FONT_UNDERLINE_SINGLEACCOUNTING
```
    See Also:
    
    Constant Field Values
  - FONT_UNDERLINE_DOUBLEACCOUNTING
```
public static final int FONT_UNDERLINE_DOUBLEACCOUNTING
```
    See Also:
    
    Constant Field Values
  - FONT_MODIFIED_OPTIONS_STYLE
```
public static final int FONT_MODIFIED_OPTIONS_STYLE
```
    See Also:
    
    Constant Field Values
  - FONT_MODIFIED_OPTIONS_CANCELLATIONS
```
public static final int FONT_MODIFIED_OPTIONS_CANCELLATIONS
```
    See Also:
    
    Constant Field Values
  - BORDER_LINESTYLE_LEFT
```
public static final int BORDER_LINESTYLE_LEFT
```
    Border Formatting Block
    
    See Also:
    
    Constant Field Values
  - BORDER_LINESTYLE_RIGHT
```
public static final int BORDER_LINESTYLE_RIGHT
```
    See Also:
    
    Constant Field Values
  - BORDER_LINESTYLE_TOP
```
public static final int BORDER_LINESTYLE_TOP
```
    See Also:
    
    Constant Field Values
  - BORDER_LINESTYLE_BOTTOM
```
public static final int BORDER_LINESTYLE_BOTTOM
```
    See Also:
    
    Constant Field Values
  - BORDER_MODIFIED_LEFT
```
public static final int BORDER_MODIFIED_LEFT
```
    See Also:
    
    Constant Field Values
  - BORDER_MODIFIED_RIGHT
```
public static final int BORDER_MODIFIED_RIGHT
```
    See Also:
    
    Constant Field Values
  - BORDER_MODIFIED_TOP
```
public static final int BORDER_MODIFIED_TOP
```
    See Also:
    
    Constant Field Values
  - BORDER_MODIFIED_BOTTOM
```
public static final int BORDER_MODIFIED_BOTTOM
```
    See Also:
    
    Constant Field Values
  - BORDER_LINECOLOR_LEFT
```
public static final int BORDER_LINECOLOR_LEFT
```
    See Also:
    
    Constant Field Values
  - BORDER_LINECOLOR_RIGHT
```
public static final int BORDER_LINECOLOR_RIGHT
```
    See Also:
    
    Constant Field Values
  - BORDER_LINECOLOR_TOP
```
public static final int BORDER_LINECOLOR_TOP
```
    See Also:
    
    Constant Field Values
  - BORDER_LINECOLOR_BOTTOM
```
public static final int BORDER_LINECOLOR_BOTTOM
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Cf
```
public Cf()
```
    default constructor
  - Cf
```
public Cf(Condfmt f)
```
    constructor which takes the cellrange of cells and the Condfmt that reference this conditional format rule
    
    Parameters:
    
    f - the condfmt
    
    r - the cellrange
- Method Detail
  - init
```
public void init()
```
    initialize the Cf record
    
    Specified by:
    
    init in interface BiffRec
    
    Overrides:
    
    init in class XLSRecord
  - setStylePropsFromString
```
public static void setStylePropsFromString(String style,
                                           Cf cx)
```
    helper method to set the style values on this object from a style string
    each name/value pair is delimited by ;
    possible tokens:
    pattern pattern fill #
    color pattern fg color
    patterncolor pattern bg color
    vertical vertical alignnment
    horizontal horizontal alignment
    border sub-tokens: border-top, border-left, border-bottom, border-top
    
    Parameters:
    
    style -
    
    cx -
  - setStylePropsFromDxf
```
public static void setStylePropsFromDxf(Dxf dxf,
                                        Cf cf)
```
    set the conditional format format settings from the OOXML dxf, or differential xf, format settings
    
    Parameters:
    
    dxf -
    
    cf -
  - setOperator
```
public void setOperator(String s)
```
    sets the operator for this Cf Rule from a String
    
    Parameters:
    
    s -
  - setOperator
```
public void setOperator(int op)
```
    sets the Operator of this Cf Rule
    possible values:
    0= no comparison
    1= between
    2= not between
    3= equal
    4= not equal
    5= greater than
    6= less than
    7= greater than or equal
    8= less than or equal 2007-specific operators
    9= begins With
    10= ends With
    11= contains Text
    12= not contains
    
    Parameters:
    
    int - qualifier - constant value as above
  - getOperator
```
public short getOperator()
```
    returns the operator or qualifier of this Cf Rue as an int value
    possible values:
    0= no comparison
    1= between
    2= not between
    3= equal
    4= not equal
    5= greater than
    6= less than
    7= greater than or equal
    8= less than or equal 2007-specific operators
    9= begins With
    10= ends With
    11= contains Text
    12= not contains
    
    Returns:
  - setType
```
protected void setType(int type)
```
    sets the type of this Cf rule from the int value
    1= Cell is ("Cell value is")
    2= expression ("formula value is")
    
    Parameters:
    
    int - type as above
  - getType
```
public short getType()
```
    return the type of this Cf Rule as an int
    1= Cell is ("Cell value is")
    2= expression ("formula value is")
    
    Returns:
  - getTypeString
```
public String getTypeString()
```
    reutrn the string representation of this Cf Rule type
    
    Returns:
  - setCondition1
```
public void setCondition1(String s)
```
    sets the first condition from a String
    
    Parameters:
    
    s -
  - setCondition2
```
public void setCondition2(String s)
```
    sets the second condition from a String
    
    Parameters:
    
    s -
  - getCondfmt
```
public Condfmt getCondfmt()
```
    Returns:
    
    Returns the condfmt.
  - setCondfmt
```
public void setCondfmt(Condfmt condfmt)
```
    Parameters:
    
    condfmt - The condfmt to set.
  - getFontEscapement
```
public int getFontEscapement()
```
    Returns:
    
    Returns the fontEscapementFlag.
  - getPatternFgColor
```
public String getPatternFgColor()
```
    returns the pattern color, if any, as an HTML color String. Includes custom OOXML colors.
    
    Returns:
    
    String HTML Color String
  - getPatternBgColor
```
public String getPatternBgColor()
```
    returns the pattern background color, if any, as an HTML color String. Includes custom OOXML colors.
    
    Returns:
    
    String HTML Color String
  - setFontEscapement
```
public void setFontEscapement(int fontEscapementFlag)
```
    Parameters:
    
    fontEscapementFlag - The fontEscapementFlag to set.
  - updateBorderLineStylesFlag
```
public void updateBorderLineStylesFlag()
```
    Apply all the borderLineStyle fields into the current border line styles flag
  - updateBorderLineColorsFlag
```
public void updateBorderLineColorsFlag()
```
    Apply all the borderLineColor fields into the current border line colors flag
  - getFill
```
public Fill getFill()
```
    return the 2007v Fill element, or null if not set
  - updatePatternFillColorsFlag
```
public void updatePatternFillColorsFlag()
```
    Apply all the patternFillColor fields into the current pattern colors flag
  - getFont
```
public Font getFont()
```
    Description copied from class: XLSRecord
    
    returns the existing font record for this Cell
    
    Specified by:
    
    getFont in interface BiffRec
    
    Overrides:
    
    getFont in class XLSRecord
  - getBorderColors
```
public Color[] getBorderColors()
```
  - getAllBorderColors
```
public int[] getAllBorderColors()
```
  - getBorderStyles
```
public int[] getBorderStyles()
```
    order= top, left, bottom, right
    
    Returns:
  - getBorderSizes
```
public int[] getBorderSizes()
```
  - getForegroundColor
```
public int getForegroundColor()
```
  - getFontOptsPosture
```
public int getFontOptsPosture()
```
    Returns:
    
    Returns the fontOptsPosture.
  - setFontOptsPosture
```
public void setFontOptsPosture(int fontOptsPosture)
```
    Parameters:
    
    fontOptsPosture - The fontOptsPosture to set.
  - getFontOptsCancellation
```
public int getFontOptsCancellation()
```
    Returns:
    
    Returns the fontOptsCancellation.
  - getFontItalic
```
public boolean getFontItalic()
```
    Returns:
    
    Returns the fontOptsItalic.
  - setFontItalic
```
public void setFontItalic(boolean italic)
```
    Parameters:
    
    fontOptsItalic - The fontOptsItalic to set.
  - getFontStriken
```
public boolean getFontStriken()
```
  - setFontStriken
```
public void setFontStriken(boolean bStriken)
```
  - getFontEscapementSuper
```
public boolean getFontEscapementSuper()
```
    Returns:
    
    Returns true if font escapement is superscript
  - setFontEscapementSuper
```
public void setFontEscapementSuper()
```
    sets the font escapement for this conditional format to superscript
  - getFontEscapementSub
```
public boolean getFontEscapementSub()
```
    Returns:
    
    Returns true if font escapement is subscript
  - setFontEscapementSub
```
public void setFontEscapementSub()
```
    sets the font escapement for this conditional format to subscript
  - getBorderLineStylesLeft
```
public int getBorderLineStylesLeft()
```
    Returns:
    
    Returns the borderLineStylesLeft.
  - setBorderLineStylesLeft
```
public void setBorderLineStylesLeft(int b)
```
    Parameters:
    
    borderLineStylesLeft - The borderLineStylesLeft to set.
  - getBorderLineStylesRight
```
public int getBorderLineStylesRight()
```
    Returns:
    
    Returns the borderLineStylesRight.
  - setBorderLineStylesRight
```
public void setBorderLineStylesRight(int b)
```
    Parameters:
    
    borderLineStylesRight - The borderLineStylesRight to set.
  - getBorderLineStylesTop
```
public int getBorderLineStylesTop()
```
    Returns:
    
    Returns the borderLineStylesTop.
  - setBorderLineStylesTop
```
public void setBorderLineStylesTop(int b)
```
    Parameters:
    
    borderLineStylesTop - The borderLineStylesTop to set.
  - getBorderLineStylesBottom
```
public int getBorderLineStylesBottom()
```
    Returns:
    
    Returns the borderLineStylesBottom.
  - setBorderLineStylesBottom
```
public void setBorderLineStylesBottom(int b)
```
    Parameters:
    
    borderLineStylesBottom - The borderLineStylesBottom to set.
  - getBorderLineColorLeft
```
public int getBorderLineColorLeft()
```
    Returns:
    
    Returns the borderLineColorLeft.
  - setBorderLineColorLeft
```
public void setBorderLineColorLeft(int borderLineColorLeft)
```
    Parameters:
    
    borderLineColorLeft - The borderLineColorLeft to set.
  - getBorderLineColorRight
```
public int getBorderLineColorRight()
```
    Returns:
    
    Returns the borderLineColorRight.
  - setBorderLineColorRight
```
public void setBorderLineColorRight(int borderLineColorRight)
```
    Parameters:
    
    borderLineColorRight - The borderLineColorRight to set.
  - getBorderLineColorTop
```
public int getBorderLineColorTop()
```
    Returns:
    
    Returns the borderLineColorTop.
  - setBorderLineColorTop
```
public void setBorderLineColorTop(int b)
```
    Parameters:
    
    borderLineColorTop - The borderLineColorTop to set.
  - getBorderLineColorBottom
```
public int getBorderLineColorBottom()
```
    Returns:
    
    Returns the borderLineColorBottom.
  - setBorderLineColorBottom
```
public void setBorderLineColorBottom(int b)
```
    Parameters:
    
    borderLineColorBottom - The borderLineColorBottom to set.
  - getPatternFillStyle
```
public int getPatternFillStyle()
```
    Returns the patternFillStyle.
    NOTE in 2003-ver patternFillStyle is valid 1->
    
    Returns:
    
    Returns the patternFillStyle.
  - setPatternFillStyle
```
public void setPatternFillStyle(int p)
```
    Parameters:
    
    patternFillStyle - The patternFillStyle to set.
  - getPatternFillColor
```
public int getPatternFillColor()
```
    Returns:
    
    Returns the patternFillColor.
  - setPatternFillColor
```
public void setPatternFillColor(int p,
                                String custom)
```
    Parameters:
    
    patternFillColor - The patternFillColor to set.
  - getPatternFillColorBack
```
public int getPatternFillColorBack()
```
    Returns:
    
    Returns the patternFillColorBack.
  - setPatternFillColorBack
```
public void setPatternFillColorBack(int p)
```
    Parameters:
    
    patternFillColorBack - The patternFillColorBack to set.
  - getFontHeight
```
public int getFontHeight()
```
    Returns:
    
    Returns the fontHeight.
  - setFontHeight
```
public void setFontHeight(int fontHeight)
```
    Parameters:
    
    fontHeight - The fontHeight to set.
  - getFontWeight
```
public int getFontWeight()
```
    Returns:
    
    Returns the fontWeight.
  - setFontWeight
```
public void setFontWeight(int f)
```
    Parameters:
    
    fontWeight - The fontWeight to set.
  - getFontUnderlineStyle
```
public int getFontUnderlineStyle()
```
    Returns:
    
    Returns the fontUnderlineStyle.
  - setFontUnderlineStyle
```
public void setFontUnderlineStyle(int fontUnderlineStyle)
```
    Parameters:
    
    fontUnderlineStyle - The fontUnderlineStyle to set.
  - getFontColorIndex
```
public int getFontColorIndex()
```
    Returns:
    
    Returns the fontColorIndex.
  - setFontColorIndex
```
public void setFontColorIndex(int fontColorIndex)
```
    Parameters:
    
    fontColorIndex - The fontColorIndex to set.
  - getPrototype
```
protected static XLSRecord getPrototype()
```
    Create a Cf record & populate with prototype bytes
    
    Returns:
    
    TODO: NOT FINISHED
  - evaluate
```
public boolean evaluate(Ptg refcell)
```
    pass in the referenced cell and attempt to create a valid formula for this thing and calculate whether the criteria passes returns true or false
    
    Parameters:
    
    the - reference to evaluate
    
    Returns:
    
    boolean passes
  - getConditionFromString
```
public static final byte getConditionFromString(String cx)
```
    Returns the byte Condition type from a human-readable string
    
    Returns:
    
    the condition type for this rule
  - getConditionString
```
public String getConditionString()
```
    Returns the human-readable Condition type
    
    Returns:
    
    the condition type for this rule
  - getFormula1
```
public Formula getFormula1()
```
    return the first formula referenced by the Conditional Format
    
    Returns:
    
    Formula
  - getFormula2
```
public Formula getFormula2()
```
    return the second formula referenced by the Conditional Format
    
    Returns:
    
    Formula
  - translateOperator
```
protected static int translateOperator(String operator)
```
    taks a String representing the Operator for this Cf Rule and translates it to an int
    NOTE: 2003 versions do not use types 0x9, 0xA, 0xB or 0xC
    
    Parameters:
    
    String - operator - String CfRule operator attribute
    
    Returns:
    
    int representing Cf operator value
  - translateType
```
protected static String translateType(int type)
```
    Given an int type, return it's string representation
    NOTE: if type is between 3 and 18, it is an OOXML-specific type.
    
    Parameters:
    
    type - type integer
    
    Returns:
    
    String reprentation
    
    See Also:
    
    translateType(String)
  - translateOOXMLType
```
protected static int translateOOXMLType(String type)
```
    takes a String representing the type attribute and translates it to the corresponding integer representation
    IMPORTANT NOTE: OOXML-specific types are converted to an integer that is not valid in 2003 versions
    
    Parameters:
    
    String - type - OOXML CfRule type attribute
    
    Returns:
    
    int representing Cf type value
  - getXML
```
public String getXML()
```
    returns EXML (XMLSS) for the Conditional Format Rule R12C2:R16C2 Between 2 4 R6C2 NOT(ISERROR(SEARCH("yes",RC)))
    
    Returns:
  - parseXML
```
public static Cf parseXML(org.xmlpull.v1.XmlPullParser xpp,
                          Condfmt cfx,
                          Boundsheet bs)
```
    creates a Cf record from the EXML nodes Between 2 4
    
    Parameters:
    
    xpp -
    
    Returns:
  - setContainsText
```
public void setContainsText(String s)
```
    OOXML-specific, in a containsText-type condition, this field is the comparitor
    
    Parameters:
    
    s -
  - getOOXML
```
public String getOOXML(WorkBookHandle bk,
                       int priority,
                       ArrayList dxfs)
```
    generate OOXML for this Cf (BIFF8->OOXML) attributes: type, dxfId, priority (REQ), stopIfTrue, aboveAverage, percent, bottom, operator, text, timePeriod, rank, stdDev, equalAverage children: SEQ: formula (0-3), colorScale, dataBar, iconSet
    
    Returns:

Class Cf

Field Summary

Fields inherited from class io.starter.formats.XLS.XLSRecord

Fields inherited from interface io.starter.formats.XLS.XLSConstants

Constructor Summary

Method Summary

Methods inherited from class io.starter.formats.XLS.XLSRecord

Methods inherited from class java.lang.Object

Field Detail

PATTERN_FILL_STYLE

PATTERN_FILL_COLOR

PATTERN_FILL_BACK_COLOR

FONT_OPTIONS_POSTURE

FONT_OPTIONS_CANCELLATION

FONT_OPTIONS_POSTURE_NORMAL

FONT_OPTIONS_POSTURE_ITALIC

FONT_OPTIONS_CANCELLATION_OFF

FONT_OPTIONS_CANCELLATION_ON

FONT_ESCAPEMENT_NONE

FONT_ESCAPEMENT_SUPER

FONT_ESCAPEMENT_SUB

FONT_UNDERLINE_NONE

FONT_UNDERLINE_SINGLE

FONT_UNDERLINE_DOUBLE

FONT_UNDERLINE_SINGLEACCOUNTING

FONT_UNDERLINE_DOUBLEACCOUNTING

FONT_MODIFIED_OPTIONS_STYLE

FONT_MODIFIED_OPTIONS_CANCELLATIONS

BORDER_LINESTYLE_LEFT

BORDER_LINESTYLE_RIGHT

BORDER_LINESTYLE_TOP

BORDER_LINESTYLE_BOTTOM

BORDER_MODIFIED_LEFT

BORDER_MODIFIED_RIGHT

BORDER_MODIFIED_TOP

BORDER_MODIFIED_BOTTOM

BORDER_LINECOLOR_LEFT

BORDER_LINECOLOR_RIGHT

BORDER_LINECOLOR_TOP

BORDER_LINECOLOR_BOTTOM

Constructor Detail

Cf

Cf

Method Detail

init

setStylePropsFromString

setStylePropsFromDxf

setOperator

setOperator

getOperator

setType

getType

getTypeString

setCondition1

setCondition2

getCondfmt

setCondfmt

getFontEscapement

getPatternFgColor

getPatternBgColor

setFontEscapement

updateBorderLineStylesFlag

updateBorderLineColorsFlag

getFill

updatePatternFillColorsFlag

getFont

getBorderColors

getAllBorderColors

getBorderStyles

getBorderSizes

getForegroundColor

getFontOptsPosture

setFontOptsPosture

getFontOptsCancellation

getFontItalic

setFontItalic

getFontStriken

setFontStriken

getFontEscapementSuper

setFontEscapementSuper