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

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

Direct Known Subclasses:: PtgArea3d, PtgAreaN

public class PtgArea
extends PtgRef
implements Ptg

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

    Offset      Size    Contents
    ----------------------------------------------------
        0                       2               Index to first row (065535) or offset of first row (method [B], -3276832767)
        2                       2               Index to last row (065535) or offset of last row (method [B], -3276832767)
        4                       2               Index to first column or offset of first column, with relative flags (see table above)
        6                       2               Index to last column or offset of last column, with relative flags (see table above)

    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

See Also:: Ptg, Formula, Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected PtgRef firstPtg

protected PtgRef lastPtg

static long serialVersionUID
- 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
`protected PtgRef`	`firstPtg`
`protected PtgRef`	`lastPtg`
`static long`	`serialVersionUID`

Constructor Summary

Constructors
Constructor and Description
`PtgArea()`
`PtgArea(boolean useReferenceTracker)`
`PtgArea(int[] loc, XLSRecord parent, boolean relativeRefs)`
`PtgArea(PtgRef ptg1, PtgRef ptg2, XLSRecord parent)` Creates a new PtgArea from 2 component ptgs, used by shared formula to create ptgareas.
`PtgArea(String range, XLSRecord parent)`
`PtgArea(String range, XLSRecord parent, boolean relativeRefs)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`contains(CellHandle ch)` returns whether this CellRange Contains a Cell
`boolean`	`contains(int[] rc)` returns whether this PtgArea Contains the specified row/col coordinate [0] = firstrow [1] = firstcol [2] = lastrow [3] = lastcol
`boolean`	`contains(String sn, int[] rc)` check to see if the sheet and row/col are contained in this ref
`Ptg[]`	`getColComponents(int colNum)`
`Ptg[]`	`getComponents()` Returns all of the cells of this range as PtgRef's.
`PtgRef`	`getFirstPtg()`
`protected long`	`getHashCode()` uniquely identifies a row/col to unencrypt: col= hashcode%maxcols row= hashcode/maxcols -1
`int[]`	`getIntLocation()` returns the location of the ptg as an array of ints.
`boolean`	`getIsOperand()`
`boolean`	`getIsReference()`
`PtgRef`	`getLastPtg()`
`int`	`getLength()` return the length of the Ptg
`String`	`getLocation()` Returns the location of the Ptg as a string (ie c4)
`BiffRec[]`	`getRefCells()`
`int[]`	`getRowCol()` returns the row/col ints for the ref Format is FirstRow,FirstCol,LastRow,LastCol
`Ptg[]`	`getRowComponents(int rowNum)` return the ptg components for a certain column within a ptgArea()
`String`	`getString()` return the human-readable String representation of this ptg -- if applicable
`Object`	`getValue()` returns the value of the cell refereced by the PtgRef
`void`	`init(byte[] b)`
`void`	`populateVals()` parse all the values out of the byte array and populate the classes values
`void`	`setFirstPtg(PtgRef ref)`
`void`	`setLastPtg(PtgRef ref)`
`void`	`setLocation(int[] rowcol)` Set the location of this PtgArea.
`void`	`setLocation(String address)` Set the location of this PtgRef.
`void`	`setLocation(String[] loc)` set Ptg 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`	`setWholeRowCol()` set the wholeRow and/or wholeCol flag for this PtgArea for ranges such as: $B:$B and $5:%9
`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, getIsRefErr, getIsWholeCol, getIsWholeRow, getLocationWithSheet, getRealIntLocation, getSheetName, getUseReferenceTracker, is3dRef, isBlank, isColRel, isRowRel, removeFromRefTracker, setArrayTypeRef, setColRel, setExternalReference, setIsWholeCol, setIsWholeRow, setIsWholeRowCol, 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, getIntVal, getIsArray, getIsBinaryOperator, getIsControl, getIsFunction, getIsOperator, getIsPrimitiveOperator, getIsStandAloneOperator, getIsUnaryOperator, getLocationPolicy, getLock, getNumParams, getOpcode, getParentRec, getPtgVal, getRecord, getString2, getTextString, getTrackercell, initTrackerCell, isBlank, setLocationPolicy, setLock, setTrackercell, setVars, updateAddressFromTrackerCell

- Field Detail
  - serialVersionUID
```
public static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - firstPtg
```
protected PtgRef firstPtg
```
  - lastPtg
```
protected PtgRef lastPtg
```
- Constructor Detail
  - PtgArea
```
public PtgArea(String range,
               XLSRecord parent)
```
  - PtgArea
```
public PtgArea(PtgRef ptg1,
               PtgRef ptg2,
               XLSRecord parent)
```
    Creates a new PtgArea from 2 component ptgs, used by shared formula to create ptgareas. ptg1 should be upperleft corner, ptg2 bottomright
  - PtgArea
```
public PtgArea(String range,
               XLSRecord parent,
               boolean relativeRefs)
```
  - PtgArea
```
public PtgArea(int[] loc,
               XLSRecord parent,
               boolean relativeRefs)
```
  - PtgArea
```
public PtgArea()
```
  - PtgArea
```
public PtgArea(boolean useReferenceTracker)
```
- Method Detail
  - 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
  - init
```
public void init(byte[] b)
```
    Overrides:
    
    init in class PtgRef
  - populateVals
```
public void populateVals()
```
    Description copied from class: PtgRef
    
    parse all the values out of the byte array and populate the classes values
    
    Overrides:
    
    populateVals in class PtgRef
  - 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 GenericPtg
  - getRowCol
```
public int[] getRowCol()
```
    returns the row/col ints for the ref Format is FirstRow,FirstCol,LastRow,LastCol
    
    Overrides:
    
    getRowCol in class PtgRef
    
    Returns:
  - contains
```
public boolean contains(CellHandle ch)
```
    returns whether this CellRange Contains a Cell
    
    Parameters:
    
    the - cell to test
    
    Returns:
    
    whether the cell is in the range
  - contains
```
public boolean contains(String sn,
                        int[] rc)
```
    check to see if the sheet and row/col are contained in this ref
    
    Parameters:
    
    sheetname -
    
    rc -
    
    Returns:
  - contains
```
public boolean contains(int[] rc)
```
    returns whether this PtgArea Contains the specified row/col coordinate [0] = firstrow [1] = firstcol [2] = lastrow [3] = lastcol
    
    Parameters:
    
    the - rc coordinates to test
    
    Returns:
    
    whether the coordinates are in the range
  - 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 PtgRef
  - setWholeRowCol
```
public void setWholeRowCol()
```
    set the wholeRow and/or wholeCol flag for this PtgArea for ranges such as: $B:$B and $5:%9
  - 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 PtgRef
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class PtgRef
  - 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 PtgRef
  - 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
  - setLocation
```
public void setLocation(String[] loc)
```
    set Ptg to parsed location
    
    Overrides:
    
    setLocation in class PtgRef
    
    Parameters:
    
    loc - String[] sheet1, range, sheet2, exref1, exref2
  - getIntLocation
```
public int[] getIntLocation()
```
    returns the location of the ptg as an array of ints. [0] = firstRow [1] = firstCol [2] = lastRow [3] = lastCol
    
    Specified by:
    
    getIntLocation in interface Ptg
    
    Overrides:
    
    getIntLocation in class PtgRef
  - setLocation
```
public void setLocation(int[] rowcol)
```
    Set the location of this PtgArea. This takes a location such as {1,2,3,4}
    
    Overrides:
    
    setLocation in class PtgRef
  - getLocation
```
public String getLocation()
```
    Description copied from class: PtgRef
    
    Returns the location of the Ptg as a string (ie c4)
    
    Specified by:
    
    getLocation in interface Ptg
    
    Overrides:
    
    getLocation in class PtgRef
    
    Returns:
    
    Location
    
    See Also:
    
    GenericPtg.getLocation()
  - updateRecord
```
public void updateRecord()
```
    Description copied from class: PtgRef
    
    Updates the record bytes so it can be pulled back out.
    
    Specified by:
    
    updateRecord in interface Ptg
    
    Overrides:
    
    updateRecord in class PtgRef
  - 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
  - getValue
```
public Object getValue()
```
    Description copied from class: PtgRef
    
    returns the value of the cell refereced by the PtgRef
    
    Specified by:
    
    getValue in interface Ptg
    
    Overrides:
    
    getValue in class PtgRef
    
    Returns:
    
    null for non-operand Ptg.
  - getColComponents
```
public Ptg[] getColComponents(int colNum)
```
  - getRowComponents
```
public Ptg[] getRowComponents(int rowNum)
```
    return the ptg components for a certain column within a ptgArea()
    
    Parameters:
    
    rowNum -
    
    Returns:
    
    all Ptg's within colNum
  - getFirstPtg
```
public PtgRef getFirstPtg()
```
    Returns:
  - getLastPtg
```
public PtgRef getLastPtg()
```
    Returns:
  - setFirstPtg
```
public void setFirstPtg(PtgRef ref)
```
    Parameters:
    
    ref -
  - setLastPtg
```
public void setLastPtg(PtgRef ref)
```
    Parameters:
    
    ref -
  - getRefCells
```
public BiffRec[] getRefCells()
```
    Overrides:
    
    getRefCells in class PtgRef
    
    Returns:
    
    Returns the refCell.
  - getHashCode
```
protected long getHashCode()
```
    Description copied from class: PtgRef
    
    uniquely identifies a row/col to unencrypt: col= hashcode%maxcols row= hashcode/maxcols -1
    
    Overrides:
    
    getHashCode in class PtgRef

Class PtgArea

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

serialVersionUID

firstPtg

lastPtg

Constructor Detail

PtgArea

PtgArea

PtgArea

PtgArea

PtgArea

PtgArea

Method Detail

getIsOperand

getIsReference

init

populateVals

getComponents

getRowCol

contains

contains

contains

getString

setWholeRowCol

setPtgType

toString

setParentRec

setLocation

setLocation

getIntLocation

setLocation

getLocation

updateRecord

getLength

getValue

getColComponents

getRowComponents

getFirstPtg

getLastPtg

setFirstPtg

setLastPtg

getRefCells

getHashCode