Xf (OpenXLS Java Spreadsheet SDK 11.0.4 API)

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

All Implemented Interfaces:: BlockByteConsumer, BiffRec, XLSConstants, Serializable

public class Xf
extends XLSRecord

XF: Extended Format (E0h)
The XF record stores formatting properties. If fStyle bit is true, then the XF is a style XF, otherwise it is a BiffRec XF. Cells and Styles both contain ixfe pointers which correspond to their associated XF record.

        BiffRec XF Record
    
        offset  Bits   MASK     name        contents
        ---    
        0       15-0   0xFFFF   ifnt        Index to the FONT record.
        2       15-0   0xFFFF   ifmt        Index to the FORMAT record.
        4       0      0x0001   fLocked     =1 if the cell is locked.
                        1      0x0002   fHidden     =1 if the cell formula is hidden (value still shown)
                        2      0x0004   fStyle      =0 for cell XF.
                                                                                =1 for style XF.

        ~~~ additional option flags omitted ~~~

See Also:: SST, LABELSST, EXTSST, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`Fill`	`fill` OOXML fill, if any
`static int`	`NDEFAULTXFS`
`static int`	`PATTERN_SOLID` PATTERN_SOLID is a special case where icvFore= the background color and icvBack=64.

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
`Xf()`
`Xf(Font f, WorkBook wkbook)` constructor which takes a Font object + a workbook useful for cloning xf's from other workbooks
`Xf(int f)` create a new Xf with pointer to its font
`Xf(int f, WorkBook wkbook)` create a new Xf with pointer to its font and workbook set

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static short`	`addFormatPattern(WorkBook book, String pattern)` Ensures that the given format pattern exists on the given workbook.
`void`	`close()` clear out object references in prep for closing workbook
`void`	`decUseCoount()` dec # records using this xf
`short`	`getBackgroundColor()` get the background Color index for this Cell
`String`	`getBackgroundColorHEX()` get the background Color for this Cell as a Hex Color String
`boolean`	`getBold()`
`int`	`getBottomBorderColor()`
`short`	`getBottomBorderLineStyle()`
`short`	`getDiagBorderColor()` get the diagonal border color
`short`	`getDiagBorderLineStyle()`
`Fill`	`getFill()` return the OOXML fill for this xf, if any
`int`	`getFillPattern()` get the format pattern for this particular XF
`Font`	`getFont()` returns the associated Font record for this XF
`short`	`getForegroundColor()` get the Pattern Color index for this Cell if Solid Fill, or the Foreground color if no Solid Pattern
`String`	`getForegroundColorHEX()` get the Pattern Color for this Cell if Solid Fill, or the Foreground color if no Solid Pattern, as a Hex Color String
`Format`	`getFormat()`
`String`	`getFormatPattern()` get the Formatting for this BiffRec from the pattern match.
`int`	`getHorizontalAlignment()`
`int`	`getIdx()`
`short`	`getIfmt()`
`short`	`getIfnt()`
`int`	`getIndent()` return the indent setting (1=3 spaces)
`boolean`	`getItalic()`
`int`	`getLeftBorderColor()`
`short`	`getLeftBorderLineStyle()`
`boolean`	`getMerged()`
`short`	`getRightBorderColor()`
`short`	`getRightBorderLineStyle()`
`int`	`getRightToLeftReadingOrder()` returns true if this style is set to Right-to-Left text direction (reading order)
`int`	`getRotation()`
`boolean`	`getStricken()`
`int`	`getTopBorderColor()`
`short`	`getTopBorderLineStyle()`
`boolean`	`getUnderlined()`
`short`	`getUseCount()` return # records using this xf
`int`	`getVerticalAlignment()`
`boolean`	`getWrapText()`
`String`	`getXML()` Returns an XML fragment representing the XF backing the format Handle.
`void`	`incUseCount()` inc # records using this xf
`void`	`init()` The XF record can either be a style XF or a Cell XF.
`boolean`	`isBackgroundSolid()`
`boolean`	`isCurrencyPattern()` returns whether this Format is a Currency
`boolean`	`isDatePattern()` returns whether this Format is a Date Needs to be revisited.
`static boolean`	`isDatePattern(String myfmt)`
`boolean`	`isFormulaHidden()` get whether this cell formula is hidden
`boolean`	`isLocked()` get whether this is a locked Cell
`boolean`	`isShrinkToFit()` return whether this cell is set to "shrink to fit"
`boolean`	`isStyleXf()` return truth of "this Xf rec is a style xf"
`protected void`	`populateForTransfer()` Populates the myFont and myFormat variables to be held onto when the xf record is serialized for boundsheet transfer
`void`	`removeBorders()` removes all borders for the style
`void`	`setAllBorderColors(int[] b)` set all border colors via an array of ints representing border color ints order= top, left, bottom, right, [diagonal]
`void`	`setAllBorderLineStyles(int[] b)` set border line styles via array of ints representing border styles order= top, left, bottom, right [diagonal]
`void`	`setBackColor(int t, Color clr)` set the Background Color for this Format (when PATTERN - fls != PATTERN_SOLID) When PATTERN is PATTERN_SOLID, == 64
`void`	`setBackgroundSolid()` Sets the fill pattern to solid, which renders the background to 64=="the default fg color" "If the fill style is solid: When solid is specified, the foreground color (fgColor) is the only color rendered, even when a background color (bgColor) is also specified"
`void`	`setBold(boolean b)`
`void`	`setBorderDiag(int t)` set the diagonal border for this Format
`void`	`setBorderLineStyle(short t)` set the border line style for this Format
`void`	`setBottomBorderColor(int t)` set the Bottom Border Color for this Format
`void`	`setBottomBorderLineStyle(short t)`
`void`	`setDiagBorderColor(int t)` set the diagonal Border Color for this Format
`void`	`setFill(Fill f)` set the OOXML fill for this xf
`void`	`setFont(int ifn)` set the pointer to the XF's Font in the WorkBook
`void`	`setForeColor(int t, Color clr)` set the Foreground Color for this Format THIS SETS THE BACKGROUND COLOR when PATTERN (fls) = PATTERN_SOLID THIS SETS THE PATTERN COLOR when PATTERN (fls) > PATTERN_SOLID "If the fill style is solid: When solid is specified, the foreground color (fgColor) is the only color rendered, even when a background color (bgColor) is also specified" icvFore==Pattern Background Color
`void`	`setFormat(Format myFormat)`
`void`	`setFormat(short ifm)` set the pointer to the XF's Format in the WorkBook
`void`	`setFormatPattern(String pattern)` Sets the number format pattern for this format.
`void`	`setFormulaHidden(boolean hd)` sets the cell formula as hidden
`void`	`setHorizontalAlignment(int hAlign)`
`void`	`setIfnt(short ifnt)`
`void`	`setIndent(int indent)` set the indent (1=3 spaces)
`void`	`setItalic(boolean b)`
`void`	`setLeftBorderColor(int t)` set the Left Border Color for this Format
`void`	`setLeftBorderColor(short t)` set the Left Border Color for this Format
`void`	`setLeftBorderLineStyle(short t)`
`void`	`setLocked(boolean lk)` sets the cell as locked
`void`	`setMerged(boolean mgd)`
`void`	`setMyFont(Font f)` Set myFont in XF to the same as Workbook's
`void`	`setPattern(int t)` set the Fill Pattern for this Format
`void`	`setRightBorderColor(int t)` set the Right Border Color for this Format
`void`	`setRightBorderLineStyle(short t)`
`void`	`setRightToLeftReadingOrder(int rtl)` sets the Right to Left Text Direction or reading order of this style
`void`	`setRotation(int rot)`
`void`	`setShrinkToFit(boolean b)`
`void`	`setStricken(boolean b)`
`void`	`setToCellXF()` Switch the record to a cell XF record
`void`	`setTopBorderColor(int t)` set the Top Border Color for this Format
`void`	`setTopBorderLineStyle(short t)`
`void`	`setUnderlined(boolean b)`
`void`	`setVerticalAlignment(int vAlign)`
`void`	`setWorkBook(WorkBook b)` Set the workbook for this XF This can get called multiple times.
`void`	`setWrapText(boolean wraptext)`
`String`	`toString()` Create a string representation of the Xf
`static String`	`unescapeFormatPattern(String xmlFormatPattern)` Parses an escaped xml format pattern (from ooxml) and returns an io.starter.OpenXLS compatible pattern.
`void`	`updateBorderColors()`
`void`	`updateBorders()`
`void`	`updatePattern()`
`static Xf`	`updateXf(Xf xf, int fontIdx, WorkBook wkbook)` if xf parameter doesn't exist, create; if it does, create a new xf based on it

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, getFormulaRec, getHyperlink, getInternalVal, getIntLocation, getIntVal, getIxfe, getLastBlock, getLength, getMergeRange, getOffset, getOpcode, getPrototype, 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, setXFRecord, setXFRecord, shouldEncrypt, toHexDump

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

- Field Detail
  - NDEFAULTXFS
```
public static final int NDEFAULTXFS
```
    See Also:
    
    Constant Field Values
  - fill
```
public Fill fill
```
    OOXML fill, if any
  - PATTERN_SOLID
```
public static final int PATTERN_SOLID
```
    PATTERN_SOLID is a special case where icvFore= the background color and icvBack=64. "If the fill style is solid: When solid is specified, the foreground color (fgColor) is the only color rendered, even when a background color (bgColor) is also specified"
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Xf
```
public Xf()
```
  - Xf
```
public Xf(int f)
```
    create a new Xf with pointer to its font
  - Xf
```
public Xf(int f,
          WorkBook wkbook)
```
    create a new Xf with pointer to its font and workbook set
  - Xf
```
public Xf(Font f,
          WorkBook wkbook)
```
    constructor which takes a Font object + a workbook useful for cloning xf's from other workbooks
    
    Parameters:
    
    f - font
    
    wkbook -
- Method Detail
  - setWorkBook
```
public void setWorkBook(WorkBook b)
```
    Set the workbook for this XF This can get called multiple times. This results in a disparity within xf counting in workbook.
    
    Specified by:
    
    setWorkBook in interface BiffRec
    
    Overrides:
    
    setWorkBook in class XLSRecord
  - toString
```
public String toString()
```
    Create a string representation of the Xf
    
    Overrides:
    
    toString in class XLSRecord
  - incUseCount
```
public void incUseCount()
```
    inc # records using this xf
  - decUseCoount
```
public void decUseCoount()
```
    dec # records using this xf
  - getUseCount
```
public short getUseCount()
```
    return # records using this xf
    
    Returns:
  - populateForTransfer
```
protected void populateForTransfer()
```
    Populates the myFont and myFormat variables to be held onto when the xf record is serialized for boundsheet transfer
  - getMerged
```
public boolean getMerged()
```
  - setMerged
```
public void setMerged(boolean mgd)
```
  - init
```
public void init()
```
    The XF record can either be a style XF or a Cell XF.
    
    Specified by:
    
    init in interface BiffRec
    
    Overrides:
    
    init in class XLSRecord
  - getFont
```
public Font getFont()
```
    returns the associated Font record for this XF
    
    Specified by:
    
    getFont in interface BiffRec
    
    Overrides:
    
    getFont in class XLSRecord
  - isDatePattern
```
public boolean isDatePattern()
```
    returns whether this Format is a Date Needs to be revisited. Currently I am only returning true for the standard "built in" dates
  - isDatePattern
```
public static boolean isDatePattern(String myfmt)
```
  - unescapeFormatPattern
```
public static String unescapeFormatPattern(String xmlFormatPattern)
```
    Parses an escaped xml format pattern (from ooxml) and returns an io.starter.OpenXLS compatible pattern. This method certainly has weaknesses, but my intention is that if it is not a fairly standard format and/or we are not sure how to parse it we should leave the existent format intact soas to not break read/write operations Oddly enough, excel seems to be able to handle biff8 patterns, in my testing so far there has been no need to reencode, that could obviously change...
    
    Parameters:
    
    xmlFormatPattern -
    
    Returns:
    
    compatible biff8 formatPattern
  - isCurrencyPattern
```
public boolean isCurrencyPattern()
```
    returns whether this Format is a Currency
  - getForegroundColor
```
public short getForegroundColor()
```
    get the Pattern Color index for this Cell if Solid Fill, or the Foreground color if no Solid Pattern
  - getForegroundColorHEX
```
public String getForegroundColorHEX()
```
    get the Pattern Color for this Cell if Solid Fill, or the Foreground color if no Solid Pattern, as a Hex Color String
    
    Returns:
    
    Hex Color String
  - getBackgroundColorHEX
```
public String getBackgroundColorHEX()
```
    get the background Color for this Cell as a Hex Color String
    
    Returns:
    
    Hex Color String
  - getBackgroundColor
```
public short getBackgroundColor()
```
    get the background Color index for this Cell
  - getFormatPattern
```
public String getFormatPattern()
```
    get the Formatting for this BiffRec from the pattern match. case insensitive pattern match is performed...
    
    Specified by:
    
    getFormatPattern in interface BiffRec
    
    Overrides:
    
    getFormatPattern in class XLSRecord
  - setFormatPattern
```
public void setFormatPattern(String pattern)
```
    Sets the number format pattern for this format.
  - addFormatPattern
```
public static short addFormatPattern(WorkBook book,
                                     String pattern)
```
    Ensures that the given format pattern exists on the given workbook.
    
    Parameters:
    
    book - the workbook to which the pattern should belong
    
    pattern - the number format pattern to ensure exists
    
    Returns:
    
    the format ID of the given format pattern
  - setFormat
```
public void setFormat(short ifm)
```
    set the pointer to the XF's Format in the WorkBook
  - setFont
```
public void setFont(int ifn)
```
    set the pointer to the XF's Font in the WorkBook
  - setMyFont
```
public void setMyFont(Font f)
```
    Set myFont in XF to the same as Workbook's
  - setPattern
```
public void setPattern(int t)
```
    set the Fill Pattern for this Format
  - getFillPattern
```
public int getFillPattern()
```
    get the format pattern for this particular XF
    
    Returns:
  - getBottomBorderLineStyle
```
public short getBottomBorderLineStyle()
```
  - getTopBorderLineStyle
```
public short getTopBorderLineStyle()
```
  - getLeftBorderLineStyle
```
public short getLeftBorderLineStyle()
```
  - getRightBorderLineStyle
```
public short getRightBorderLineStyle()
```
  - getDiagBorderLineStyle
```
public short getDiagBorderLineStyle()
```
  - setTopBorderColor
```
public void setTopBorderColor(int t)
```
    set the Top Border Color for this Format
  - getTopBorderColor
```
public int getTopBorderColor()
```
  - setBottomBorderColor
```
public void setBottomBorderColor(int t)
```
    set the Bottom Border Color for this Format
  - getBottomBorderColor
```
public int getBottomBorderColor()
```
  - setLeftBorderColor
```
public void setLeftBorderColor(int t)
```
    set the Left Border Color for this Format
  - getLeftBorderColor
```
public int getLeftBorderColor()
```
  - setRightBorderColor
```
public void setRightBorderColor(int t)
```
    set the Right Border Color for this Format
  - getRightBorderColor
```
public short getRightBorderColor()
```
  - setDiagBorderColor
```
public void setDiagBorderColor(int t)
```
    set the diagonal Border Color for this Format
  - getDiagBorderColor
```
public short getDiagBorderColor()
```
    get the diagonal border color
    
    Returns:
  - setLeftBorderColor
```
public void setLeftBorderColor(short t)
```
    set the Left Border Color for this Format
  - setBorderDiag
```
public void setBorderDiag(int t)
```
    set the diagonal border for this Format
  - setBorderLineStyle
```
public void setBorderLineStyle(short t)
```
    set the border line style for this Format
  - setAllBorderLineStyles
```
public void setAllBorderLineStyles(int[] b)
```
    set border line styles via array of ints representing border styles order= top, left, bottom, right [diagonal]
    
    Parameters:
    
    b - int[]
  - setAllBorderColors
```
public void setAllBorderColors(int[] b)
```
    set all border colors via an array of ints representing border color ints order= top, left, bottom, right, [diagonal]
    
    Parameters:
    
    b - int[]
  - setTopBorderLineStyle
```
public void setTopBorderLineStyle(short t)
```
  - setBottomBorderLineStyle
```
public void setBottomBorderLineStyle(short t)
```
  - setLeftBorderLineStyle
```
public void setLeftBorderLineStyle(short t)
```
  - setRightBorderLineStyle
```
public void setRightBorderLineStyle(short t)
```
  - updateBorders
```
public void updateBorders()
```
  - removeBorders
```
public void removeBorders()
```
    removes all borders for the style
  - updateBorderColors
```
public void updateBorderColors()
```
  - updatePattern
```
public void updatePattern()
```
  - setForeColor
```
public void setForeColor(int t,
                         Color clr)
```
    set the Foreground Color for this Format THIS SETS THE BACKGROUND COLOR when PATTERN (fls) = PATTERN_SOLID THIS SETS THE PATTERN COLOR when PATTERN (fls) > PATTERN_SOLID
    "If the fill style is solid: When solid is specified, the foreground color (fgColor) is the only color rendered, even when a background color (bgColor) is also specified" icvFore==Pattern Background Color
    
    Parameters:
    
    t - best match index into 2003-style Color tabe
    
    clr - java.awt.Color or null if use standard Excel 2003 Color Table
  - setBackColor
```
public void setBackColor(int t,
                         Color clr)
```
    set the Background Color for this Format (when PATTERN - fls != PATTERN_SOLID) When PATTERN is PATTERN_SOLID, == 64
    
    Parameters:
    
    t - best-match index into 2003-style Color table
    
    clr - java.awt.Color or null if use standard Excel 2003 Color Table
  - setBackgroundSolid
```
public void setBackgroundSolid()
```
    Sets the fill pattern to solid, which renders the background to 64=="the default fg color" "If the fill style is solid: When solid is specified, the foreground color (fgColor) is the only color rendered, even when a background color (bgColor) is also specified"
  - isBackgroundSolid
```
public boolean isBackgroundSolid()
```
  - setToCellXF
```
public void setToCellXF()
```
    Switch the record to a cell XF record
  - getIfnt
```
public short getIfnt()
```
    Returns:
    
    Returns the ifnt.
  - setIfnt
```
public void setIfnt(short ifnt)
```
    Parameters:
    
    ifnt - The ifnt to set.
  - getIfmt
```
public short getIfmt()
```
  - setHorizontalAlignment
```
public void setHorizontalAlignment(int hAlign)
```
  - setIndent
```
public void setIndent(int indent)
```
    set the indent (1=3 spaces)
    
    Parameters:
    
    indent -
  - getIndent
```
public int getIndent()
```
    return the indent setting (1=3 spaces)
    
    Returns:
  - setRightToLeftReadingOrder
```
public void setRightToLeftReadingOrder(int rtl)
```
    sets the Right to Left Text Direction or reading order of this style
    
    Parameters:
    
    rtl - possible values:
    0=Context Dependent
    1=Left-to-Right
    2=Right-to-Let
  - getRightToLeftReadingOrder
```
public int getRightToLeftReadingOrder()
```
    returns true if this style is set to Right-to-Left text direction (reading order)
    
    Returns:
  - getHorizontalAlignment
```
public int getHorizontalAlignment()
```
  - setWrapText
```
public void setWrapText(boolean wraptext)
```
  - getWrapText
```
public boolean getWrapText()
```
  - setVerticalAlignment
```
public void setVerticalAlignment(int vAlign)
```
  - getVerticalAlignment
```
public int getVerticalAlignment()
```
  - setRotation
```
public void setRotation(int rot)
```
  - getRotation
```
public int getRotation()
```
  - getXML
```
public String getXML()
```
    Returns an XML fragment representing the XF backing the format Handle. The XF record is style information associated with a cell. Font information/lookup is not included in this output so it can be used as a comparitor style
  - getFormat
```
public Format getFormat()
```
    Returns:
    
    Returns the myFormat.
  - setFormat
```
public void setFormat(Format myFormat)
```
    Parameters:
    
    myFormat - The myFormat to set.
  - isFormulaHidden
```
public boolean isFormulaHidden()
```
    get whether this cell formula is hidden
    
    Returns:
  - setFormulaHidden
```
public void setFormulaHidden(boolean hd)
```
    sets the cell formula as hidden
    
    Parameters:
    
    hd -
  - isLocked
```
public boolean isLocked()
```
    get whether this is a locked Cell
    
    Returns:
  - isShrinkToFit
```
public boolean isShrinkToFit()
```
    return whether this cell is set to "shrink to fit"
    
    Returns:
  - setShrinkToFit
```
public void setShrinkToFit(boolean b)
```
  - setLocked
```
public void setLocked(boolean lk)
```
    sets the cell as locked
    
    Parameters:
    
    lk -
  - getStricken
```
public boolean getStricken()
```
    Returns:
  - setStricken
```
public void setStricken(boolean b)
```
  - getItalic
```
public boolean getItalic()
```
    Returns:
  - setItalic
```
public void setItalic(boolean b)
```
  - getUnderlined
```
public boolean getUnderlined()
```
    Returns:
  - setUnderlined
```
public void setUnderlined(boolean b)
```
  - getBold
```
public boolean getBold()
```
    Returns:
  - setBold
```
public void setBold(boolean b)
```
  - getIdx
```
public int getIdx()
```
  - isStyleXf
```
public boolean isStyleXf()
```
    return truth of "this Xf rec is a style xf"
    
    Returns:
  - updateXf
```
public static Xf updateXf(Xf xf,
                          int fontIdx,
                          WorkBook wkbook)
```
    if xf parameter doesn't exist, create; if it does, create a new xf based on it
    
    Parameters:
    
    xf - original xf
    
    fontIdx - font to link xf to
    
    wkbook -
    
    Returns:
    
    new xf
  - setFill
```
public void setFill(Fill f)
```
    set the OOXML fill for this xf
    
    Parameters:
    
    f -
  - getFill
```
public Fill getFill()
```
    return the OOXML fill for this xf, if any
  - close
```
public void close()
```
    clear out object references in prep for closing workbook
    
    Overrides:
    
    close in class XLSRecord

Class Xf

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

NDEFAULTXFS

fill

PATTERN_SOLID

Constructor Detail

Xf

Xf

Xf

Xf

Method Detail

setWorkBook

toString

incUseCount

decUseCoount

getUseCount

populateForTransfer

getMerged

setMerged

init

getFont

isDatePattern

isDatePattern

unescapeFormatPattern

isCurrencyPattern

getForegroundColor

getForegroundColorHEX

getBackgroundColorHEX

getBackgroundColor

getFormatPattern

setFormatPattern

addFormatPattern

setFormat

setFont

setMyFont

setPattern

getFillPattern

getBottomBorderLineStyle

getTopBorderLineStyle

getLeftBorderLineStyle

getRightBorderLineStyle

getDiagBorderLineStyle

setTopBorderColor

getTopBorderColor

setBottomBorderColor

getBottomBorderColor

setLeftBorderColor

getLeftBorderColor

setRightBorderColor

getRightBorderColor

setDiagBorderColor

getDiagBorderColor

setLeftBorderColor

setBorderDiag

setBorderLineStyle

setAllBorderLineStyles

setAllBorderColors

setTopBorderLineStyle

setBottomBorderLineStyle

setLeftBorderLineStyle

setRightBorderLineStyle

updateBorders

removeBorders

updateBorderColors

updatePattern

setForeColor

setBackColor

setBackgroundSolid

isBackgroundSolid

setToCellXF

getIfnt

setIfnt

getIfmt