Array (OpenXLS Java Spreadsheet SDK 11.0.4 API)

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

All Implemented Interfaces:

BlockByteConsumer, BiffRec, XLSConstants, Serializable
```
public final class Array
extends XLSRecord
```
The Array class describes a formula that was Array-entered into a range of cells. The range of Cells in which the array is entered is defined by the rwFirst, last, colFirst and last fields. The Array record occurs directly after the Formula record for the cell in the upper-left corner of the array -- that is, the cell defined by the rwFirst and colFirst fields. The parsed expression is the array formula -- consisting of Ptgs. You should ignore the chn field when you read the file, it must be 0 if written. OFFSET NAME SIZE CONTENTS ----- 4 rwFirst 2 FirstRow of the array 6 fwLast 2 Last Row of the array 8 colFirst 1 First Column of the array 9 colLast 1 Last Column of the array 10 grbit 2 Option Flags 12 chn 4 set to 0, ignore 16 cce 2 Length of the parsed expression 18 rgce var Parsed Expression grbit fields bit 1 = fAlwaysCalc - always calc the formula bit 2 = fCalcOnLoad - calc formula on load

See Also:

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

Array()

Constructors
Constructor and Description
`Array()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getArrayRefs()` return the cells referenced by this array in string range form
`int`	`getCol()`
`Stack`	`getExpression()` allow access to expression
`int`	`getFirstCol()`
`int`	`getFirstRow()`
`String`	`getFormulaString()` return the string representation of the array formula
`int`	`getLastCol()`
`int`	`getLastRow()`
`String`	`getParentLocation()` Returns the top left location of the array, used for identifying which array goes with what formula.
`Formula`	`getParentRec()` return parent formula
`int`	`getRowNumber()`
`Object`	`getValue(PtgExp pxp)`
`void`	`init()` perform record initialization
`void`	`init(String fmla, int rw, int col)` init Array record from formula string
`void`	`setFirstCol(int i)`
`void`	`setFirstRow(int i)`
`void`	`setLastCol(int i)`
`void`	`setLastRow(int i)`
`void`	`setParentRec(Formula f)` link this shared formula to it's parent formula
`void`	`setSheet(Sheet b)` Associate this record with a worksheet.
`void`	`updateRecord()`

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, getFont, getFormatPattern, getFormulaRec, getHyperlink, getInternalVal, getIntLocation, getIntVal, getIxfe, getLastBlock, getLength, getMergeRange, getOffset, getOpcode, getPrototype, getRealRecordIndex, getRecDesc, getRecordIndex, getRow, 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, 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
  - Array
```
public Array()
```
- Method Detail
  - getFirstRow
```
public int getFirstRow()
```
  - getLastRow
```
public int getLastRow()
```
  - getFirstCol
```
public int getFirstCol()
```
  - getLastCol
```
public int getLastCol()
```
  - getRowNumber
```
public int getRowNumber()
```
    Specified by:
    
    getRowNumber in interface BiffRec
    
    Overrides:
    
    getRowNumber in class XLSRecord
  - getCol
```
public int getCol()
```
  - setFirstRow
```
public void setFirstRow(int i)
```
  - setLastRow
```
public void setLastRow(int i)
```
  - setFirstCol
```
public void setFirstCol(int i)
```
  - setLastCol
```
public void setLastCol(int i)
```
  - init
```
public void init()
```
    Description copied from class: XLSRecord
    
    perform record initialization
    
    Specified by:
    
    init in interface BiffRec
    
    Overrides:
    
    init in class XLSRecord
  - setSheet
```
public void setSheet(Sheet b)
```
    Associate this record with a worksheet. init array refs as well
    
    Specified by:
    
    setSheet in interface BiffRec
    
    Overrides:
    
    setSheet in class XLSRecord
  - init
```
public void init(String fmla,
                 int rw,
                 int col)
```
    init Array record from formula string
    
    Parameters:
    
    fmla -
  - updateRecord
```
public void updateRecord()
```
  - getParentLocation
```
public String getParentLocation()
```
    Returns the top left location of the array, used for identifying which array goes with what formula.
  - getValue
```
public Object getValue(PtgExp pxp)
```
  - setParentRec
```
public void setParentRec(Formula f)
```
    link this shared formula to it's parent formula
  - getParentRec
```
public Formula getParentRec()
```
    return parent formula
    
    Returns:
  - getFormulaString
```
public String getFormulaString()
```
    return the string representation of the array formula
  - getExpression
```
public Stack getExpression()
```
    allow access to expression
    
    Returns:
  - getArrayRefs
```
public String getArrayRefs()
```
    return the cells referenced by this array in string range form
    
    Returns:

Class Array

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

Array

Method Detail

getFirstRow

getLastRow

getFirstCol

getLastCol

getRowNumber

getCol

setFirstRow

setLastRow

setFirstCol

setLastCol

init

setSheet

init

updateRecord

getParentLocation

getValue

setParentRec

getParentRec

getFormulaString

getExpression

getArrayRefs