Condfmt (OpenXLS Java Spreadsheet SDK 11.0.4 API)

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

All Implemented Interfaces:

BlockByteConsumer, BiffRec, XLSConstants, Serializable
```
public final class Condfmt
extends XLSRecord
```
Condfmt: Conditional Formatting Range Information 0x1B0
This record stores a conditional format, including conditions and formatting info. And, no it does not just point to an Xf record because that would be easy. OFFSET NAME SIZE CONTENTS ----- 4 ccf 2 Number of Conditional formats 6 grbit 2 Option flags (not a byte?) [1 = Conditionally formatted cells need recalculation or redraw] 8 rwFirst 2 First row to conditionally format (0 based) 10 rwLast 2 Last row to conditionally format (0 based) 12 colFirst 2 First column to conditionally format (0 based) 14 colLast 2 Last column to conditionally format (0 based) 16 sqrefCount 2 Count of sqrefs * 18 rgbSqref var Array of sqref structures Sqref Structures OFFSET NAME SIZE CONTENTS ----- 0 rwFirst 2 First row in reference 2 rwLast 2 Last row in reference 4 colFirst 2 First column in reference 6 colLast 2 Last column in reference

See Also:

Cf, Serialized Form

Field Summary
- 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

Condfmt()
default constructor

Constructors
Constructor and Description
`Condfmt()` default constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addLocation(String location)` Add a location to the conditional format record, this is a string representation that can be either a cell, ie "A1", or a range ie "A1:A12";
`void`	`addRule(Cf c)` add a new CF rule to this conditional format
`void`	`close()` clear out object referencse
`boolean`	`contains(int[] rowColFromString)` Checks if the conditional format contains the row/col passed in
`String[]`	`getAllRanges()` Return all ranges as strings
`String`	`getBoundingRange()` get the bounding range of this conditional format
`int`	`getCfxe()` This is an overall not ideal situation where we want a formatid that we can use in sheetster to identify this conditional format // TODO: Perfect this algorithm!! :) cfxe should be constant for this Condfmt // ...
`int[]`	`getEncompassingRange()` Returns the entire range this conditional format refers to in Row[0]Col[0]Row[n]Col[n] format.
`FormatHandle`	`getFormatHandle()`
`String`	`getOOXML(WorkBookHandle bk, int[] priority)` generate the proper OOXML to define this set of Conditional Formatting
`protected static XLSRecord`	`getPrototype()` Create a Condfmt record & populate with prototype bytes
`ArrayList`	`getRules()` returns the rules associated with this record
`String`	`getXML()` returns EXML for the Conditional Format R12C2:R16C2 Between 2 4
`String`	`getXML(boolean useXMLSSNameSpace)` returns EXML (XMLSS) for the Conditional Format R12C2:R16C2 Between 2 4
`String`	`getXMLSS()` returns XMLSS for the Conditional Format R12C2:R16C2 Between 2 4
`void`	`init()` initialize the condfmt record Please note that the sqref structure is not initialized in this location, but is required for cfmt functionality.
`void`	`initializeReferences()` As the init() call occurs before worksheet is set upon this conditionalformat record, we have to initialze the references after init in order for referenceTracker to work correctly
`static Condfmt`	`parseOOXML(org.xmlpull.v1.XmlPullParser xpp, WorkBookHandle wb, Boundsheet bs)` create one or more Data Validation records based on OOXML input
`void`	`preStream()` update the bytes
`void`	`resetRange(String range)` Set this cf to a new enclosing cell range This should only be used for inital creation of a conditional format record or when all other internal ranges should be cleared as it removes all others
`void`	`setCfxe(int c)`
`void`	`setDirty()` set dirty flag to rebuild condfmt record used when updated the underlying ranges wit
`void`	`setFormatHandle(FormatHandle formatHandle)`

Methods inherited from class io.starter.formats.XLS.XLSRecord
addContinue, clone, copyFormat, getBooleanVal, getByteAt, getByteReader, getBytes, getBytesAt, getCellAddress, getCellAddressWithSheet, getCellType, getColNumber, getColorTable, getContinueVect, getData, getDataType, getDblVal, getDefaultVal, getEncryptedByteReader, getFirstBlock, getFloatVal, getFont, 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, 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

- Constructor Detail
  - Condfmt
```
public Condfmt()
```
    default constructor
- Method Detail
  - setDirty
```
public void setDirty()
```
    set dirty flag to rebuild condfmt record used when updated the underlying ranges wit
  - init
```
public void init()
```
    initialize the condfmt record Please note that the sqref structure is not initialized in this location, but is required for cfmt functionality. It happens on parse after worksheet is set
    
    Specified by:
    
    init in interface BiffRec
    
    Overrides:
    
    init in class XLSRecord
  - initializeReferences
```
public void initializeReferences()
```
    As the init() call occurs before worksheet is set upon this conditionalformat record, we have to initialze the references after init in order for referenceTracker to work correctly
  - getFormatHandle
```
public FormatHandle getFormatHandle()
```
    Returns:
    
    Returns the formatHandle.
  - setFormatHandle
```
public void setFormatHandle(FormatHandle formatHandle)
```
    Parameters:
    
    formatHandle - The formatHandle to set.
  - getCfxe
```
public int getCfxe()
```
    This is an overall not ideal situation where we want a formatid that we can use in sheetster to identify this conditional format // TODO: Perfect this algorithm!! :) cfxe should be constant for this Condfmt // ... if address changes? if sheet # changes
    
    Returns:
    
    Returns the cfxe.
  - setCfxe
```
public void setCfxe(int c)
```
    Parameters:
    
    cfxe - The cfxe to set.
  - getRules
```
public ArrayList getRules()
```
    returns the rules associated with this record
    
    Returns:
  - addRule
```
public void addRule(Cf c)
```
    add a new CF rule to this conditional format
  - getAllRanges
```
public String[] getAllRanges()
```
    Return all ranges as strings
    
    Returns:
  - getEncompassingRange
```
public int[] getEncompassingRange()
```
    Returns the entire range this conditional format refers to in Row[0]Col[0]Row[n]Col[n] format.
    
    Returns:
  - addLocation
```
public void addLocation(String location)
```
    Add a location to the conditional format record, this is a string representation that can be either a cell, ie "A1", or a range ie "A1:A12";
    
    Parameters:
    
    location - string representing the added range
  - getBoundingRange
```
public String getBoundingRange()
```
    get the bounding range of this conditional format
    
    Returns:
  - resetRange
```
public void resetRange(String range)
```
    Set this cf to a new enclosing cell range This should only be used for inital creation of a conditional format record or when all other internal ranges should be cleared as it removes all others
    
    Parameters:
    
    range -
  - getPrototype
```
protected static XLSRecord getPrototype()
```
    Create a Condfmt record & populate with prototype bytes
    
    Returns:
  - preStream
```
public void preStream()
```
    update the bytes
    
    Specified by:
    
    preStream in interface BiffRec
    
    Overrides:
    
    preStream in class XLSRecord
  - parseOOXML
```
public static Condfmt parseOOXML(org.xmlpull.v1.XmlPullParser xpp,
                                 WorkBookHandle wb,
                                 Boundsheet bs)
```
    create one or more Data Validation records based on OOXML input
  - getXML
```
public String getXML()
```
    returns EXML for the Conditional Format R12C2:R16C2 Between 2 4
    
    Returns:
    
    XML string for this record
  - getXMLSS
```
public String getXMLSS()
```
    returns XMLSS for the Conditional Format R12C2:R16C2 Between 2 4
    
    Returns:
    
    XML string for this record
  - getXML
```
public String getXML(boolean useXMLSSNameSpace)
```
    returns EXML (XMLSS) for the Conditional Format R12C2:R16C2 Between 2 4
    
    Returns:
  - getOOXML
```
public String getOOXML(WorkBookHandle bk,
                       int[] priority)
```
    generate the proper OOXML to define this set of Conditional Formatting
    
    Returns:
  - contains
```
public boolean contains(int[] rowColFromString)
```
    Checks if the conditional format contains the row/col passed in
    
    Parameters:
    
    rowColFromString -
    
    Returns:
  - close
```
public void close()
```
    clear out object referencse
    
    Overrides:
    
    close in class XLSRecord

Class Condfmt

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

Constructor Detail

Condfmt

Method Detail

setDirty

init

initializeReferences

getFormatHandle

setFormatHandle

getCfxe

setCfxe

getRules

addRule

getAllRanges

getEncompassingRange

addLocation

getBoundingRange

resetRange

getPrototype

preStream

parseOOXML

getXML

getXMLSS

getXML

getOOXML

contains

close