Externsheet (OpenXLS Java Spreadsheet SDK 11.0.4 API)

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

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

public final class Externsheet
extends XLSRecord

Externsheet: External Sheet Record (17h)

    offset  name        size    contents
    ---    
    4       cXTI        2       Number of XTI Structures
    6       rgXTI       var     Array of XTI Structures
    
    XTI
    offset  name        size    contents
    ---    
    0       iSUPBOOK    2       0-based index to table of SUPBOOK records
    2       itabFirst   2       0-based index to first sheet tab in reference
    4       itabLast    2       0-based index to last sheet tab in reference

See Also:: WorkBook, Boundsheet, Supbook, Serialized Form

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

Externsheet()

Constructors
Constructor and Description
`Externsheet()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`short`	`addExternalSheetRef(String externalWorkbook, String externalSheetName)`
`void`	`addPtgListener(IxtiListener p)`
`void`	`close()` clear out object references in prep for closing workbook
`String[]`	`getBoundSheetNames(int cLoc)` returns array of referenced sheet names, including external references ...
`Boundsheet[]`	`getBoundSheets(int cLoc)`
`int`	`getBrokenXtiReference()` In some cases, we need to have an Xti reference to a non-existing sheet.
`int`	`getcXTI()` get the number of refs in this Externsheet rec
`boolean`	`getIsExternalLink(int loc)` returns true if the passed in sheet number is an external link (i.e.
`protected static XLSRecord`	`getPrototype()` Constructor
`protected static XLSRecord`	`getPrototype(int sheetNum1, int sheetNum2, WorkBook bk)` Add new Externsheet record and set sheet
`int`	`getVirtualReference()` Certain records require a virtual reference, this is not a real reference to a sheet, rather an entry that is used by add in formulas, values are FE FF FE FF This method either finds the existing reference, or creates a new one and returns the pointer
`int`	`getXtiReference(String firstSheet, String secondSheet)` Gets the xti reference for a boundsheet name
`void`	`init()` perform record initialization
`int`	`insertLocation(int firstBound, int lastBound)` Insert location checks if a specific boundsheet range already has a reference.
`void`	`preStream()` do any pre-streaming processing such as expensive index updates or other deferrable processing.
`void`	`setWorkBook(WorkBook bk)`

Methods inherited from class io.starter.formats.XLS.XLSRecord
addContinue, clone, copyFormat, getBooleanVal, getByteAt, getByteReader, getBytes, getBytesAt, getCellAddress, 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, getRealRecordIndex, getRecDesc, getRecordIndex, getRow, getRowNumber, getSheet, getStreamer, getStringVal, getStringVal, getWorkBook, getXfRec, hasContinues, initRowCol, isFormula, isNumber, isReadOnly, isValueForCell, mergeContinues, postStream, remove, 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, toString

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

- Constructor Detail
  - Externsheet
```
public Externsheet()
```
- Method Detail
  - preStream
```
public void preStream()
```
    Description copied from class: XLSRecord
    
    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
  - setWorkBook
```
public void setWorkBook(WorkBook bk)
```
    Specified by:
    
    setWorkBook in interface BiffRec
    
    Overrides:
    
    setWorkBook in class XLSRecord
  - addPtgListener
```
public void addPtgListener(IxtiListener p)
                    throws WorkSheetNotFoundException
```
    Throws:
    
    WorkSheetNotFoundException
  - getBoundSheets
```
public Boundsheet[] getBoundSheets(int cLoc)
```
  - getBoundSheetNames
```
public String[] getBoundSheetNames(int cLoc)
```
    returns array of referenced sheet names, including external references ...
    
    Parameters:
    
    cLoc -
    
    Returns:
  - getIsExternalLink
```
public boolean getIsExternalLink(int loc)
```
    returns true if the passed in sheet number is an external link (i.e. an external sheet reference)
    
    Parameters:
    
    loc - external sheet number
    
    Returns:
  - getcXTI
```
public int getcXTI()
```
    get the number of refs in this Externsheet rec
  - init
```
public void init()
```
    Description copied from class: XLSRecord
    
    perform record initialization
    
    Specified by:
    
    init in interface BiffRec
    
    Overrides:
    
    init in class XLSRecord
  - addExternalSheetRef
```
public short addExternalSheetRef(String externalWorkbook,
                                 String externalSheetName)
```
  - insertLocation
```
public int insertLocation(int firstBound,
                          int lastBound)
                   throws WorkSheetNotFoundException
```
    Insert location checks if a specific boundsheet range already has a reference. If the range already exists within the externsheet the index to the range is returned. Else, it adds the range to the externsheet and returns the index.
    
    Parameters:
    
    firstBound -
    
    lastBound -
    
    Returns:
    
    Throws:
    
    WorkSheetNotFoundException
  - getPrototype
```
protected static XLSRecord getPrototype()
```
    Constructor
  - getPrototype
```
protected static XLSRecord getPrototype(int sheetNum1,
                                        int sheetNum2,
                                        WorkBook bk)
```
    Add new Externsheet record and set sheet
    
    Parameters:
    
    sheetNum1 -
    
    sheetNum2 -
    
    bk -
    
    Returns:
  - getXtiReference
```
public int getXtiReference(String firstSheet,
                           String secondSheet)
```
    Gets the xti reference for a boundsheet name
    
    Returns:
    
    xti reference, -1 if not located.
  - getVirtualReference
```
public int getVirtualReference()
```
    Certain records require a virtual reference, this is not a real reference to a sheet, rather an entry that is used by add in formulas, values are FE FF FE FF This method either finds the existing reference, or creates a new one and returns the pointer
    
    Returns:
  - getBrokenXtiReference
```
public int getBrokenXtiReference()
```
    In some cases, we need to have an Xti reference to a non-existing sheet. For instance, a chart or formula with a ptgRef3d that referrs to a missing sheet. Externsheet handles this by having an internal record populated with -1's This method searches for a non-existing record, and if that doesn't exist it creates on and passes the reference back.
    
    Returns:
    
    pointer to broken (-1) reference
  - close
```
public void close()
```
    Description copied from class: XLSRecord
    
    clear out object references in prep for closing workbook
    
    Overrides:
    
    close in class XLSRecord

Class Externsheet

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

Constructor Detail

Externsheet

Method Detail

preStream

setWorkBook

addPtgListener

getBoundSheets

getBoundSheetNames

getIsExternalLink

getcXTI

init

addExternalSheetRef

insertLocation

getPrototype

getPrototype

getXtiReference

getVirtualReference

getBrokenXtiReference

close