PtgRefN (OpenXLS Java Spreadsheet SDK 11.0.4 API)

java.lang.Object
- io.starter.formats.XLS.formulas.GenericPtg
- - io.starter.formats.XLS.formulas.PtgRef
  - - io.starter.formats.XLS.formulas.PtgRefN

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

public class PtgRefN
extends PtgRef

PtgRefN is a modified PtgRef that is for shared formulas. Put here by M$ to make us miserable, it would have made much more sense to just use a PtgRef.

    Offset      Name        Size    Contents
    ----------------------------------------------------
    0           rw          2       The row of the reference (so says the docs, but it is the row I think
    2           grbitCol    2       (see following table)

    Only the low-order 14 bits specify the Col, the other bits specify
    relative vs absolute for both the col or the row.

    Bits        Mask        Name    Contents
    -----------------------------------------------------
    15          8000h       fRwRel  =1 if row offset relative, 
                                    =0 if otherwise
    14          4000h       fColRel =1 if row offset relative,
                                    =0 if otherwise
    13-0        3FFFh       col     Ordinal column offset or number

This token contains the relative reference to a cell in the same sheet. It stores relative components as signed offsets and is used in shared formulas, conditional formatting, and data validity.

See Also:: WorkBook, Boundsheet, Dbcell, Row, Cell, XLSRecord, Serialized Form

Field Summary
- Fields inherited from class io.starter.formats.XLS.formulas.PtgRef
  col, externalLink1, externalLink2, fColRel, formulaCol, formulaRow, fRwRel, hashcode, is3dRef, rw, sheetname, useReferenceTracker, wholeCol, wholeRow
- 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

PtgRefN(boolean useReference)

Constructors
Constructor and Description
`PtgRefN(boolean useReference)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addToRefTracker()` add "true" area to reference tracker i.e.
`void`	`close()` clear out object references in prep for closing workbook
`PtgRef`	`convertToPtgRef(XLSRecord r)` Convert this PtgRefN to a PtgRef based on the offsets included in the PtgExp & if this uses relative or absolute offsets
`PtgArea`	`getArea()` custom RefTracker usage: uses entire range covered by all shared formulas
`int[]`	`getIntLocation()` /* (try to) return int[] array containing the row/column referenced by this PtgRefN.
`boolean`	`getIsReference()`
`String`	`getLocation()` Returns the location of the Ptg as a string (ie c4) TODO: look into this possible bug There is a problem here as the location will always be relative and incorrect.
`int[]`	`getRealRowCol()` this
`int[]`	`getRowCol()` returns the row/col ints for the ref adjusted for the host cell
`void`	`init(byte[] b)`
`void`	`removeFromRefTracker()` remove "true" area from reference tracker i.e.
`void`	`setFormulaCol(int c)` set formula col
`void`	`setFormulaRow(int r)` set formula row
`void`	`setLocation(int[] rowcol)` Set the location of this PtgRef.
`void`	`setLocation(String address)` Set the location of this PtgRef.

Methods inherited from class io.starter.formats.XLS.formulas.PtgRef
changeLocation, clearLocationCache, createPtgRefFromString, equals, getFormattedValue, getHashCode, getHashCode, getIsOperand, getIsRefErr, getIsWholeCol, getIsWholeRow, getLength, getLocationWithSheet, getRealIntLocation, getRefCells, getSheetName, getString, getUseReferenceTracker, getValue, is3dRef, isBlank, isColRel, isRowRel, populateVals, setArrayTypeRef, setColRel, setExternalReference, setIsWholeCol, setIsWholeRow, setIsWholeRowCol, setLocation, setLocation, setParentRec, setPtgType, setRelativeRowCol, setRowRel, setSheetName, setUseReferenceTracker, toString, updateInRefTracker, updateRecord

Methods inherited from class io.starter.formats.XLS.formulas.GenericPtg
calculatePtg, clone, evaluate, getArrayLen, getComponents, getDoubleVal, getDoubleValue, getDoubleValueFromObject, getIntVal, getIsArray, getIsBinaryOperator, getIsControl, getIsFunction, getIsOperator, getIsPrimitiveOperator, getIsStandAloneOperator, getIsUnaryOperator, getLocationPolicy, getLock, getNumParams, getOpcode, getParentRec, getPtgVal, getRecord, getString2, getStringValuesFromPtgs, getTextString, getTrackercell, getValuesFromObjects, getValuesFromPtgs, initTrackerCell, qualifyCellAddress, qualifySheetname, readRow, setLocationPolicy, setLock, setTrackercell, setVars, updateAddressFromTrackerCell

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

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

- Constructor Detail
  - PtgRefN
```
public PtgRefN(boolean useReference)
```
- Method Detail
  - getIsReference
```
public boolean getIsReference()
```
    Specified by:
    
    getIsReference in interface Ptg
    
    Overrides:
    
    getIsReference in class PtgRef
  - init
```
public void init(byte[] b)
```
    Overrides:
    
    init in class PtgRef
  - getLocation
```
public String getLocation()
```
    Returns the location of the Ptg as a string (ie c4) TODO: look into this possible bug There is a problem here as the location will always be relative and incorrect. this is deprecated and should be calling convertToPtgRef
    
    Specified by:
    
    getLocation in interface Ptg
    
    Overrides:
    
    getLocation in class PtgRef
    
    Returns:
    
    Location
    
    See Also:
    
    GenericPtg.getLocation()
  - setLocation
```
public void setLocation(int[] rowcol)
```
    Description copied from class: PtgRef
    
    Set the location of this PtgRef. This takes a location such as {1,2}
    
    Overrides:
    
    setLocation in class PtgRef
  - getRowCol
```
public int[] getRowCol()
```
    returns the row/col ints for the ref adjusted for the host cell
    
    Overrides:
    
    getRowCol in class PtgRef
    
    Returns:
  - getRealRowCol
```
public int[] getRealRowCol()
```
    this
    
    Returns:
  - setLocation
```
public void setLocation(String address)
```
    Description copied from class: PtgRef
    
    Set the location of this PtgRef. This takes a location such as "a14", also can take a absolute location, such as $A14
    
    Specified by:
    
    setLocation in interface Ptg
    
    Overrides:
    
    setLocation in class PtgRef
  - convertToPtgRef
```
public PtgRef convertToPtgRef(XLSRecord r)
```
    Convert this PtgRefN to a PtgRef based on the offsets included in the PtgExp & if this uses relative or absolute offsets
    
    Parameters:
    
    pxp -
    
    Returns:
  - getIntLocation
```
public int[] getIntLocation()
```
    /* (try to) return int[] array containing the row/column referenced by this PtgRefN.
    
    Specified by:
    
    getIntLocation in interface Ptg
    
    Overrides:
    
    getIntLocation in class PtgRef
    
    See Also:
    
    PtgRef.getIntLocation()
  - setFormulaRow
```
public void setFormulaRow(int r)
```
    set formula row
    
    Parameters:
    
    r - int new row
  - setFormulaCol
```
public void setFormulaCol(int c)
```
    set formula col
    
    Parameters:
    
    c - int new col
  - getArea
```
public PtgArea getArea()
```
    custom RefTracker usage: uses entire range covered by all shared formulas
  - addToRefTracker
```
public void addToRefTracker()
```
    add "true" area to reference tracker i.e. entire range referenced by all shared formula members
    
    Overrides:
    
    addToRefTracker in class PtgRef
  - removeFromRefTracker
```
public void removeFromRefTracker()
```
    remove "true" area from reference tracker i.e. entire range referenced by all shared formula members
    
    Overrides:
    
    removeFromRefTracker in class PtgRef
  - close
```
public void close()
```
    Description copied from class: PtgRef
    
    clear out object references in prep for closing workbook
    
    Specified by:
    
    close in interface Ptg
    
    Overrides:
    
    close in class PtgRef

Class PtgRefN

Field Summary

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

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

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

PtgRefN

Method Detail

getIsReference

init

getLocation

setLocation

getRowCol

getRealRowCol

setLocation

convertToPtgRef

getIntLocation

setFormulaRow

setFormulaCol

getArea

addToRefTracker

removeFromRefTracker

close