PtgArray (OpenXLS Java Spreadsheet SDK 11.0.4 API)

java.lang.Object
- io.starter.formats.XLS.formulas.GenericPtg
- - io.starter.formats.XLS.formulas.PtgArray

All Implemented Interfaces:

Ptg, XLSConstants, Serializable, Cloneable
```
public class PtgArray
extends GenericPtg
implements Ptg
```
See Also:

Serialized Form

Field Summary
- Fields inherited from class io.starter.formats.XLS.formulas.GenericPtg
  parent_rec
- Fields inherited from interface io.starter.formats.XLS.formulas.Ptg
  ARRAY, CALCULATED, PTG_ADD_LENGTH, PTG_AREA_LENGTH, PTG_AREA3D_LENGTH, PTG_AREAERR3D_LENGTH, PTG_ATR_LENGTH, PTG_BOOL_LENGTH, PTG_CONCAT_LENGTH, PTG_DIV_LENGTH, PTG_ENDSHEET_LENGTH, PTG_EQ_LENGTH, PTG_EXP_LENGTH, PTG_FUNC_LENGTH, PTG_FUNCVAR_LENGTH, PTG_GE_LENGTH, PTG_GT_LENGTH, PTG_INT, PTG_INT_LENGTH, PTG_ISECT_LENGTH, PTG_LE_LENGTH, PTG_LOCATION_POLICY_LOCKED, PTG_LOCATION_POLICY_TRACK, PTG_LOCATION_POLICY_UNLOCKED, PTG_LT_LENGTH, PTG_MEM_AREA_N_LENGTH, PTG_MEM_AREA_NV_LENGTH, PTG_MEMERR_LENGTH, PTG_MLT_LENGTH, PTG_MYSTERY_LENGTH, PTG_NAME_LENGTH, PTG_NAMEX_LENGTH, PTG_NE_LENGTH, PTG_NUM_LENGTH, PTG_PAREN_LENGTH, PTG_PERCENT_LENGTH, PTG_POWER_LENGTH, PTG_RANGE_LENGTH, PTG_REF_LENGTH, PTG_REF3D_LENGTH, PTG_REFERR_LENGTH, PTG_REFERR3D_LENGTH, PTG_SUB_LENGTH, PTG_TYPE_ARRAY, PTG_TYPE_SINGLE, PTG_UMINUS_LENGTH, PTG_UNION_LENGTH, PTG_UPLUS_LENGTH, REFERENCE, UNCALCULATED, VALUE
- Fields inherited from interface io.starter.formats.XLS.XLSConstants
  AI, ALLOWDUPES, ALRUNS, AREA, AREAFORMAT, 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

PtgArray()

Constructors
Constructor and Description
`PtgArray()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Ptg`	`elementAt(int loc)` returns a ptg at the specified location.
`Ptg`	`elementAt(int col, int row)`
`byte[]`	`getArrVals()`
`Ptg[]`	`getComponents()` If a record consists of multiple sub records (ie PtgArea) return those records, else return null;
`boolean`	`getIsOperand()`
`int`	`getLength()` Override due to mystery extra byte occasionally found in ptgName recs.
`int`	`getNumberOfColumns()` returns the 0-based number of columns in this array number of columns is the amount of elements before the semicolon (if present) a,b,c;d,e,f; ....
`int`	`getNumberOfRows()` returns the 0-based number of rows in this array if nr>1 then the array is in the form of: a,b,c;d,e,f; ....
`byte[]`	`getPostRecord()` these are the bytes appended to the formula token array, after all other ptg's
`byte[]`	`getPreRecord()` return the first 8 bytes of the ptgArray record this represents the id byte and 7 reserved bytes
`String`	`getString()` return the human-readable String representation of this ptg -- if applicable
`String`	`getTextString()` return the human-readable String representation of this ptg -- if applicable
`int`	`getVal()`
`Object`	`getValue()` returns the value of an operand ptg.
`void`	`init(byte[] b)`
`void`	`parseArrayComponents()` given "extra info" at end of formula expression, parse array values
`int`	`setArrVals(byte[] by)` sets the array components values for this PtgArray returns the actual array components length
`void`	`setVal(String arrStr)`
`String`	`toString()`

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

Methods inherited from interface io.starter.formats.XLS.formulas.Ptg
calculatePtg, clone, close, evaluate, getDoubleVal, getIntLocation, getIntVal, getIsArray, getIsBinaryOperator, getIsControl, getIsFunction, getIsOperator, getIsPrimitiveOperator, getIsReference, getIsStandAloneOperator, getIsUnaryOperator, getLocation, getLocationPolicy, getLock, getNumParams, getOpcode, getParentRec, getPtgVal, getRecord, getString2, getTrackercell, initTrackerCell, isBlank, setLocation, setLocationPolicy, setLock, setParentRec, setTrackercell, setVars, updateAddressFromTrackerCell, updateRecord

- Constructor Detail
  - PtgArray
```
public PtgArray()
```
- Method Detail
  - getIsOperand
```
public boolean getIsOperand()
```
    Specified by:
    
    getIsOperand in interface Ptg
    
    Overrides:
    
    getIsOperand in class GenericPtg
  - getPreRecord
```
public byte[] getPreRecord()
```
    return the first 8 bytes of the ptgArray record this represents the id byte and 7 reserved bytes
    
    Returns:
  - getPostRecord
```
public byte[] getPostRecord()
```
    these are the bytes appended to the formula token array, after all other ptg's
    
    Returns:
  - init
```
public void init(byte[] b)
```
    Overrides:
    
    init in class GenericPtg
  - parseArrayComponents
```
public void parseArrayComponents()
```
    given "extra info" at end of formula expression, parse array values
  - getVal
```
public int getVal()
```
  - getValue
```
public Object getValue()
```
    Description copied from class: GenericPtg
    
    returns the value of an operand ptg.
    
    Specified by:
    
    getValue in interface Ptg
    
    Overrides:
    
    getValue in class GenericPtg
    
    Returns:
    
    null for non-operand Ptg.
  - getString
```
public String getString()
```
    Description copied from interface: Ptg
    
    return the human-readable String representation of this ptg -- if applicable
    
    Specified by:
    
    getString in interface Ptg
    
    Overrides:
    
    getString in class GenericPtg
  - getTextString
```
public String getTextString()
```
    Description copied from class: GenericPtg
    
    return the human-readable String representation of this ptg -- if applicable
    
    Specified by:
    
    getTextString in interface Ptg
    
    Overrides:
    
    getTextString in class GenericPtg
  - setVal
```
public void setVal(String arrStr)
```
  - getLength
```
public int getLength()
```
    Override due to mystery extra byte occasionally found in ptgName recs.
    
    Specified by:
    
    getLength in interface Ptg
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getComponents
```
public Ptg[] getComponents()
```
    Description copied from interface: Ptg
    
    If a record consists of multiple sub records (ie PtgArea) return those records, else return null;
    
    Specified by:
    
    getComponents in interface Ptg
    
    Overrides:
    
    getComponents in class GenericPtg
  - getNumberOfRows
```
public int getNumberOfRows()
```
    returns the 0-based number of rows in this array if nr>1 then the array is in the form of: a,b,c;d,e,f; .... where the semicolons delineate rows
    
    Returns:
  - getNumberOfColumns
```
public int getNumberOfColumns()
```
    returns the 0-based number of columns in this array number of columns is the amount of elements before the semicolon (if present) a,b,c;d,e,f; ....
    
    Returns:
  - setArrVals
```
public int setArrVals(byte[] by)
```
    sets the array components values for this PtgArray returns the actual array components length
    
    See Also:
    
    ExpressionParser.parseExpression
  - getArrVals
```
public byte[] getArrVals()
```
  - elementAt
```
public Ptg elementAt(int loc)
```
    returns a ptg at the specified location. Assumes that it is a one-dimensional array. If you need a multidimensional array please use the other elementAt(int,int)method
    
    Parameters:
    
    loc -
    
    Returns:
  - elementAt
```
public Ptg elementAt(int col,
                     int row)
```

Class PtgArray

Field Summary

Fields inherited from class io.starter.formats.XLS.formulas.GenericPtg

Fields inherited from interface io.starter.formats.XLS.formulas.Ptg

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

Constructor Summary

Method Summary

Methods inherited from class io.starter.formats.XLS.formulas.GenericPtg

Methods inherited from class java.lang.Object

Methods inherited from interface io.starter.formats.XLS.formulas.Ptg

Constructor Detail

PtgArray

Method Detail

getIsOperand

getPreRecord

getPostRecord

init

parseArrayComponents

getVal

getValue

getString

getTextString

setVal

getLength

toString

getComponents

getNumberOfRows

getNumberOfColumns

setArrVals

getArrVals

elementAt

elementAt