io.starter.formats.XLS

Class Supbook

java.lang.Object

io.starter.formats.XLS.XLSRecord

io.starter.formats.XLS.Supbook

All Implemented Interfaces:

BlockByteConsumer, BiffRec, XLSConstants, Serializable

public final class Supbook
extends XLSRecord

Supbook: Supporting Workbook (1AEh)
Supbook records store information about a supporting external workbook

   for ADD-IN SUPBOOK record (occurs before Global SUPBOOK record)
    offset  name        size    contents
    ---
    0                                   2               01 00 (0001H)
    2                                   2               01 58 (0x3A) = Add-In supbook record
    
   for global SUPBOOK record (SUPBOOK 0) = Internal 3d References
    offset  name        size    contents
    ---
    0           nSheets         2               number of sheets in the workbook
    2                                   2               01 04 = global or own SUPBOOK record
    
    
    SUPBOOK records for External References:
    offset  name        size    contents
    ---
    4       ctab        2       number of tabs in the workbook
    6       StVirtPath  var     Encoded file name (unicode)
    var     Rgst        var     An array of tab sheet names (unicode)
    
   SUPBOOK records for OLE Objects/DDE
    offset  name        size    contents
    ---
    0                                   2               0000 
    2                                   var             Encoded document name
    
    
    

See Also:

Boundsheet, Externsheet, 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
Supbook()

Method Summary

Modifier and Type	Method and Description
short	addExternalSheetReference(String externalSheet) add an external sheet reference to this External Supbook record
protected static XLSRecord	getAddInPrototype() SupBook record for add-in is different
protected static XLSRecord	getExternalPrototype(String externalWorkbook) creates a new External Supbook Record for the externalWorkbook
String	getExternalSheetName(int i) FOR EXTERNAL SUPBOOKS, returns the i-th sheetname
String	getExternalWorkBook() return the External WorkBook represented by this External Supbook Record or null if it's not an external supbook
protected static XLSRecord	getPrototype(int numtabs) Constructor
void	init() perform record initialization
boolean	isAddInRecord() is this an Add-in Supbook record
boolean	isExternalRecord() returns if this supbook record is the external supbook record, linking sheets in an external workbook
boolean	isGlobalRecord() is this the global or default supbook record, delineating the total number of sheets in this workbook
void	preStream() If the record is an addinrecord, update the number of sheets referred to.
String	toString() return String representation

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

addContinue, clone, close, 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, getPrototype, 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, setWorkBook, setXFRecord, setXFRecord, shouldEncrypt, toHexDump

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Supbook

public Supbook()

Method Detail

init

public void init()

Description copied from class: XLSRecord

perform record initialization

Specified by:

init in interface BiffRec

Overrides:

init in class XLSRecord

getPrototype

protected static XLSRecord getPrototype(int numtabs)

Constructor

getAddInPrototype

protected static XLSRecord getAddInPrototype()

SupBook record for add-in is different

getExternalPrototype

protected static XLSRecord getExternalPrototype(String externalWorkbook)

creates a new External Supbook Record for the externalWorkbook

Parameters:

externalWorkbook - String

Returns:

addExternalSheetReference

public short addExternalSheetReference(String externalSheet)

add an external sheet reference to this External Supbook record

Parameters:

sheetName -

getExternalSheetName

public String getExternalSheetName(int i)

FOR EXTERNAL SUPBOOKS, returns the i-th sheetname

Parameters:

i -

Returns:

isAddInRecord

public boolean isAddInRecord()

is this an Add-in Supbook record

isGlobalRecord

public boolean isGlobalRecord()

is this the global or default supbook record, delineating the total number of sheets in this workbook

Returns:

isExternalRecord

public boolean isExternalRecord()

returns if this supbook record is the external supbook record, linking sheets in an external workbook

Returns:

getExternalWorkBook

public String getExternalWorkBook()

return the External WorkBook represented by this External Supbook Record or null if it's not an external supbook

Returns:

preStream

public void preStream()

If the record is an addinrecord, update the number of sheets referred to.

Specified by:

preStream in interface BiffRec

Overrides:

preStream in class XLSRecord

See Also:

XLSRecord.preStream()

toString

public String toString()

return String representation

Overrides:

toString in class XLSRecord