io.starter.formats.XLS.formulas

Class PtgArea3d

java.lang.Object

io.starter.formats.XLS.formulas.GenericPtg

io.starter.formats.XLS.formulas.PtgRef

io.starter.formats.XLS.formulas.PtgArea

io.starter.formats.XLS.formulas.PtgArea3d

All Implemented Interfaces:

IxtiListener, Ptg, XLSConstants, Serializable, Cloneable

Direct Known Subclasses:

PtgAreaErr3d

public class PtgArea3d
extends PtgArea
implements Ptg, IxtiListener

ptgArea3d is a reference to an area (rectangle) of cells. Essentially it is a collection of two ptgRef's, so it will be treated that way in the code... implies external sheet ref (rather than ptgarea)

    Offset      Name        Size    Contents
    ----------------------------------------------------
    0           ixti        2       index into the Externsheet record
    2           rwFirst     2       The First row of the reference 
    4           rwLast      2       The Last row of the reference 
    6           grbitColFirst   2       (see following table)
    8           grbitColLast    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
    

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. is the above correct?? Documentation sez different!!!!!

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

firstPtg, lastPtg

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
PtgArea3d() create new PtgArea3d
PtgArea3d(boolean useReferenceTracker)

Method Summary

Modifier and Type	Method and Description
void	addListener() link to the externsheet to be automatically updated upon removals
void	close() clear out object references in prep for closing workbook
boolean	contains(CellHandle ch) returns whether this CellRange Contains a Cell
Object[]	getAllVals() return all of the Ptg values represented in this array will have to reference the workbook cells as well as any upstream formulas...
Ptg[]	getComponents() Returns all of the cells of this range as PtgRef's.
Boundsheet	getFirstSheet() return the first sheet referenced
int[]	getIntLocation() returns the location of the ptg as an array of shorts.
boolean	getIsOperand()
boolean	getIsReference()
short	getIxti()
Boundsheet	getLastSheet() return the last sheet referenced
String	getLastSheetName() return the name of the last sheet referenced if it's an external ref
int	getLength() return the length of the Ptg
Boundsheet	getSheet() return the first sheet referenced
String	getSheetName() get the sheet name from the 1st 3d reference
Boundsheet[]	getSheets(WorkBook b) get the worksheet that this ref is on
String	getString() return the human-readable String representation of this ptg -- if applicable
void	init(byte[] b, XLSRecord parent) constructor, takes the array of the ptgRef, including the identifier so we do not need to figure it out again later...
boolean	isExternalRef() return true if this PtgArea3d is an external reference i.e.
void	populateVals() Throw this data into two ptgref's
void	setColRel(boolean relative) sets the column to be relative (relative is true) or absolute (relative is false) absolute references do not shift upon column inserts or deletes NOTE: DOES NOT handle asymmetrical ranges i.e.
void	setIxti(short ixf) set the pointer into the Externsheet Rec.
void	setLocation(String address) Set the location of this PtgRef.
void	setLocation(String[] s) set Ptg Location to parsed location
void	setParentRec(XLSRecord rec) 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 25H (tAreaR), 45H (tAreaV), 65H (tAreaA) The Ptg type is important for certain functions which require a specific type of operand
void	setReferencedSheet(Boundsheet b) Switches the two internal ptgref3ds to a new sheet.
void	setRowRel(boolean relative) sets the row to be relative (relative is true) or absolute (relative is false) absolute references do not shift upon row inserts or deletes NOTE: DOES NOT handle asymmetrical ranges i.e.
String	toString()
void	updateRecord() Updates the record bytes so it can be pulled back out.

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

contains, contains, getColComponents, getFirstPtg, getHashCode, getLastPtg, getLocation, getRefCells, getRowCol, getRowComponents, getValue, init, setFirstPtg, setLastPtg, setLocation, setWholeRowCol

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

addToRefTracker, changeLocation, clearLocationCache, createPtgRefFromString, equals, getFormattedValue, getHashCode, getIsRefErr, getIsWholeCol, getIsWholeRow, getLocationWithSheet, getRealIntLocation, getUseReferenceTracker, is3dRef, isBlank, isColRel, isRowRel, removeFromRefTracker, setArrayTypeRef, setExternalReference, setIsWholeCol, setIsWholeRow, setIsWholeRowCol, setLocation, setRelativeRowCol, 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, evaluate, getDoubleVal, getIntVal, getIsArray, getIsBinaryOperator, getIsControl, getIsFunction, getIsOperator, getIsPrimitiveOperator, getIsStandAloneOperator, getIsUnaryOperator, getLocation, getLocationPolicy, getLock, getNumParams, getOpcode, getParentRec, getPtgVal, getRecord, getString2, getTextString, getTrackercell, getValue, initTrackerCell, isBlank, setLocationPolicy, setLock, setTrackercell, setVars, updateAddressFromTrackerCell

Field Detail

ixti

public short ixti

Constructor Detail

PtgArea3d

public PtgArea3d()

create new PtgArea3d

PtgArea3d

public PtgArea3d(boolean useReferenceTracker)

Method Detail

getIsOperand

public boolean getIsOperand()

Specified by:

getIsOperand in interface Ptg

Overrides:

getIsOperand in class PtgArea

getIsReference

public boolean getIsReference()

Specified by:

getIsReference in interface Ptg

Overrides:

getIsReference in class PtgArea

getString

public String getString()

return the human-readable String representation of this ptg -- if applicable

Specified by:

getString in interface Ptg

Overrides:

getString in class PtgArea

addListener

public void addListener()

link to the externsheet to be automatically updated upon removals

Specified by:

addListener in interface IxtiListener

toString

public String toString()

Overrides:

toString in class PtgArea

setPtgType

public void setPtgType(short type)

set the Ptg Id type to one of: VALUE, REFERENCE or Array 25H (tAreaR), 45H (tAreaV), 65H (tAreaA)
The Ptg type is important for certain functions which require a specific type of operand

Overrides:

setPtgType in class PtgArea

getIxti

public short getIxti()

Specified by:

getIxti in interface IxtiListener

Returns:

Returns the ixti.

setIxti

public void setIxti(short ixf)

set the pointer into the Externsheet Rec. this is only valid for 3d refs

Specified by:

setIxti in interface IxtiListener

Parameters:

ixf - The ixti to set.

isExternalRef

public boolean isExternalRef()

return true if this PtgArea3d is an external reference i.e. defined in another, external workbook

Returns:

getFirstSheet

public Boundsheet getFirstSheet()

return the first sheet referenced

Returns:

getLastSheet

public Boundsheet getLastSheet()

return the last sheet referenced

Returns:

setParentRec

public void setParentRec(XLSRecord rec)

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 PtgArea

getSheet

public Boundsheet getSheet()

return the first sheet referenced

Returns:

getSheetName

public String getSheetName()

get the sheet name from the 1st 3d reference

Overrides:

getSheetName in class PtgRef

getLastSheetName

public String getLastSheetName()

return the name of the last sheet referenced if it's an external ref

Returns:

getSheets

public Boundsheet[] getSheets(WorkBook b)

get the worksheet that this ref is on

init

public void init(byte[] b,
                 XLSRecord parent)

constructor, takes the array of the ptgRef, including the identifier so we do not need to figure it out again later... also takes the parent rec -- needed to init the sub-ptgs

Parameters:

b -

parent -

populateVals

public void populateVals()

Throw this data into two ptgref's

Overrides:

populateVals in class PtgArea

setLocation

public void setLocation(String address)

Set the location of this PtgRef. This takes a location such as "a14:b15" NOTE: the reference stays on the same sheet!

Specified by:

setLocation in interface Ptg

Overrides:

setLocation in class PtgArea

setLocation

public void setLocation(String[] s)

set Ptg Location to parsed location

Overrides:

setLocation in class PtgArea

Parameters:

loc - String[] sheet1, range, sheet2, exref1, exref2

getIntLocation

public int[] getIntLocation()

returns the location of the ptg as an array of shorts. [0] = firstrow [1] = firstcol [2] = lastrow [3] = lastcol

Specified by:

getIntLocation in interface Ptg

Overrides:

getIntLocation in class PtgArea

contains

public boolean contains(CellHandle ch)

returns whether this CellRange Contains a Cell

Overrides:

contains in class PtgArea

Parameters:

the - cell to test

Returns:

whether the cell is in the range

setReferencedSheet

public void setReferencedSheet(Boundsheet b)

Switches the two internal ptgref3ds to a new sheet.

getAllVals

public Object[] getAllVals()

return all of the Ptg values represented in this array will have to reference the workbook cells as well as any upstream formulas...

Returns:

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 PtgArea

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 PtgArea

getComponents

public Ptg[] getComponents()

Returns all of the cells of this range as PtgRef's. This includes empty cells, values, formulas, etc. Note the setting of parent-rec requires finding the cell the PtgRef refer's to. If that is null then the PtgRef will exist, just with a null value. This could cause issues when programatically populating cells.

Specified by:

getComponents in interface Ptg

Overrides:

getComponents in class PtgArea

setColRel

public void setColRel(boolean relative)

sets the column to be relative (relative is true) or absolute (relative is false)
absolute references do not shift upon column inserts or deletes
NOTE: DOES NOT handle asymmetrical ranges i.e. 1st ref is absolute, 2nd is relative

Overrides:

setColRel in class PtgRef

Parameters:

boolean - relative

setRowRel

public void setRowRel(boolean relative)

sets the row to be relative (relative is true) or absolute (relative is false)
absolute references do not shift upon row inserts or deletes
NOTE: DOES NOT handle asymmetrical ranges i.e. 1st ref is absolute, 2nd is relative

Overrides:

setRowRel in class PtgRef

Parameters:

boolean - relative

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