Mulblank (OpenXLS Java Spreadsheet SDK 11.0.4 API)

java.lang.Object
- io.starter.formats.XLS.XLSRecord
- - io.starter.formats.XLS.XLSCellRecord
  - - io.starter.formats.XLS.Mulblank

All Implemented Interfaces:: BlockByteConsumer, BiffRec, CellAddressible, CellRec, ColumnRange, XLSConstants, Serializable

public final class Mulblank
extends XLSCellRecord

Mulblank: Multiple Blank Cells (BEh)
This record stores up to 256 BLANK equivalents in a space-saving format. TODO: check compatibility with Excel2007 MAXCOLS

    offset  name        size    contents
    ---    
    4       rw          2       Row Number
    6       colFirst    2       Column Number of the first col of multiple Blank record
    8       rgixfe      var     Array of indexes to XF records
    10      colLast     2       Last Column containing Blank objects

See Also:: Blank, Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface io.starter.formats.XLS.CellAddressible
  CellAddressible.ColumnMajorComparator, CellAddressible.RangeBoundary, CellAddressible.Reference, CellAddressible.RowMajorComparator
- Nested classes/interfaces inherited from interface io.starter.formats.XLS.ColumnRange
  ColumnRange.Comparator

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

Mulblank()

Constructors
Constructor and Description
`Mulblank()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getCellAddress()` since this is a "MUL" we override this method to get a BiffRec Range, not a BiffRec Address.
`int`	`getColFirst()` return sthe first column of the range of blank cells referenced by this Mulblank
`int`	`getColLast()` return sthe last column of the range of blank cells referenced by this Mulblank
`short`	`getColNumber()` returnt the "current" column indicator, if set
`ArrayList<Integer>`	`getColReferences()` Get the referenced columns this mulblank has,
`int[]`	`getIntLocation()` returns the cell address in int[] {row, col} format
`int`	`getIxfe()` get the ixfe for the desired referred-to blank
`CellRange`	`getMergeRange()` NOTE: Mublanks can have a portion of it's blank range which is merged: must determine if the current cell is truly part of the merge range ...
`String`	`getMulblankRange()` return entire range this Mulblank refers to
`static XLSRecord`	`getPrototype()`
`String`	`getStringVal()` return a blank string val
`void`	`init()` initialize this record
`boolean`	`removeCell(short c)` revise range of cells this Mulblank refers to; return true if no more blanks in range
`void`	`resetCol()` reset the "current" column use to reference a single blank of this Mulblank range of blank cells
`void`	`setCol(short i)` set the column
`void`	`setColFirst(int c)` sets the first column of the range of blank cells referenced by this Mulblank
`void`	`setColLast(int c)` sets the last column of the range of blank cells referenced by this Mulblank
`void`	`setCurrentCell(short c)` used to set the cell which this will be referred to, used when trying to access ixfe
`void`	`setIxfe(int i)` sets the ixfe for the specific cell of the Mulblank (each cell in a series of multiple blanks has their own ixfe)
`void`	`setSheet(Sheet bs)` set the Boundsheet for the Mulblank this is needed because Blanks are BiffRec valrecs and need to be assigned a BiffRec in the sheet...
`String`	`toString()`

Methods inherited from class io.starter.formats.XLS.XLSCellRecord
isSingleCol

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

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

Methods inherited from interface io.starter.formats.XLS.BiffRec
addContinue, copyFormat, getBooleanVal, getByteAt, getByteReader, getBytes, getBytesAt, getContinueVect, getData, getDataType, getDblVal, getDefaultVal, getEncryptedByteReader, getFloatVal, getFont, getFormatPattern, getFormulaRec, getHyperlink, getInternalVal, getIntVal, getLength, getOffset, getOpcode, getRecordIndex, getRow, getRowNumber, getSheet, getStreamer, getStringVal, getWorkBook, getXfRec, hasContinues, isReadOnly, isValueForCell, postStream, preStream, remove, removeContinues, setBooleanVal, setByteReader, setData, setDebugLevel, setDoubleVal, setEncryptedByteReader, setHyperlink, setIndex, setIntVal, setIsValueForCell, setLength, setMergeRange, setOffset, setOpcode, setRow, setRowCol, setRowNumber, setStreamer, setStringVal, setWorkBook, setXFRecord, setXFRecord, toHexDump

Methods inherited from interface io.starter.formats.XLS.CellAddressible
getRowNumber

- Constructor Detail
  - Mulblank
```
public Mulblank()
```
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class XLSRecord
  - getCellAddress
```
public String getCellAddress()
```
    since this is a "MUL" we override this method to get a BiffRec Range, not a BiffRec Address.
    
    Specified by:
    
    getCellAddress in interface BiffRec
    
    Overrides:
    
    getCellAddress in class XLSRecord
  - getIntLocation
```
public int[] getIntLocation()
```
    returns the cell address in int[] {row, col} format
    
    Overrides:
    
    getIntLocation in class XLSRecord
  - getMulblankRange
```
public String getMulblankRange()
```
    return entire range this Mulblank refers to
    
    Returns:
  - setSheet
```
public void setSheet(Sheet bs)
```
    set the Boundsheet for the Mulblank this is needed because Blanks are BiffRec valrecs and need to be assigned a BiffRec in the sheet... the Mulblank itself does not get a cell.
    
    Specified by:
    
    setSheet in interface BiffRec
    
    Overrides:
    
    setSheet in class XLSRecord
  - init
```
public void init()
```
    initialize this record
    
    Specified by:
    
    init in interface BiffRec
    
    Overrides:
    
    init in class XLSRecord
  - getColNumber
```
public short getColNumber()
```
    returnt the "current" column indicator, if set
    
    Specified by:
    
    getColNumber in interface BiffRec
    
    Overrides:
    
    getColNumber in class XLSRecord
  - resetCol
```
public void resetCol()
```
    reset the "current" column use to reference a single blank of this Mulblank range of blank cells
  - setColFirst
```
public void setColFirst(int c)
```
    sets the first column of the range of blank cells referenced by this Mulblank
    
    Parameters:
    
    c -
  - setColLast
```
public void setColLast(int c)
```
    sets the last column of the range of blank cells referenced by this Mulblank
    
    Parameters:
    
    c -
  - getColFirst
```
public int getColFirst()
```
    return sthe first column of the range of blank cells referenced by this Mulblank
    
    Specified by:
    
    getColFirst in interface ColumnRange
    
    Overrides:
    
    getColFirst in class XLSCellRecord
    
    Returns:
  - getColLast
```
public int getColLast()
```
    return sthe last column of the range of blank cells referenced by this Mulblank
    
    Specified by:
    
    getColLast in interface ColumnRange
    
    Overrides:
    
    getColLast in class XLSCellRecord
    
    Returns:
  - removeCell
```
public boolean removeCell(short c)
```
    revise range of cells this Mulblank refers to; return true if no more blanks in range
    
    Parameters:
    
    c - col number to remove, 0-based
  - getStringVal
```
public String getStringVal()
```
    return a blank string val
    
    Specified by:
    
    getStringVal in interface BiffRec
    
    Overrides:
    
    getStringVal in class XLSRecord
  - setCurrentCell
```
public void setCurrentCell(short c)
```
    used to set the cell which this will be referred to, used when trying to access ixfe
    
    Parameters:
    
    c -
  - getMergeRange
```
public CellRange getMergeRange()
```
    NOTE: Mublanks can have a portion of it's blank range which is merged: must determine if the current cell is truly part of the merge range ...
    
    Specified by:
    
    getMergeRange in interface BiffRec
    
    Overrides:
    
    getMergeRange in class XLSRecord
    
    Returns:
  - getIxfe
```
public int getIxfe()
```
    get the ixfe for the desired referred-to blank
    
    Specified by:
    
    getIxfe in interface BiffRec
    
    Overrides:
    
    getIxfe in class XLSRecord
  - getColReferences
```
public ArrayList<Integer> getColReferences()
```
    Get the referenced columns this mulblank has,
  - setIxfe
```
public void setIxfe(int i)
```
    sets the ixfe for the specific cell of the Mulblank (each cell in a series of multiple blanks has their own ixfe)
    
    Specified by:
    
    setIxfe in interface BiffRec
    
    Overrides:
    
    setIxfe in class XLSRecord
  - setCol
```
public void setCol(short i)
```
    set the column
    
    Specified by:
    
    setCol in interface BiffRec
    
    Overrides:
    
    setCol in class XLSRecord
  - getPrototype
```
public static XLSRecord getPrototype()
```

Class Mulblank

Nested Class Summary

Nested classes/interfaces inherited from interface io.starter.formats.XLS.CellAddressible

Nested classes/interfaces inherited from interface io.starter.formats.XLS.ColumnRange

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.XLSCellRecord

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

Methods inherited from class java.lang.Object

Methods inherited from interface io.starter.formats.XLS.BiffRec

Methods inherited from interface io.starter.formats.XLS.CellAddressible

Constructor Detail

Mulblank

Method Detail

toString

getCellAddress

getIntLocation

getMulblankRange

setSheet

init

getColNumber

resetCol

setColFirst

setColLast

getColFirst

getColLast

removeCell

getStringVal

setCurrentCell

getMergeRange

getIxfe

getColReferences

setIxfe

setCol

getPrototype