PtgRef3d (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.PtgRef3d

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

Direct Known Subclasses:: PtgRefErr3d

public class PtgRef3d
extends PtgRef
implements Ptg, IxtiListener

A BiffRec range spanning 3rd dimension of WorkSheets. `

offset name size contents
---
0 ixti 2 Index to Externsheet Sheet Record
2 row 2 The row
4 grCol 2 The col, or the col offset (see next table)

the low-order 8 bytes store the col numbers. The 2 MSBs specify whether the row
and col refs are relative or absolute.

bits mask name content
---
15 8000h fRwRel =1 if the row is relative, 0 if absolute
14 4000h fColRel =1 if the col is relative, 0 if absolute
13-8 3F00h (reserved)
7-0 00FFh col the col number or col offset (0-based)

For 3D references, the tokens contain a negative EXTERNSHEET index, indicating a reference into the own workbook.
The absolute value is the one-based index of the EXTERNSHEET record that contains the name of the first sheet. The
tokens additionally contain absolute indexes of the first and last referenced sheet. These indexes are independent of the
EXTERNSHEET record list. If the referenced sheets do not exist anymore, these indexes contain the value FFFFH (3D
reference to a deleted sheet), and an EXTERNSHEET record with the special name <04H> (own document) is used.
Each external reference contains the positive one-based index to an EXTERNSHEET record containing the URL of the
external document and the name of the sheet used. The sheet index fields of the tokens are not used.

See Also:: Ptg, Formula, Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

short ixti
- 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

Fields
Modifier and Type	Field and Description
`short`	`ixti`

Constructor Summary

Constructors
Constructor and Description
`PtgRef3d()` 0x3A Reference class token: The reference address itself, independent of the cell contents.
`PtgRef3d(boolean addToRefTracker)`
`PtgRef3d(String addr, short _ixti)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addListener()` Add this to the ixti listeners
`Ptg[]`	`getColComponents(int colNum)` return the ptg components for a certain column within a ptgArea()
`Ptg[]`	`getComponents()` PtgRef's have no sub-compnents
`boolean`	`getIsOperand()`
`boolean`	`getIsReference()`
`short`	`getIxti()`
`int`	`getLength()` return the length of the Ptg
`String`	`getLocation()` Returns the location of the Ptg as a string, including sheet name
`BiffRec[]`	`getRefCells()`
`Boundsheet`	`getSheet()`
`Boundsheet`	`getSheet(WorkBook b)` get the worksheet that this ref is on for some reason this seems to be backwards in Ref3d
`String`	`getSheetName()` return the sheet name for this 3d reference
`void`	`init(byte[] b)`
`boolean`	`isExternalLink()` returns true if this PtgRef3d's ixti refers to an external sheet reference
`void`	`populateVals()` Throw this data into a ptgref's
`void`	`setIxti(short ixf)`
`void`	`setLocation(String address)` Set Location can take either a local page address (ie A54) or a reference to a page and location(ie Sheet2!A22).
`void`	`setLocation(String[] s)` set Ptg to parsed location
`void`	`setLocation(String address, short ix)` Set the location of this PtgRef.
`void`	`setParentRec(XLSRecord r)` constructor must pass in 'parent' XLSRecord so that there is a handle for updating...
`void`	`setPtgType(short type)` set the Ptg Id type to one of: VALUE, REFERENCE or Array The Ptg type is important for certain functions which require a specific type of operand
`void`	`setReferencedSheet(Boundsheet b)` Change the sheet reference to the passed in boundsheet
`String`	`toString()`
`void`	`updateRecord()` Updates the record bytes so it can be pulled back out.

Methods inherited from class io.starter.formats.XLS.formulas.PtgRef
addToRefTracker, changeLocation, clearLocationCache, close, createPtgRefFromString, equals, getFormattedValue, getHashCode, getHashCode, getIntLocation, getIsRefErr, getIsWholeCol, getIsWholeRow, getLocationWithSheet, getRealIntLocation, getRowCol, getString, getUseReferenceTracker, getValue, is3dRef, isBlank, isColRel, isRowRel, removeFromRefTracker, setArrayTypeRef, setColRel, setExternalReference, setIsWholeCol, setIsWholeRow, setIsWholeRowCol, setLocation, setLocation, setRelativeRowCol, setRowRel, setSheetName, setUseReferenceTracker, updateInRefTracker

Methods inherited from class io.starter.formats.XLS.formulas.GenericPtg
calculatePtg, clone, evaluate, getArrayLen, 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, close, evaluate, getDoubleVal, getIntLocation, getIntVal, getIsArray, getIsBinaryOperator, getIsControl, getIsFunction, getIsOperator, getIsPrimitiveOperator, getIsStandAloneOperator, getIsUnaryOperator, getLocationPolicy, getLock, getNumParams, getOpcode, getParentRec, getPtgVal, getRecord, getString, getString2, getTextString, getTrackercell, getValue, initTrackerCell, isBlank, setLocationPolicy, setLock, setTrackercell, setVars, updateAddressFromTrackerCell

- Field Detail
  - ixti
```
public short ixti
```
- Constructor Detail
  - PtgRef3d
```
public PtgRef3d()
```
    0x3A Reference class token: The reference address itself, independent of the cell contents. • 0x5A Value class token: A value (a constant, a function result, or one specific value from a dereferenced cell range). • 0x7A Array class token: An array of values (array of constant values, an array function result, or all values of a cell range).
  - PtgRef3d
```
public PtgRef3d(boolean addToRefTracker)
```
  - PtgRef3d
```
public PtgRef3d(String addr,
                short _ixti)
```
- Method Detail
  - setParentRec
```
public void setParentRec(XLSRecord r)
```
    Description copied from interface: Ptg
    
    constructor must pass in 'parent' XLSRecord so that there is a handle for updating...
    
    Specified by:
    
    setParentRec in interface Ptg
    
    Overrides:
    
    setParentRec in class PtgRef
  - addListener
```
public void addListener()
```
    Description copied from interface: IxtiListener
    
    Add this to the ixti listeners
    
    Specified by:
    
    addListener in interface IxtiListener
  - getIxti
```
public short getIxti()
```
    Specified by:
    
    getIxti in interface IxtiListener
    
    Returns:
    
    Returns the ixti.
  - isExternalLink
```
public boolean isExternalLink()
```
    returns true if this PtgRef3d's ixti refers to an external sheet reference
    
    Returns:
  - getLength
```
public int getLength()
```
    Description copied from interface: Ptg
    
    return the length of the Ptg
    
    Specified by:
    
    getLength in interface Ptg
    
    Overrides:
    
    getLength in class PtgRef
  - getIsOperand
```
public boolean getIsOperand()
```
    Specified by:
    
    getIsOperand in interface Ptg
    
    Overrides:
    
    getIsOperand in class PtgRef
  - getIsReference
```
public boolean getIsReference()
```
    Specified by:
    
    getIsReference in interface Ptg
    
    Overrides:
    
    getIsReference in class PtgRef
  - setPtgType
```
public void setPtgType(short type)
```
    set the Ptg Id type to one of: VALUE, REFERENCE or Array
    The Ptg type is important for certain functions which require a specific type of operand
    
    Overrides:
    
    setPtgType in class PtgRef
  - init
```
public void init(byte[] b)
```
    Overrides:
    
    init in class PtgRef
  - getSheet
```
public Boundsheet getSheet(WorkBook b)
```
    get the worksheet that this ref is on for some reason this seems to be backwards in Ref3d
  - setLocation
```
public void setLocation(String[] s)
```
    set Ptg to parsed location
    
    Overrides:
    
    setLocation in class PtgRef
    
    Parameters:
    
    loc - String[] sheet1, range, sheet2, exref1, exref2
  - setLocation
```
public void setLocation(String address)
```
    Set Location can take either a local page address (ie A54) or a reference to a page and location(ie Sheet2!A22). It then changes the location reference of the Ptg.
    
    Specified by:
    
    setLocation in interface Ptg
    
    Overrides:
    
    setLocation in class PtgRef
    
    See Also:
    
    Ptg.setLocation(java.lang.String)
  - populateVals
```
public void populateVals()
```
    Throw this data into a ptgref's
    
    Overrides:
    
    populateVals in class PtgRef
  - setLocation
```
public void setLocation(String address,
                        short ix)
```
    Set the location of this PtgRef. This takes a location such as "a14"
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class PtgRef
  - setIxti
```
public void setIxti(short ixf)
```
    Specified by:
    
    setIxti in interface IxtiListener
    
    Parameters:
    
    ixf - The ixti to set.
  - setReferencedSheet
```
public void setReferencedSheet(Boundsheet b)
```
    Change the sheet reference to the passed in boundsheet
    
    See Also:
    
    PtgArea3d.setReferencedSheet(io.starter.formats.XLS.Boundsheet)
  - getLocation
```
public String getLocation()
```
    Returns the location of the Ptg as a string, including sheet name
    
    Specified by:
    
    getLocation in interface Ptg
    
    Overrides:
    
    getLocation in class PtgRef
    
    Returns:
    
    Location
    
    See Also:
    
    GenericPtg.getLocation()
  - updateRecord
```
public void updateRecord()
```
    Updates the record bytes so it can be pulled back out.
    
    Specified by:
    
    updateRecord in interface Ptg
    
    Overrides:
    
    updateRecord in class PtgRef
  - getSheet
```
public Boundsheet getSheet()
```
  - getSheetName
```
public String getSheetName()
```
    return the sheet name for this 3d reference
    
    Overrides:
    
    getSheetName in class PtgRef
  - getRefCells
```
public BiffRec[] getRefCells()
```
    Overrides:
    
    getRefCells in class PtgRef
    
    Returns:
    
    Returns the refCell.
  - getComponents
```
public Ptg[] getComponents()
```
    PtgRef's have no sub-compnents
    
    Specified by:
    
    getComponents in interface Ptg
    
    Overrides:
    
    getComponents in class GenericPtg
  - getColComponents
```
public Ptg[] getColComponents(int colNum)
```
    return the ptg components for a certain column within a ptgArea()
    
    Parameters:
    
    colNum -
    
    Returns:
    
    all Ptg's within colNum

Class PtgRef3d

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

Field Detail

ixti

Constructor Detail

PtgRef3d

PtgRef3d

PtgRef3d

Method Detail

setParentRec

addListener

getIxti

isExternalLink

getLength

getIsOperand

getIsReference

setPtgType

init

getSheet

setLocation

setLocation

populateVals

setLocation

toString

setIxti

setReferencedSheet

getLocation

updateRecord

getSheet

getSheetName

getRefCells

getComponents

getColComponents