PtgName (OpenXLS Java Spreadsheet SDK 11.0.4 API)

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

All Implemented Interfaces:

IlblListener, Ptg, XLSConstants, Serializable, Cloneable

Direct Known Subclasses:

PtgNameX
```
public class PtgName
extends GenericPtg
implements Ptg, IlblListener
```
This PTG stores an index to a name. The ilbl field is a 1 based index to the table of NAME records in the workbook OFFSET NAME sIZE CONTENTS --------------------------------------------- 0 ilbl 2 Index to the NAME table 2 (reserved) 2 ` Must be 0;

See Also:

Ptg, Formula, Serialized Form

Field Summary
- 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

PtgName()

PtgName(int id)

Constructors
Constructor and Description
`PtgName()`
`PtgName(int id)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addListener()` Add this to the ilbl listeners
`void`	`addToRefTracker()` add this reference to the ReferenceTracker...
`Ptg[]`	`getComponents()` If a record consists of multiple sub records (ie PtgArea) return those records, else return null;
`short`	`getIlbl()`
`boolean`	`getIsOperand()`
`int`	`getLength()` Override due to mystery extra byte occasionally found in ptgName recs.
`String`	`getLocation()` return referenced Names' location
`Name`	`getName()`
`String`	`getStoredName()` get the name of the named range this refers to
`String`	`getTextString()` return the human-readable String representation of this ptg -- if applicable
`int`	`getVal()`
`Object`	`getValue()` returns the value of an operand ptg.
`void`	`init(byte[] b)`
`void`	`setIlbl(short i)`
`void`	`setName(String name)` For creating a ptg name from formula parser
`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`	`setVal(int i)`
`void`	`storeName(String nm)` Store the name string for matching missing references
`String`	`toString()`
`void`	`updateRecord()` update the Ptg

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
calculatePtg, clone, close, evaluate, getDoubleVal, getIntLocation, getIntVal, getIsArray, getIsBinaryOperator, getIsControl, getIsFunction, getIsOperator, getIsPrimitiveOperator, getIsReference, getIsStandAloneOperator, getIsUnaryOperator, getLocationPolicy, getLock, getNumParams, getOpcode, getParentRec, getPtgVal, getRecord, getString, getString2, getTrackercell, initTrackerCell, isBlank, setLocation, setLocationPolicy, setLock, setParentRec, setTrackercell, setVars, updateAddressFromTrackerCell

- Constructor Detail
  - PtgName
```
public PtgName()
```
  - PtgName
```
public PtgName(int id)
```
- Method Detail
  - getIsOperand
```
public boolean getIsOperand()
```
    Specified by:
    
    getIsOperand in interface Ptg
    
    Overrides:
    
    getIsOperand in class GenericPtg
  - getName
```
public Name getName()
```
  - init
```
public void init(byte[] b)
```
    Overrides:
    
    init in class GenericPtg
  - 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
  - addToRefTracker
```
public void addToRefTracker()
```
    add this reference to the ReferenceTracker... this is crucial if we are to update this Ptg when cells are changed or added...
  - setName
```
public void setName(String name)
```
    For creating a ptg name from formula parser
  - getVal
```
public int getVal()
```
  - getIlbl
```
public short getIlbl()
```
    Specified by:
    
    getIlbl in interface IlblListener
    
    Returns:
    
    Returns the Ilbl.
  - storeName
```
public void storeName(String nm)
```
    Description copied from interface: IlblListener
    
    Store the name string for matching missing references
    
    Specified by:
    
    storeName in interface IlblListener
  - setIlbl
```
public void setIlbl(short i)
```
    Specified by:
    
    setIlbl in interface IlblListener
  - getValue
```
public Object getValue()
```
    Description copied from class: GenericPtg
    
    returns the value of an operand ptg.
    
    Specified by:
    
    getValue in interface Ptg
    
    Overrides:
    
    getValue in class GenericPtg
    
    Returns:
    
    null for non-operand Ptg.
  - getTextString
```
public String getTextString()
```
    Description copied from class: GenericPtg
    
    return the human-readable String representation of this ptg -- if applicable
    
    Specified by:
    
    getTextString in interface Ptg
    
    Overrides:
    
    getTextString in class GenericPtg
  - getStoredName
```
public String getStoredName()
```
    Description copied from interface: IlblListener
    
    get the name of the named range this refers to
    
    Specified by:
    
    getStoredName in interface IlblListener
    
    Returns:
  - setVal
```
public void setVal(int i)
```
  - updateRecord
```
public void updateRecord()
```
    Description copied from class: GenericPtg
    
    update the Ptg
    
    Specified by:
    
    updateRecord in interface Ptg
    
    Overrides:
    
    updateRecord in class GenericPtg
  - getLength
```
public int getLength()
```
    Override due to mystery extra byte occasionally found in ptgName recs.
    
    Specified by:
    
    getLength in interface Ptg
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getComponents
```
public Ptg[] getComponents()
```
    Description copied from interface: Ptg
    
    If a record consists of multiple sub records (ie PtgArea) return those records, else return null;
    
    Specified by:
    
    getComponents in interface Ptg
    
    Overrides:
    
    getComponents in class GenericPtg
  - getLocation
```
public String getLocation()
                   throws FormulaNotFoundException
```
    return referenced Names' location
    
    Specified by:
    
    getLocation in interface Ptg
    
    Overrides:
    
    getLocation in class GenericPtg
    
    Returns:
    
    Location
    
    Throws:
    
    FormulaNotFoundException
    
    See Also:
    
    GenericPtg.getLocation()
  - addListener
```
public void addListener()
```
    Description copied from interface: IlblListener
    
    Add this to the ilbl listeners
    
    Specified by:
    
    addListener in interface IlblListener

Class PtgName

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

Constructor Detail

PtgName

PtgName

Method Detail

getIsOperand

getName

init

setPtgType

addToRefTracker

setName

getVal

getIlbl

storeName

setIlbl

getValue

getTextString

getStoredName

setVal

updateRecord

getLength

toString

getComponents

getLocation

addListener