PtgFuncVar (OpenXLS Java Spreadsheet SDK 11.0.4 API)

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

All Implemented Interfaces:: Ptg, XLSConstants, Serializable, Cloneable

public class PtgFuncVar
extends GenericPtg
implements Ptg

PtgFunc is a fuction operator that refers to the header file in order to use the correct function. PtgFuncVar is only used with a variable number of arguments. Opcode = 22h

    Offset      Bits    Name        Mask        Contents
    --------------------------------------------------------
    0           6-0     cargs       7Fh         The number of arguments to the function
                7       fPrompt     80h         =1, function prompts the user
    1           14-0    iftab       7FFFh       The index to the function table
                                                see GenericPtgFunc for details
                15      fCE         8000h       This function is a command equivalent

See Also:: Ptg, GenericPtgFunc, Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static int LENGTH
- 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

Fields
Modifier and Type	Field and Description
`static int`	`LENGTH`

Constructor Summary

Constructors
Constructor and Description
`PtgFuncVar()`
`PtgFuncVar(int funcType, int numArgs)`
`PtgFuncVar(int funcType, int numArgs, XLSRecord parentRec)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`adjustParameterIds()` given this specific Func Var, ensure that it's parameters are of the correct Ptg type Value, Reference or Array This is necessary when functions are added via String NOTE: eventually all FuncVars which require a specific type of parameter will be handled here
`Ptg`	`calculatePtg(Ptg[] pthings)` return a Ptg consisting of the calculated values of the ptg's passed in.
`short`	`getFunctionId()` Get the function ID for this PtgFuncVar
`boolean`	`getIsFunction()`
`int`	`getLength()` return the length of the Ptg
`int`	`getNumParams()` Returns the number of Params to pass to the Ptg
`byte`	`getOpcode()` return the byte header for the Ptg
`byte[]`	`getRecord()` So, here you see we can get the static type from the record itself then format the output record.
`String`	`getString()` GetString - is this toString, what is it returning?
`String`	`getString2()` return the human-readable String representation of the "closing" portion of this Ptg such as a closing parenthesis.
`int`	`getVal()`
`void`	`init(byte[] b)`
`void`	`setNumParams(byte nParams)` set the number of parmeters in the FuncVar record
`String`	`toString()` return String representation of function id for this funcvar

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
clone, close, evaluate, getComponents, getDoubleVal, getIntLocation, getIntVal, getIsArray, getIsBinaryOperator, getIsControl, getIsOperand, getIsOperator, getIsPrimitiveOperator, getIsReference, getIsStandAloneOperator, getIsUnaryOperator, getLocation, getLocationPolicy, getLock, getParentRec, getPtgVal, getTextString, getTrackercell, getValue, initTrackerCell, isBlank, setLocation, setLocationPolicy, setLock, setParentRec, setTrackercell, setVars, updateAddressFromTrackerCell, updateRecord

- Field Detail
  - LENGTH
```
public static int LENGTH
```
- Constructor Detail
  - PtgFuncVar
```
public PtgFuncVar(int funcType,
                  int numArgs,
                  XLSRecord parentRec)
```
  - PtgFuncVar
```
public PtgFuncVar(int funcType,
                  int numArgs)
```
  - PtgFuncVar
```
public PtgFuncVar()
```
- Method Detail
  - getIsFunction
```
public boolean getIsFunction()
```
    Specified by:
    
    getIsFunction in interface Ptg
    
    Overrides:
    
    getIsFunction in class GenericPtg
  - getNumParams
```
public int getNumParams()
```
    Returns the number of Params to pass to the Ptg
    
    Specified by:
    
    getNumParams in interface Ptg
    
    Overrides:
    
    getNumParams in class GenericPtg
  - setNumParams
```
public void setNumParams(byte nParams)
```
    set the number of parmeters in the FuncVar record
    
    Parameters:
    
    byte - nParams
  - getOpcode
```
public byte getOpcode()
```
    Description copied from interface: Ptg
    
    return the byte header for the Ptg
    
    Specified by:
    
    getOpcode in interface Ptg
    
    Overrides:
    
    getOpcode in class GenericPtg
  - getString
```
public String getString()
```
    GetString - is this toString, what is it returning?
    
    Specified by:
    
    getString in interface Ptg
    
    Overrides:
    
    getString in class GenericPtg
  - getString2
```
public String getString2()
```
    Description copied from class: GenericPtg
    
    return the human-readable String representation of the "closing" portion of this Ptg such as a closing parenthesis.
    
    Specified by:
    
    getString2 in interface Ptg
    
    Overrides:
    
    getString2 in class GenericPtg
  - init
```
public void init(byte[] b)
```
    Overrides:
    
    init in class GenericPtg
  - getFunctionId
```
public short getFunctionId()
```
    Get the function ID for this PtgFuncVar
    
    Returns:
    
    function Id
  - getVal
```
public int getVal()
```
  - getRecord
```
public byte[] getRecord()
```
    Description copied from class: GenericPtg
    
    So, here you see we can get the static type from the record itself then format the output record. Some shorthand techniques are shown.
    
    Specified by:
    
    getRecord in interface Ptg
    
    Overrides:
    
    getRecord in class GenericPtg
    
    Returns:
    
    byte[] containing the whole ptg, including identifying opcode
  - getLength
```
public int getLength()
```
    Description copied from interface: Ptg
    
    return the length of the Ptg
    
    Specified by:
    
    getLength in interface Ptg
  - calculatePtg
```
public Ptg calculatePtg(Ptg[] pthings)
                 throws FunctionNotSupportedException,
                        CalculationException
```
    Description copied from class: GenericPtg
    
    return a Ptg consisting of the calculated values of the ptg's passed in. Returns null for any non-operand ptg.
    
    Specified by:
    
    calculatePtg in interface Ptg
    
    Overrides:
    
    calculatePtg in class GenericPtg
    
    Throws:
    
    CalculationException
    
    FunctionNotSupportedException
  - toString
```
public String toString()
```
    return String representation of function id for this funcvar
    
    Overrides:
    
    toString in class Object
  - adjustParameterIds
```
public void adjustParameterIds()
```
    given this specific Func Var, ensure that it's parameters are of the correct Ptg type
    Value, Reference or Array
    This is necessary when functions are added via String
    NOTE: eventually all FuncVars which require a specific type of parameter will be handled here
    
    See Also:
    
    FormulaParser.adjustParameterIds

Class PtgFuncVar

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

Field Detail

LENGTH

Constructor Detail

PtgFuncVar

PtgFuncVar

PtgFuncVar

Method Detail

getIsFunction

getNumParams

setNumParams

getOpcode

getString

getString2

init

getFunctionId

getVal

getRecord

getLength

calculatePtg

toString

adjustParameterIds