Name (OpenXLS Java Spreadsheet SDK 11.0.4 API)

java.lang.Object
- io.starter.formats.XLS.XLSRecord
- - io.starter.formats.XLS.Name

All Implemented Interfaces:: BlockByteConsumer, BiffRec, XLSConstants, Serializable

public final class Name
extends XLSRecord

Name: Defined Name (218h)
Name records describe a name in the workbook

        offset  name            size    contents
        ---
        4       grbit           2       option flags
        6       chKey           1       Keyboard Shortcut
        7       cch             1       length of name text
        8       cce             2       length of name definition *stored in Excel parsed format
        10      ixals           2       index to sheet containing name
        12      itab            2       NAME SCOPE -- 0= workbook, 1+= sheet
        14      cchCustMenu     1       length of custom menu text
        15      cchDescript     1       length of description text
        16      cchHelpTopic    1       length of help topic text
        17      cchStatusText   1       length of status bar text
        18      rgch            var     name text
        var     rgce            var     name definition
        var     rcchCustMenu    var     cust menu text
        var     rgchDescr       var     description text
        var     rgchHelpTopic   var     help text
        var     rgchStatusText  var     status bar text

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected static byte`	`_FILTER_DATABASE`
`protected static byte`	`AUTO_ACTIVATE`
`protected static byte`	`AUTO_CLOSE`
`protected static byte`	`AUTO_DEACTIVATE`
`protected static byte`	`AUTO_OPEN`
`byte`	`builtInType`
`protected static byte`	`CONSOLIDATE_AREA`
`protected static byte`	`CRITERIA`
`protected static byte`	`DATA_FORM`
`protected static byte`	`DATABASE`
`protected static byte`	`EXTRACT`
`protected static byte`	`PRINT_AREA`
`protected static byte`	`PRINT_TITLES`
`protected static byte`	`RECORDER`
`protected static byte`	`SHEET_TITLE`

Fields inherited from class io.starter.formats.XLS.XLSRecord
col, continues, DEBUGLEVEL, hyperlink, idx, isBlank, isBoolean, isContinueMerged, isString, lastidx, myxf, offset, rw, streamer, wkbook, worksheet

Fields inherited from interface io.starter.formats.XLS.XLSConstants
AI, ALLOWDUPES, ALRUNS, AREA, AREAFORMAT, ARRAY, 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
`Name()`
`Name(WorkBook bk, boolean b)` Used for default name entry in formulas.
`Name(WorkBook bk, String namestr)`
`Name(WorkBook bk, String namestr, String value, int scope)` sets a namestring to a constant (non-reference) value

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addIlblListener(IlblListener ptgname)` Store ptgName references to this Name record so they can be accessed
`void`	`close()` clear out object references in prep for closing workbook
`protected void`	`finalize()`
`Boundsheet[]`	`getBoundSheets()`
`byte`	`getBuiltInType()`
`String`	`getCachedOOXMLExpression()`
`Object`	`getCalculatedValue()` return the calculated value of this Name if it contains a parsed Expression (Formula)
`String`	`getCellAddress()` get a string address for the cell based on row and col ie: "H22"
`Ptg[]`	`getCellRangePtgs()` Returns an array of ptgs that represent any BiffRec ranges in the formula.
`Stack`	`getExpression()` Get the expression for this Name record
`String`	`getExpressionString()` Return the expression string for this name record.
`Externsheet`	`getExternsheet()`
`ArrayList`	`getIlblListeners()`
`short`	`getItab()` Return the named range scope (0= workbook, 1 or more= sheet)
`short`	`getIxals()`
`String`	`getLocation()` Return the location of the Name record.
`String`	`getName()` get the display name
`String`	`getNameA()` return the case-insensitive version of the display name
`Ptg`	`getPtga()`
`List`	`getPtgsByLocation(String loc)` Returns the ptg that matches the string location sent to it.
`void`	`init()` Initialize the Name record
`void`	`init(boolean initExpression)` init Name record
`void`	`initializeExpression(String xpression)` Essentially a wrapped setLocation call that is handled for initialization of names from OOXML files.
`boolean`	`isBuiltIn()`
`boolean`	`isStringReference()` Is this a string referencing Name?
`void`	`parseExpression()` parse Expression separately from init
`void`	`preStream()` do any pre-streaming processing such as expensive index updates or other deferrable processing.
`boolean`	`remove(boolean b)` Removes this BiffRec from the WorkSheet
`void`	`removeIlblListener(IlblListener ptgname)`
`void`	`setBuiltIn(byte builtinType)` Set this name record as a built in type.
`void`	`setCachedOOXMLExpression(String cachedOOXMLExpression)`
`void`	`setExpression(Stack x)` set the expression for this Name record
`void`	`setExternsheetRef(int x)` set the Externsheet reference for any associated PtgArea3d's
`void`	`setItab(short itab)`
`void`	`setIxals(short ixals)`
`void`	`setLocation(String newloc)`
`void`	`setLocation(String newloc, boolean clearAffectedCells)` Set the location for the first ptg in the expression
`boolean`	`setLocationPolicy(String loc, int l)` locks the Ptg at the specified location
`void`	`setName(String newname)` set the display name Affects the following byte values: 7 cch 1 length of name text 18 rgch var name text
`void`	`setNewScope(int newitab)` Set the scope (itab) of this name
`void`	`setWorkBook(WorkBook b)`
`String`	`toString()` Return the name which identifies this Name record.
`void`	`updateIlblListeners()`
`void`	`updatePtgs()` Update the record byte array with the modified ptg records
`void`	`updateSheetReferences(Boundsheet newSheet)` Set all ptg3ds to the new sheet Used when copying worksheets ..
`void`	`updateSheetRefs(String origWorkBookName)` update Ptga ixti for moved/copied worksheets

Methods inherited from class io.starter.formats.XLS.XLSRecord
addContinue, clone, copyFormat, getBooleanVal, getByteAt, getByteReader, getBytes, getBytesAt, getCellAddressWithSheet, getCellType, getColNumber, getColorTable, getContinueVect, getData, getDataType, getDblVal, getDefaultVal, getEncryptedByteReader, getFirstBlock, getFloatVal, getFont, getFormatPattern, getFormulaRec, getHyperlink, getInternalVal, getIntLocation, getIntVal, getIxfe, getLastBlock, getLength, getMergeRange, getOffset, getOpcode, getPrototype, getRealRecordIndex, getRecDesc, getRecordIndex, getRow, getRowNumber, getSheet, getStreamer, getStringVal, getStringVal, getWorkBook, getXfRec, hasContinues, initRowCol, isFormula, isNumber, isReadOnly, isValueForCell, mergeContinues, postStream, removeContinues, resetCacheBytes, setBooleanVal, setByteReader, setCol, setData, setDebugLevel, setDoubleVal, setEncryptedByteReader, setFirstBlock, setFloatVal, setHyperlink, setIndex, setIntVal, setIsValueForCell, setIxfe, setLastBlock, setLength, setMergeRange, setOffset, setOpcode, setRow, setRowCol, setRowNumber, setSheet, setStreamer, setStringVal, setValueForCell, setXFRecord, setXFRecord, shouldEncrypt, toHexDump

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

- Field Detail
  - builtInType
```
public byte builtInType
```
  - CONSOLIDATE_AREA
```
protected static final byte CONSOLIDATE_AREA
```
    See Also:
    
    Constant Field Values
  - AUTO_OPEN
```
protected static final byte AUTO_OPEN
```
    See Also:
    
    Constant Field Values
  - AUTO_CLOSE
```
protected static final byte AUTO_CLOSE
```
    See Also:
    
    Constant Field Values
  - EXTRACT
```
protected static final byte EXTRACT
```
    See Also:
    
    Constant Field Values
  - DATABASE
```
protected static final byte DATABASE
```
    See Also:
    
    Constant Field Values
  - CRITERIA
```
protected static final byte CRITERIA
```
    See Also:
    
    Constant Field Values
  - PRINT_AREA
```
protected static final byte PRINT_AREA
```
    See Also:
    
    Constant Field Values
  - PRINT_TITLES
```
protected static final byte PRINT_TITLES
```
    See Also:
    
    Constant Field Values
  - RECORDER
```
protected static final byte RECORDER
```
    See Also:
    
    Constant Field Values
  - DATA_FORM
```
protected static final byte DATA_FORM
```
    See Also:
    
    Constant Field Values
  - AUTO_ACTIVATE
```
protected static final byte AUTO_ACTIVATE
```
    See Also:
    
    Constant Field Values
  - AUTO_DEACTIVATE
```
protected static final byte AUTO_DEACTIVATE
```
    See Also:
    
    Constant Field Values
  - SHEET_TITLE
```
protected static final byte SHEET_TITLE
```
    See Also:
    
    Constant Field Values
  - _FILTER_DATABASE
```
protected static final byte _FILTER_DATABASE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Name
```
public Name()
```
  - Name
```
public Name(WorkBook bk,
            String namestr)
```
  - Name
```
public Name(WorkBook bk,
            boolean b)
```
    Used for default name entry in formulas. The name will not exist in the workbook outside of the formula it is used in. It has no location.
    
    Parameters:
    
    bk - Workbook containing name
    
    b - Use whatever, just a flag to use this different constructor
  - Name
```
public Name(WorkBook bk,
            String namestr,
            String value,
            int scope)
```
    sets a namestring to a constant (non-reference) value
    
    Parameters:
    
    bk -
    
    namestr - String name
    
    value - The expression statement
    
    scope - 1 based reference to sheet scope, 0 is for workbook (default)
- Method Detail
  - addIlblListener
```
public void addIlblListener(IlblListener ptgname)
```
    Store ptgName references to this Name record so they can be accessed
  - removeIlblListener
```
public void removeIlblListener(IlblListener ptgname)
```
  - getIlblListeners
```
public ArrayList getIlblListeners()
```
  - updateIlblListeners
```
public void updateIlblListeners()
```
  - init
```
public void init()
```
    Initialize the Name record
    
    Specified by:
    
    init in interface BiffRec
    
    Overrides:
    
    init in class XLSRecord
    
    See Also:
    
    XLSRecord.init()
  - init
```
public void init(boolean initExpression)
```
    init Name record
    
    Parameters:
    
    initExpression - true if should parse formula/ref expression (will be false on wb load)
  - parseExpression
```
public void parseExpression()
```
    parse Expression separately from init
  - getBoundSheets
```
public Boundsheet[] getBoundSheets()
```
  - toString
```
public String toString()
```
    Return the name which identifies this Name record. If this is a built in record it will return a generic version of what the built-in is doing.
    
    Overrides:
    
    toString in class XLSRecord
    
    See Also:
    
    XLSRecord.toString()
  - getExpressionString
```
public String getExpressionString()
```
    Return the expression string for this name record.
    
    Returns:
  - getExpression
```
public Stack getExpression()
```
    Get the expression for this Name record
    
    Returns:
  - setExpression
```
public void setExpression(Stack x)
```
    set the expression for this Name record
  - getLocation
```
public String getLocation()
                   throws Exception
```
    Return the location of the Name record. This seems to be slightly wrong as it only returns the location of PTGA. It's possible to have more complex records than this.
    
    Returns:
    
    Throws:
    
    Exception
  - isStringReference
```
public boolean isStringReference()
```
    Is this a string referencing Name?
    
    Returns:
  - initializeExpression
```
public void initializeExpression(String xpression)
```
    Essentially a wrapped setLocation call that is handled for initialization of names from OOXML files. Our parsing is not up to snuff for some more complex name records, and this is a workaround until we are able to handle those expressions TODO: parse complex expressions better and get rid of this method
    
    Parameters:
    
    xpression -
  - setLocation
```
public void setLocation(String newloc)
```
  - setLocation
```
public void setLocation(String newloc,
                        boolean clearAffectedCells)
                 throws FunctionNotSupportedException
```
    Set the location for the first ptg in the expression
    
    Parameters:
    
    newloc -
    
    clearAffectedCells - true if should clear ptga formula cached vals
    
    Throws:
    
    FunctionNotSupportedException - TODO
  - remove
```
public boolean remove(boolean b)
```
    Description copied from class: XLSRecord
    
    Removes this BiffRec from the WorkSheet
    
    Specified by:
    
    remove in interface BiffRec
    
    Overrides:
    
    remove in class XLSRecord
  - setWorkBook
```
public void setWorkBook(WorkBook b)
```
    Specified by:
    
    setWorkBook in interface BiffRec
    
    Overrides:
    
    setWorkBook in class XLSRecord
  - setExternsheetRef
```
public void setExternsheetRef(int x)
```
    set the Externsheet reference for any associated PtgArea3d's
  - updateSheetRefs
```
public void updateSheetRefs(String origWorkBookName)
```
    update Ptga ixti for moved/copied worksheets
  - setName
```
public void setName(String newname)
```
    set the display name Affects the following byte values: 7 cch 1 length of name text 18 rgch var name text
  - getName
```
public String getName()
```
    get the display name
  - getNameA
```
public String getNameA()
```
    return the case-insensitive version of the display name
    
    Returns:
  - getCalculatedValue
```
public Object getCalculatedValue()
                          throws FunctionNotSupportedException
```
    return the calculated value of this Name if it contains a parsed Expression (Formula)
    
    Returns:
    
    Throws:
    
    FunctionNotSupportedException
  - preStream
```
public void preStream()
```
    do any pre-streaming processing such as expensive index updates or other deferrable processing.
    
    Specified by:
    
    preStream in interface BiffRec
    
    Overrides:
    
    preStream in class XLSRecord
  - updatePtgs
```
public void updatePtgs()
```
    Update the record byte array with the modified ptg records
  - getCellAddress
```
public String getCellAddress()
```
    Description copied from class: XLSRecord
    
    get a string address for the cell based on row and col ie: "H22"
    
    Specified by:
    
    getCellAddress in interface BiffRec
    
    Overrides:
    
    getCellAddress in class XLSRecord
  - getCellRangePtgs
```
public Ptg[] getCellRangePtgs()
                       throws FormulaNotFoundException
```
    Returns an array of ptgs that represent any BiffRec ranges in the formula. Ranges can either be in the format "C5" or "Sheet1!C4:D9"
    
    Throws:
    
    FormulaNotFoundException
  - getPtgsByLocation
```
public List getPtgsByLocation(String loc)
```
    Returns the ptg that matches the string location sent to it. this can either be in the format "C5" or a range, such as "C4:D9"
  - updateSheetReferences
```
public void updateSheetReferences(Boundsheet newSheet)
```
    Set all ptg3ds to the new sheet
    Used when copying worksheets ..
    
    Parameters:
    
    newSheet -
  - setLocationPolicy
```
public boolean setLocationPolicy(String loc,
                                 int l)
```
    locks the Ptg at the specified location
  - getExternsheet
```
public Externsheet getExternsheet()
```
  - getPtga
```
public Ptg getPtga()
```
  - isBuiltIn
```
public boolean isBuiltIn()
```
  - getBuiltInType
```
public byte getBuiltInType()
```
  - setBuiltIn
```
public void setBuiltIn(byte builtinType)
```
    Set this name record as a built in type. Use the static bytes to set the built in type.
    
    Parameters:
    
    builtinType -
  - getIxals
```
public short getIxals()
```
  - setIxals
```
public void setIxals(short ixals)
```
  - getItab
```
public short getItab()
```
    Return the named range scope (0= workbook, 1 or more= sheet)
    
    Returns:
    
    Named Range Scope
  - setItab
```
public void setItab(short itab)
```
  - getCachedOOXMLExpression
```
public String getCachedOOXMLExpression()
```
    Returns:
    
    Returns the cachedOOXMLExpression.
  - setCachedOOXMLExpression
```
public void setCachedOOXMLExpression(String cachedOOXMLExpression)
```
    Parameters:
    
    cachedOOXMLExpression - The cachedOOXMLExpression to set.
  - setNewScope
```
public void setNewScope(int newitab)
                 throws WorkSheetNotFoundException
```
    Set the scope (itab) of this name
    
    Parameters:
    
    newitab -
    
    Throws:
    
    WorkSheetNotFoundException
  - close
```
public void close()
```
    clear out object references in prep for closing workbook
    
    Overrides:
    
    close in class XLSRecord
  - finalize
```
protected void finalize()
```
    Overrides:
    
    finalize in class Object

Class Name

Field Summary

Fields inherited from class io.starter.formats.XLS.XLSRecord

Fields inherited from interface io.starter.formats.XLS.XLSConstants

Constructor Summary

Method Summary

Methods inherited from class io.starter.formats.XLS.XLSRecord

Methods inherited from class java.lang.Object

Field Detail

builtInType

CONSOLIDATE_AREA

AUTO_OPEN

AUTO_CLOSE

EXTRACT

DATABASE

CRITERIA

PRINT_AREA

PRINT_TITLES

RECORDER

DATA_FORM

AUTO_ACTIVATE

AUTO_DEACTIVATE

SHEET_TITLE

_FILTER_DATABASE

Constructor Detail

Name

Name

Name

Name

Method Detail

addIlblListener

removeIlblListener

getIlblListeners

updateIlblListeners

init

init

parseExpression

getBoundSheets

toString

getExpressionString

getExpression

setExpression

getLocation

isStringReference

initializeExpression

setLocation

setLocation

remove

setWorkBook

setExternsheetRef

updateSheetRefs

setName

getName

getNameA

getCalculatedValue

preStream

updatePtgs

getCellAddress

getCellRangePtgs

getPtgsByLocation

updateSheetReferences

setLocationPolicy

getExternsheet

getPtga

isBuiltIn

getBuiltInType

setBuiltIn

getIxals

setIxals

getItab

setItab

getCachedOOXMLExpression

setCachedOOXMLExpression

setNewScope

close

finalize