WorkBook (OpenXLS Java Spreadsheet SDK 11.0.4 API)

java.lang.Object
- io.starter.formats.XLS.WorkBook

All Implemented Interfaces:: Book, XLSConstants, Serializable

public class WorkBook
extends Object
implements Serializable, XLSConstants, Book

    The WorkBook record represents an XLS workbook substream containing worksheets and associated records.

See Also:: WorkBook, Boundsheet, Index, Dbcell, Row, Cell, XLSRecord, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALLOWDUPES`
`Color[]`	`colorTable`
`static String`	`CONVERTMULBLANKS`
`HashMap`	`formatCache`
`int`	`lastSPID`
`MSODrawingGroup`	`msodg`
`AbstractList`	`msodgMerge`
`static int`	`SHAREDUPES`
`static int`	`STRING_ENCODING_AUTO`
`static int`	`STRING_ENCODING_COMPRESSED`
`static int`	`STRING_ENCODING_UNICODE`

Fields inherited from interface io.starter.formats.XLS.XLSConstants
AI, 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, SHEETLAYOUT, SHEETPROTECTION, SHRFMLA, SHTPROPS, SIIINDEX, SST, STARTBLOCK, STARTOBJECT, 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

WorkBook()
default constructor -- do init

Constructors
Constructor and Description
`WorkBook()` default constructor -- do init

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addBoundsheet(Boundsheet bound, String origSheetName, String newSheetName, String origWorkBookName, boolean SSTPopulatedBoundsheet)` add a deserialized boundsheet to this workbook.
`void`	`addBoundsheet(byte[] inbytes, String origSheetName, String NewSheetName, String origWorkBookName, boolean SSTPopulatedBoundsheet)` Inserts a serialized boundsheet into the workboook.
`Chart`	`addChart(Chart destChart, String NewChartName, Boundsheet boundsht)` Inserts a serialized boundsheet chart into the workboook
`void`	`addChartUpdateMsodg(MSODrawing mso, Boundsheet sht)` updates Mso (MSODrawingGroup + Msodrawing) records upon add/copy worksheet and add/copy charts NOTE: this code is mainly garnered via trial and error, works
`void`	`addDefaultExternsheet()` For workbooks that do not contain an externsheet this creates the externsheet record with one 0000 record and the related Supbook rec
`int`	`addExternalName(String n)` Store an external name
`void`	`addExternsheet()` Inserts an externsheet into the recvec, provided one does not yet exist.
`int`	`addFont(Font f)` add a Font object to the collection of Fonts
`int`	`addFormat(Format format)` Adds an existing format record to the list of known formats.
`void`	`addFormula(Formula rec)` add formula to book and init the ptgs
`void`	`addIndirectFormula(Formula f)`
`void`	`addLocalName(Name name)` Add a sheet-scoped name record to the boundsheet Note this is not that primary repository for names, it just contains the name records that are bound to this book, adding them here will not add them to the workbook;
`int`	`addName(Name n)` add a Name object to the collection of names
`void`	`addNameUpdateSheetRefs(Name n, String origWorkBookName)`
`void`	`addOOXMLObject(Object o)` adds the object-specific signature of the external or auxillary OOXML object Object should be of String[] form, key, path, local path + filename [, rid, [extra info], [embedded information]] e.g.
`void`	`addPivotCache(String ref, WorkBookHandle wbh, int sId)` adds the Pivot Cache Directory Storage +Stream records necessary to define the pivot cache (==pivot table data) for pivot table(s) NOTE: at this time only 1 pivot cache is supported
`int`	`addPivotStream(String ref, String sheetName, int sid)` NOT 100% IMPLEMENTE YET creates the initial records for a Pivot Cache A Pivot Cache identifies the data used in a Pivot Table NOTE: only SHEET cache sources are supported at this time
`protected void`	`addPivotTable(Sxview sx)`
`void`	`addPreChart()` JM - Add the requisite records in the book streamer for the chart.
`BiffRec`	`addRecord(BiffRec rec, boolean addtorec)` Associate a record with its containers and related records.
`void`	`associateDereferencedNames(Name name)` Re-assocates ptgrefs that are pointing to a name that has been deleted then is recreated
`void`	`changeWorkSheetOrder(Boundsheet bs, int idx)` change the tab order of a boundsheet
`void`	`close()` clear out object references in prep for closing workbook
`protected void`	`closeRecords()`
`void`	`closeSheets()` clear out ALL sheet object refs
`void`	`copyChartToSheet(String chartname, String sheetname)` Copies an existing Chart to another WorkSheet
`void`	`copyWorkSheet(String SourceSheetName, String NewSheetName)` Copies a complete boundsheet within the workbook If a name exists that refers directly to this sheet then duplicate it, otherwise workbook scoped names are not copied
`protected ByteStreamer`	`createByteStreamer()`
`MSODrawingGroup`	`createMSODrawingGroup()` For workbooks that do not contain an MSODrawing group create a new one, if the drawing group already exists return the existing
`boolean`	`defaultLanguageIsDBCS()` returns true if the default language selected in Excel is one of the DBCS (Double-Byte Code Set) languages The languages that support DBCS include Japanese, Chinese (Simplified), Chinese (Traditional), and Korean
`void`	`deleteChart(String chartname, Boundsheet sheet)` remove an existing chart from the workbook NOTE: STILL EXPERIMENTAL TESTS OK IN BASIC CIRCUMSTANCES BUT MUST BE TESTED FURTHER
`Sxview[]`	`getAllPivotTableViews()` return all pivot table views (==Sxview records) SxView is the top-level record of a Pivot Table as distinct from the PivotCache (stored data source in a LEOFile Storage) and PivotTable Stream (SxStream top-level record)
`String[]`	`getAllStrings()` Returns all strings that are in the SharedStringTable for this workbook.
`int`	`getCalcId()`
`int`	`getCalcMode()` Sets the calculation mode for the workbook.
`BiffRec`	`getCell(String cellname)` get the cell by the following String Pattern BiffRec c = getCell("SheetName!C17");
`BiffRec`	`getCell(String sheetname, String cellname)` get the cell by the following String Pattern BiffRec c = getCell("Sheet1", "C17");
`BiffRec[]`	`getCells()` get all of the Cells in this WorkBook
`Chart`	`getChart(String chartname)` Returns a Chart Handle
`Chart[]`	`getCharts()`
`AbstractList`	`getChartVect()`
`String`	`getCodename()` returns the workbook codename used by vba macros OOXML-specific
`Color[]`	`getColorTable()`
`ContinueHandler`	`getContinueHandler()` get a handle to the ContinueHandler
`DateConverter.DateFormat`	`getDateFormat()` Gets the date format used by this book.
`int`	`getDefaultIxfe()`
`ArrayList`	`getDxfs()` returns the list of dxf's (incremental style info) (int) OOXML-specific
`int`	`getExtenalNameNumber(String s)` apparently this method adds an External name rec and returns the ilbl Correct structure is Supbook Externname Supbook Externsheet
`String`	`getExternalName(int t)` Get the external name at the specified index.
`String[]`	`getExternalNames()` Get a string array of external names
`Supbook`	`getExternalSupbook(String externalWorkbook, boolean bCreate)` return the External Supbook record associated with the desired externalWorkbook will create if bCreate
`Externsheet`	`getExternSheet()` get the Externsheet
`Externsheet`	`getExternSheet(boolean create)` return the Externsheet for this book
`WorkBookFactory`	`getFactory()` get a handle to the factory
`String`	`getFileName()`
`int`	`getFirstSheet()` returns the first non-hidden sheet (int) in the workbook OOXML-specific Mar 15, 2010
`Font`	`getFont(int t)` Get the font at the specified index.
`int`	`getFontIdx(Font f)` Get's the index for this particular front.
`AbstractList`	`getFontRecs()` Return the font records
`Map`	`getFontRecsAsXML()` Returns a map of xml strings representing the XF's in this workbook/Integer of lookup.
`Format`	`getFormat(int id)` Gets a custom number format by its format ID.
`HashMap`	`getFormatCache()` retrieve the format cache - links string vers.
`short`	`getFormatId(String pattern)` Gets the format ID for a given number format pattern.
`Formula`	`getFormula(String cellAddress)`
`List`	`getFormulaList()` returns the List of Formulas in the book
`Formula[]`	`getFormulas()` returns the array of Formulas in the book
`AbstractList`	`getHlinklookup()`
`boolean`	`getIsExcel2007()` returns truth of "Excel 2007" format
`Boundsheet`	`getLastbound()`
`int`	`getMatchingFontIndex(Font f)` Get's the index for this font, based on matching through xml strings.
`AbstractList`	`getMergecelllookup()`
`MSODrawingGroup`	`getMSODrawingGroup()` Get the MsoDrawingGroup for this workbook
`Name`	`getName(int t)` returns a Named range by number
`Name`	`getName(String nameRef)` returns a named range by name string This method will first attempt to look in the book names, then the sheet names, obviously different scoped names can have the same identifying name, so this could return one of multiple names if this is the case
`int`	`getNameNumber(String nameStr)` Returns the ilbl of the name record associated with the string passed in.
`Name[]`	`getNames()` Get a collection of all names in the workbook
`int`	`getNPivotTableViews()`
`int`	`getNumCells()` get the number of Cells in this WorkBook
`int`	`getNumFonts()`
`int`	`getNumFormats()` Gets the number of custom number formats registered on this book.
`int`	`getNumFormulas()` get the number of formulas in this WorkBook
`int`	`getNumWorkSheets()` Get the number of worksheets in this WorkBook
`int`	`getNumXfs()`
`List`	`getOOXMLObjects()` returns the list of OOXML objects which are external or auxillary to the main workbook e.g.
`PivotCache`	`getPivotCache()` return the pivot cache, if any
`SxStreamID`	`getPivotStream(int cacheid)` returns the start of the stream defining the desired pivot cache
`Sxview`	`getPivotTableView(String nm)`
`BookProtectionManager`	`getProtectionManager()` Gets this sheet's SheetProtectionManager.
`int`	`getRecalculationMode()` Returns the recalculation mode for the Workbook: 0= Manual 1= Automatic 2= Automatic except for multiple table operations
`ReferenceTracker`	`getRefTracker()`
`Name`	`getScopedName(String nameRef)` returns a scoped named range by name string
`int`	`getSelectedSheetNum()` sets the selected worksheet
`Sst`	`getSharedStringTable()`
`Boundsheet`	`getSheetFromRec(BiffRec rec, Long lbplypos)` Dec 15, 2010
`AbstractList`	`getSheetVect()` returns the Vector of Boundsheets
`String`	`getStats()` Return some useful statistics about the WorkBook
`String`	`getStats(boolean usehtml)` Return some useful statistics about the WorkBook
`ByteStreamer`	`getStreamer()` Get a substream by name.
`int`	`getSupbookIndex(Supbook sb)` return the index into the Supbook records for this supbook
`Supbook[]`	`getSupBooks()`
`TabID`	`getTabID()`
`Theme`	`getTheme()` return the OOXML theme for this workbook, if any
`Usersviewbegin`	`getUsersviewbegin()` get a handle to the Usersviewbegin for the workbook
`Name[]`	`getWorkbookScopedNames()` Get a collection of all names in the workbook
`Boundsheet`	`getWorkSheetByHash(String s)` returns the Boundsheet with the specific Hashname
`Boundsheet`	`getWorkSheetByName(String bstr)` returns the Boundsheet with the specific name
`Boundsheet`	`getWorkSheetByNumber(int i)` returns the Boundsheet at the specific index
`Xf`	`getXf(int i)` return the XF record at the specified index
`AbstractList`	`getXfrecs()`
`Map`	`getXfrecsAsString()` Returns a map of xml strings representing the XF's in this workbook/Integer of lookup.
`String`	`getXLSVersionString()`
`void`	`initializeIndirectFormulas()` Initialize the indirect functions in this workbook by calculating the formulas
`void`	`initializeNames()` Init names at Post-load
`int`	`insertFont(Font x)` InsertFont inserts a Font record into the workbook level stream, For some reason, the addFont only puts it into an array that is never accessed on output.
`int`	`insertFormat(Format format)` Inserts a newly created Format record into the workbook.
`void`	`insertName(Name n)` Inserts a newly created Name record into the correct location in the streamer.
`boolean`	`is1904()` Deprecated. Use `getDateFormat()` instead.
`boolean`	`isSharedupes()`
`void`	`mergeMSODrawingRecords()`
`void`	`prestream()` take care of any lazy updating before output
`protected void`	`reflectiveClone(WorkBook source)`
`void`	`removeChart(String chartname)` removes the desired chart from the list of charts
`void`	`removeFormula(Formula fmla)` remove a formula from the book
`void`	`removeLocalName(Name name)` Remove a sheet-scoped name record from the boundsheet.
`boolean`	`removeName(Name n)`
`void`	`removeWorkSheet(Boundsheet sheet)` remove a Boundsheet from the WorkBook
`void`	`removeXfRecs()` internally used in preparation for reading an 2007 and above workbook
`void`	`setCalcId(int i)`
`void`	`setCalcMode(int mode)` Sets the OpenXLS calculation mode for the workbook.
`void`	`setCodename(String s)` sets the workbook codename used by vba macros OOXML-specific
`void`	`setColorTable(Color[] clrtable)`
`void`	`setDebugLevel(int i)` set the Debug level
`void`	`setDefaultColWidth(int t)` set Default col width for all worksheets in the workbook, Default column width can also be set on individual worksheets
`void`	`setDefaultIxfe(int defaultIxfe)`
`void`	`setDefaultRowHeight(int t)` set Default row height in twips (1/20 of a point)
`void`	`setDupeStringMode(int mode)`
`void`	`setDxfs(ArrayList dxfs)` sets the list of dxf's (incremental style info) (int) OOXML-specific
`void`	`setFactory(WorkBookFactory r)` get a handle to the Reader for this WorkBook.
`void`	`setFirstBof(Bof b)` get a handle to the first BOF to perform offset functions which don't know where the start of the file is due to the compound file format.
`void`	`setFirstSheet(int f)` sets the first sheet (int) in the workbook OOXML-specific naive implementaiton does not account for hidden sheets Mar 15, 2010
`void`	`setFirstVisibleSheet(Boundsheet bs2)` set the first visible tab
`void`	`setIsExcel2007(boolean b)` set truth of "Is Excel 2007" true increases maximums of base storage, etc.
`void`	`setLastbound(Boundsheet lastbound)`
`protected void`	`setLastFormula(Formula f)` for those cases where a formula calculation adds a new string rec need to explicitly set lastFormula before calling addRecord
`void`	`setMSODrawingGroup(MSODrawingGroup msodg)` Set the msodrawinggroup for this workbook
`void`	`setNewName(String oldname, String newname)` rename the NamedRange in the lookup map
`void`	`setPivotCache(PivotCache pc)` set the pivot cache pointer
`void`	`setRecalcuationMode(int mode)` Sets the recalculation mode for the Workbook: 0= Manual 1= Automatic 2= Automatic except for multiple table operations
`void`	`setSelectedSheet(Boundsheet bs)` sets the selected worksheet
`void`	`setSharedupes(boolean sharedupes)`
`void`	`setShowSheetTabs(boolean show)` Sets whether the sheet selection tabs should be shown.
`void`	`setStringEncodingMode(int mode)`
`void`	`setSubStream(ByteStreamer s)`
`void`	`setTheme(Theme t)` sets the OOXML theme for this 2007 verison workbook
`boolean`	`showSheetTabs()` Returns whether the sheet selection tabs should be shown.
`int`	`stream(OutputStream _out)` Write the contents of the WorkBook bytes to an OutputStream
`String`	`toString()`
`void`	`updateFormatCache(Xf xf)` formatCache: links tostring of xf to xf rec for updating/reuse purposes
`void`	`updateMsodrawingHeaderRec(Boundsheet bs)` after changing the MSODrawings on a sheet, this is called to update the header Msodrawing rec.
`void`	`updateNameIlbls()` After any changes in the name records this method needs to be called in order to update ilbl records

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

- Field Detail
  - STRING_ENCODING_AUTO
```
public static int STRING_ENCODING_AUTO
```
  - STRING_ENCODING_UNICODE
```
public static int STRING_ENCODING_UNICODE
```
  - STRING_ENCODING_COMPRESSED
```
public static int STRING_ENCODING_COMPRESSED
```
  - ALLOWDUPES
```
public static int ALLOWDUPES
```
  - SHAREDUPES
```
public static int SHAREDUPES
```
  - colorTable
```
public Color[] colorTable
```
  - CONVERTMULBLANKS
```
public static String CONVERTMULBLANKS
```
  - formatCache
```
public HashMap formatCache
```
  - msodgMerge
```
public AbstractList msodgMerge
```
  - msodg
```
public MSODrawingGroup msodg
```
  - lastSPID
```
public int lastSPID
```
- Constructor Detail
  - WorkBook
```
public WorkBook()
```
    default constructor -- do init
- Method Detail
  - reflectiveClone
```
protected void reflectiveClone(WorkBook source)
```
  - createByteStreamer
```
protected ByteStreamer createByteStreamer()
```
  - getProtectionManager
```
public BookProtectionManager getProtectionManager()
```
    Gets this sheet's SheetProtectionManager.
  - mergeMSODrawingRecords
```
public void mergeMSODrawingRecords()
```
  - updateMsodrawingHeaderRec
```
public void updateMsodrawingHeaderRec(Boundsheet bs)
```
    after changing the MSODrawings on a sheet, this is called to update the header Msodrawing rec.
    must sum up all other mso's on the particular sheet SPCONTAINERLEN and update the sheet mso header ...
    this calculation is quite experimental, so far it's working in all known cases ...
    
    Parameters:
    
    bs -
  - getMSODrawingGroup
```
public MSODrawingGroup getMSODrawingGroup()
```
    Get the MsoDrawingGroup for this workbook
    
    Returns:
    
    msodrawinggroup
  - setMSODrawingGroup
```
public void setMSODrawingGroup(MSODrawingGroup msodg)
```
    Set the msodrawinggroup for this workbook
    
    Parameters:
    
    msodg -
  - createMSODrawingGroup
```
public MSODrawingGroup createMSODrawingGroup()
```
    For workbooks that do not contain an MSODrawing group create a new one, if the drawing group already exists return the existing
    
    Returns:
  - getStats
```
public String getStats()
```
    Return some useful statistics about the WorkBook
    
    Returns:
  - getStats
```
public String getStats(boolean usehtml)
```
    Return some useful statistics about the WorkBook
    
    Returns:
  - getXLSVersionString
```
public String getXLSVersionString()
```
  - prestream
```
public void prestream()
```
    take care of any lazy updating before output
  - getCharts
```
public Chart[] getCharts()
```
  - getSupBooks
```
public Supbook[] getSupBooks()
```
  - getOOXMLObjects
```
public List getOOXMLObjects()
```
    returns the list of OOXML objects which are external or auxillary to the main workbook e.g. theme, doc properties
    
    Returns:
  - addOOXMLObject
```
public void addOOXMLObject(Object o)
```
    adds the object-specific signature of the external or auxillary OOXML object Object should be of String[] form, key, path, local path + filename [, rid, [extra info], [embedded information]] e.g. theme, doc properties
    
    Parameters:
    
    o -
  - getTheme
```
public Theme getTheme()
```
    return the OOXML theme for this workbook, if any
    
    Returns:
  - setTheme
```
public void setTheme(Theme t)
```
    sets the OOXML theme for this 2007 verison workbook
    
    Parameters:
    
    t -
  - getExternalSupbook
```
public Supbook getExternalSupbook(String externalWorkbook,
                                  boolean bCreate)
```
    return the External Supbook record associated with the desired externalWorkbook will create if bCreate
    
    Parameters:
    
    externalWorkbook - String URL (name) of External Workbook
    
    bCreate - if true, will create an external SUPBOOK record for the externalWorkbook
    
    Returns:
    
    Supbook
  - getSupbookIndex
```
public int getSupbookIndex(Supbook sb)
```
    return the index into the Supbook records for this supbook
    
    Parameters:
    
    sb -
    
    Returns:
    
    int
  - getChartVect
```
public AbstractList getChartVect()
```
  - getPivotTableView
```
public Sxview getPivotTableView(String nm)
```
  - addPivotTable
```
protected void addPivotTable(Sxview sx)
```
  - getAllPivotTableViews
```
public Sxview[] getAllPivotTableViews()
```
    return all pivot table views (==Sxview records)
    SxView is the top-level record of a Pivot Table as distinct from the PivotCache (stored data source in a LEOFile Storage) and PivotTable Stream (SxStream top-level record)
    
    Returns:
  - getNPivotTableViews
```
public int getNPivotTableViews()
```
  - getExternSheet
```
public Externsheet getExternSheet(boolean create)
```
    return the Externsheet for this book
    
    Parameters:
    
    create - a new Externsheet if it does not exist
    
    Returns:
    
    the Externsheet
  - getExternSheet
```
public Externsheet getExternSheet()
```
    get the Externsheet
  - getFormatId
```
public short getFormatId(String pattern)
```
    Gets the format ID for a given number format pattern. This lookup is completely case-insensitive. For most patterns this correctly reflects the case-insensitivity of the tokens. Custom patterns containing string literals could be matched incorrectly.
    
    Parameters:
    
    pattern - the number format pattern to look up
    
    Returns:
    
    the format ID of the given pattern or -1 if it's not recognized
  - initializeNames
```
public void initializeNames()
```
    Init names at Post-load
  - addName
```
public int addName(Name n)
```
    add a Name object to the collection of names
  - addNameUpdateSheetRefs
```
public void addNameUpdateSheetRefs(Name n,
                                   String origWorkBookName)
```
  - addExternalName
```
public int addExternalName(String n)
```
    Store an external name
    
    Parameters:
    
    n - = String describing the name
    
    Returns:
    
    int location of the name
  - getExternalNames
```
public String[] getExternalNames()
```
    Get a string array of external names
    
    Returns:
    
    externalNames
  - getExternalName
```
public String getExternalName(int t)
```
    Get the external name at the specified index.
    
    Parameters:
    
    t - index of the name
    
    Returns:
    
    name at the index, empty string if it doesn't exist. Why are we calling getExternalName one based, then removing for ordinal, internal processes should always be 0,1,2,3... -NR 1/06
  - addDefaultExternsheet
```
public void addDefaultExternsheet()
```
    For workbooks that do not contain an externsheet this creates the externsheet record with one 0000 record and the related Supbook rec
  - getExtenalNameNumber
```
public int getExtenalNameNumber(String s)
```
    apparently this method adds an External name rec and returns the ilbl Correct structure is Supbook Externname Supbook Externsheet
    
    Parameters:
    
    s -
    
    Returns:
    
    See Also:
    
    PtgNameX
  - getNames
```
public Name[] getNames()
```
    Get a collection of all names in the workbook
  - getWorkbookScopedNames
```
public Name[] getWorkbookScopedNames()
```
    Get a collection of all names in the workbook
  - getFormulaList
```
public List getFormulaList()
```
    returns the List of Formulas in the book
    
    Returns:
  - getFormulas
```
public Formula[] getFormulas()
```
    returns the array of Formulas in the book
    
    Returns:
  - removeFormula
```
public void removeFormula(Formula fmla)
```
    remove a formula from the book
    
    Parameters:
    
    fmla -
  - getRecalculationMode
```
public int getRecalculationMode()
```
    Returns the recalculation mode for the Workbook:
    0= Manual
    1= Automatic
    2= Automatic except for multiple table operations
    
    Returns:
    
    int
  - setRecalcuationMode
```
public void setRecalcuationMode(int mode)
```
    Sets the recalculation mode for the Workbook:
    0= Manual
    1= Automatic
    2= Automatic except for multiple table operations
  - getName
```
public Name getName(int t)
```
    returns a Named range by number
    
    Parameters:
    
    t -
    
    Returns:
  - setNewName
```
public void setNewName(String oldname,
                       String newname)
```
    rename the NamedRange in the lookup map
    
    Parameters:
    
    t -
  - associateDereferencedNames
```
public void associateDereferencedNames(Name name)
```
    Re-assocates ptgrefs that are pointing to a name that has been deleted then is recreated
    
    Parameters:
    
    name -
  - getName
```
public Name getName(String nameRef)
```
    returns a named range by name string This method will first attempt to look in the book names, then the sheet names, obviously different scoped names can have the same identifying name, so this could return one of multiple names if this is the case
    
    Parameters:
    
    t -
    
    Returns:
  - getScopedName
```
public Name getScopedName(String nameRef)
```
    returns a scoped named range by name string
    
    Parameters:
    
    t -
    
    Returns:
  - getNameNumber
```
public int getNameNumber(String nameStr)
```
    Returns the ilbl of the name record associated with the string passed in. If the name does not exist, it get's created without a location reference. This is needed to support formula creation with non-existent names referenced.
    
    Parameters:
    
    t, - the name record to search for
    
    Returns:
    
    the index of the name
  - getFontIdx
```
public int getFontIdx(Font f)
```
    Get's the index for this particular front. NOTE: this doesn't actually get a "matching" font, it has to be the exact font. 20070826 KSC: changed to match font characterstics, not just return exact matching font
  - getMatchingFontIndex
```
public int getMatchingFontIndex(Font f)
```
    Get's the index for this font, based on matching through xml strings. If the font doesn't exist in the book it returns -1;
    
    Returns:
    
    KSC: is this method necessary now with above getFontIdx changes?
  - insertFont
```
public int insertFont(Font x)
```
    InsertFont inserts a Font record into the workbook level stream, For some reason, the addFont only puts it into an array that is never accessed on output. This may have a reason, so I am not overwriting it currently, but let's check it out?
  - addFont
```
public int addFont(Font f)
```
    add a Font object to the collection of Fonts
  - getNumFonts
```
public int getNumFonts()
```
  - getFont
```
public Font getFont(int t)
```
    Get the font at the specified index. Note that the number 4 does not exist, so index correctly based of that. So, if you call getFont(5), you are really doing getFont(4) from the internal array
    
    Parameters:
    
    t -
    
    Returns:
  - insertFormat
```
public int insertFormat(Format format)
```
    Inserts a newly created Format record into the workbook. This method handles assigning the format ID and adding the record to the workbook. If the record is already part of the workbook use addFormat(io.starter.formats.XLS.Format) instead.
  - getFormula
```
public Formula getFormula(String cellAddress)
                   throws FormulaNotFoundException
```
    Throws:
    
    FormulaNotFoundException
  - addFormat
```
public int addFormat(Format format)
```
    Adds an existing format record to the list of known formats. This method does not add the record to the workbook! If the format is not already in the workbook use insertFormat(io.starter.formats.XLS.Format) instead.
    
    Parameters:
    
    format - the Format record to add
  - getNumFormats
```
public int getNumFormats()
```
    Gets the number of custom number formats registered on this book.
  - getFormat
```
public Format getFormat(int id)
```
    Gets a custom number format by its format ID.
  - getTabID
```
public TabID getTabID()
```
  - setDefaultRowHeight
```
public void setDefaultRowHeight(int t)
```
    set Default row height in twips (1/20 of a point)
  - setDefaultColWidth
```
public void setDefaultColWidth(int t)
```
    set Default col width for all worksheets in the workbook, Default column width can also be set on individual worksheets
  - getSelectedSheetNum
```
public int getSelectedSheetNum()
```
    sets the selected worksheet
  - setSelectedSheet
```
public void setSelectedSheet(Boundsheet bs)
```
    sets the selected worksheet
  - setLastFormula
```
protected void setLastFormula(Formula f)
```
    for those cases where a formula calculation adds a new string rec need to explicitly set lastFormula before calling addRecord
    
    Parameters:
    
    f -
  - addRecord
```
public BiffRec addRecord(BiffRec rec,
                         boolean addtorec)
```
    Associate a record with its containers and related records.
    
    Specified by:
    
    addRecord in interface Book
  - getSheetFromRec
```
public Boundsheet getSheetFromRec(BiffRec rec,
                                  Long lbplypos)
```
    Dec 15, 2010
    
    Specified by:
    
    getSheetFromRec in interface Book
    
    Parameters:
    
    rec -
    
    Returns:
  - getContinueHandler
```
public ContinueHandler getContinueHandler()
```
    get a handle to the ContinueHandler
    
    Specified by:
    
    getContinueHandler in interface Book
  - getUsersviewbegin
```
public Usersviewbegin getUsersviewbegin()
```
    get a handle to the Usersviewbegin for the workbook
  - setDebugLevel
```
public void setDebugLevel(int i)
```
    set the Debug level
    
    Specified by:
    
    setDebugLevel in interface Book
  - setFactory
```
public void setFactory(WorkBookFactory r)
```
    get a handle to the Reader for this WorkBook.
    
    Specified by:
    
    setFactory in interface Book
  - getNumWorkSheets
```
public int getNumWorkSheets()
```
    Get the number of worksheets in this WorkBook
  - getNumFormulas
```
public int getNumFormulas()
```
    get the number of formulas in this WorkBook
    
    Returns:
  - getNumCells
```
public int getNumCells()
```
    get the number of Cells in this WorkBook
  - getCells
```
public BiffRec[] getCells()
```
    get all of the Cells in this WorkBook
  - getCell
```
public BiffRec getCell(String cellname)
                throws CellNotFoundException,
                       WorkSheetNotFoundException
```
    get the cell by the following String Pattern BiffRec c = getCell("SheetName!C17");
    
    Throws:
    
    CellNotFoundException
    
    WorkSheetNotFoundException
  - getCell
```
public BiffRec getCell(String sheetname,
                       String cellname)
                throws CellNotFoundException,
                       WorkSheetNotFoundException
```
    get the cell by the following String Pattern BiffRec c = getCell("Sheet1", "C17");
    
    Throws:
    
    CellNotFoundException
    
    WorkSheetNotFoundException
  - removeName
```
public boolean removeName(Name n)
```
    Parameters:
    
    n -
    
    Returns:
  - addLocalName
```
public void addLocalName(Name name)
```
    Add a sheet-scoped name record to the boundsheet Note this is not that primary repository for names, it just contains the name records that are bound to this book, adding them here will not add them to the workbook;
    
    Parameters:
    
    bookNameRecs -
  - removeLocalName
```
public void removeLocalName(Name name)
```
    Remove a sheet-scoped name record from the boundsheet. Note this is not that primary repository for names, it just contains the name records that are bound to this book, removing them here will not remove them completely from the workbook. In order to do that you will need to call book.removeName
    
    Parameters:
    
    bookNameRecs -
  - updateNameIlbls
```
public void updateNameIlbls()
```
    After any changes in the name records this method needs to be called in order to update ilbl records
  - removeWorkSheet
```
public void removeWorkSheet(Boundsheet sheet)
```
    remove a Boundsheet from the WorkBook
  - getWorkSheetByName
```
public Boundsheet getWorkSheetByName(String bstr)
                              throws WorkSheetNotFoundException
```
    returns the Boundsheet with the specific name
    
    Parameters:
    
    String - name of Boundsheet
    
    Throws:
    
    WorkSheetNotFoundException
  - getWorkSheetByHash
```
public Boundsheet getWorkSheetByHash(String s)
                              throws WorkSheetNotFoundException
```
    returns the Boundsheet with the specific Hashname
    
    Parameters:
    
    String - hashname of Boundsheet
    
    Throws:
    
    WorkSheetNotFoundException
  - getWorkSheetByNumber
```
public Boundsheet getWorkSheetByNumber(int i)
                                throws WorkSheetNotFoundException
```
    returns the Boundsheet at the specific index
    
    Parameters:
    
    int - index of Boundsheet
    
    Throws:
    
    WorkSheetNotFoundException
  - getSharedStringTable
```
public Sst getSharedStringTable()
```
  - getSheetVect
```
public AbstractList getSheetVect()
```
    returns the Vector of Boundsheets
  - setFirstBof
```
public void setFirstBof(Bof b)
```
    get a handle to the first BOF to perform offset functions which don't know where the start of the file is due to the compound file format. Referred to in Boundsheet as the 'lbPlyPos', this is the position of the BOF for the Boundsheet relative to the *first* BOF in the file (the firstBOF of the WorkBook)
    
    Specified by:
    
    setFirstBof in interface Book
    
    See Also:
    
    Boundsheet
  - toString
```
public String toString()
```
    Specified by:
    
    toString in interface Book
    
    Overrides:
    
    toString in class Object
  - getFileName
```
public String getFileName()
```
    Specified by:
    
    getFileName in interface Book
  - showSheetTabs
```
public boolean showSheetTabs()
```
    Returns whether the sheet selection tabs should be shown.
  - setShowSheetTabs
```
public void setShowSheetTabs(boolean show)
```
    Sets whether the sheet selection tabs should be shown.
  - setFirstVisibleSheet
```
public void setFirstVisibleSheet(Boundsheet bs2)
```
    set the first visible tab
  - getXf
```
public Xf getXf(int i)
```
    return the XF record at the specified index
  - getNumXfs
```
public int getNumXfs()
```
  - removeXfRecs
```
public void removeXfRecs()
```
    internally used in preparation for reading an 2007 and above workbook
  - updateFormatCache
```
public void updateFormatCache(Xf xf)
```
    formatCache: links tostring of xf to xf rec for updating/reuse purposes
    
    Parameters:
    
    xf -
    
    See Also:
    
    FormatHandle.updateXf, WorkBook.addXf
  - getFormatCache
```
public HashMap getFormatCache()
```
    retrieve the format cache - links string vers. of xf to xf rec used for resusing xf's
    
    Returns:
    
    See Also:
    
    FormatHandle.updateXf
  - getStreamer
```
public ByteStreamer getStreamer()
```
    Get a substream by name.
    
    Specified by:
    
    getStreamer in interface Book
  - setSubStream
```
public void setSubStream(ByteStreamer s)
```
  - stream
```
public int stream(OutputStream _out)
```
    Write the contents of the WorkBook bytes to an OutputStream
    
    Specified by:
    
    stream in interface Book
    
    Parameters:
    
    _out -
    
    Returns:
  - getFactory
```
public WorkBookFactory getFactory()
```
    get a handle to the factory
    
    Specified by:
    
    getFactory in interface Book
  - copyWorkSheet
```
public void copyWorkSheet(String SourceSheetName,
                          String NewSheetName)
                   throws Exception
```
    Copies a complete boundsheet within the workbook If a name exists that refers directly to this sheet then duplicate it, otherwise workbook scoped names are not copied
    
    Throws:
    
    Exception
  - insertName
```
public void insertName(Name n)
```
    Inserts a newly created Name record into the correct location in the streamer.
    
    Parameters:
    
    n -
  - copyChartToSheet
```
public void copyChartToSheet(String chartname,
                             String sheetname)
                      throws ChartNotFoundException,
                             WorkSheetNotFoundException
```
    Copies an existing Chart to another WorkSheet
    
    Parameters:
    
    chartname -
    
    sheetname -
    
    Throws:
    
    ChartNotFoundException
    
    WorkSheetNotFoundException
  - addChart
```
public Chart addChart(Chart destChart,
                      String NewChartName,
                      Boundsheet boundsht)
```
    Inserts a serialized boundsheet chart into the workboook
  - addChartUpdateMsodg
```
public void addChartUpdateMsodg(MSODrawing mso,
                                Boundsheet sht)
```
    updates Mso (MSODrawingGroup + Msodrawing) records upon add/copy worksheet and add/copy charts NOTE: this code is mainly garnered via trial and error, works
    
    Parameters:
    
    mso - Msodrawing record that is being added or copied
    
    sht - Boundsheet
  - addPreChart
```
public void addPreChart()
```
    JM - Add the requisite records in the book streamer for the chart. \ Supbook, externsheet & msodrawinggroup I think this is due to the fact that the referenced series are usually stored in the fashon 'Sheet1!A4:B6' The sheet1 reference requires a supbook, though the reference is internal.
  - deleteChart
```
public void deleteChart(String chartname,
                        Boundsheet sheet)
                 throws ChartNotFoundException
```
    remove an existing chart from the workbook NOTE: STILL EXPERIMENTAL TESTS OK IN BASIC CIRCUMSTANCES BUT MUST BE TESTED FURTHER
    
    Throws:
    
    ChartNotFoundException
  - addBoundsheet
```
public void addBoundsheet(byte[] inbytes,
                          String origSheetName,
                          String NewSheetName,
                          String origWorkBookName,
                          boolean SSTPopulatedBoundsheet)
                   throws IOException,
                          ClassNotFoundException
```
    Inserts a serialized boundsheet into the workboook.
    
    Parameters:
    
    inbytes - original sheet bytes
    
    NewSheetName - new Sheet Name
    
    origWorkBookName - original WorkBook Name (nec. for resolving possible external references) *
    
    Throws:
    
    ClassNotFoundException
    
    IOException
  - changeWorkSheetOrder
```
public void changeWorkSheetOrder(Boundsheet bs,
                                 int idx)
```
    change the tab order of a boundsheet
  - addBoundsheet
```
public void addBoundsheet(Boundsheet bound,
                          String origSheetName,
                          String newSheetName,
                          String origWorkBookName,
                          boolean SSTPopulatedBoundsheet)
```
    add a deserialized boundsheet to this workbook.
    
    Parameters:
    
    bound - new (copied) sheet
    
    newSheetName - new sheetname
    
    origWorkBookName - original WorkBook Name (nec. for resolving possible external references) *
  - setStringEncodingMode
```
public void setStringEncodingMode(int mode)
```
  - setDupeStringMode
```
public void setDupeStringMode(int mode)
```
  - getChart
```
public Chart getChart(String chartname)
               throws ChartNotFoundException
```
    Returns a Chart Handle
    
    Returns:
    
    ChartHandle a Chart in the WorkBook
    
    Throws:
    
    ChartNotFoundException
  - removeChart
```
public void removeChart(String chartname)
                 throws ChartNotFoundException
```
    removes the desired chart from the list of charts
    
    Parameters:
    
    chartname -
    
    Throws:
    
    ChartNotFoundException
  - addPivotStream
```
public int addPivotStream(String ref,
                          String sheetName,
                          int sid)
```
    NOT 100% IMPLEMENTE YET creates the initial records for a Pivot Cache
    A Pivot Cache identifies the data used in a Pivot Table
    NOTE: only SHEET cache sources are supported at this time
    
    Parameters:
    
    ref - String reference: either reference or named range
    
    sheetName - String sheetname
    
    cacheid - if > 0, the desired cacheid (useful only in OOXML parsing)
    
    Returns:
    
    int cacheid
  - addPivotCache
```
public void addPivotCache(String ref,
                          WorkBookHandle wbh,
                          int sId)
```
    adds the Pivot Cache Directory Storage +Stream records necessary to define the pivot cache (==pivot table data) for pivot table(s)
    NOTE: at this time only 1 pivot cache is supported
    
    Parameters:
    
    ref - Cell Range which identifies pivot table data range
    
    wbh -
    
    sId - Stream or cachid Id -- links back to SxStream set of records
  - getPivotStream
```
public SxStreamID getPivotStream(int cacheid)
```
    returns the start of the stream defining the desired pivot cache
    
    Parameters:
    
    cacheid -
    
    Returns:
  - getHlinklookup
```
public AbstractList getHlinklookup()
```
    Returns:
  - getMergecelllookup
```
public AbstractList getMergecelllookup()
```
    Returns:
  - addIndirectFormula
```
public void addIndirectFormula(Formula f)
```
  - initializeIndirectFormulas
```
public void initializeIndirectFormulas()
```
    Initialize the indirect functions in this workbook by calculating the formulas
  - addExternsheet
```
public void addExternsheet()
```
    Inserts an externsheet into the recvec, provided one does not yet exist. also calls add supBook
  - setCalcMode
```
public void setCalcMode(int mode)
```
    Sets the OpenXLS calculation mode for the workbook.
    
    Parameters:
    
    CalcMode -
    
    See Also:
    
    WorkBookHandle.setFormulaCalculationMode()
  - getCalcMode
```
public int getCalcMode()
```
    Sets the calculation mode for the workbook.
    
    Parameters:
    
    CalcMode -
    
    See Also:
    
    WorkBookHandle.setFormulaCalculationMode()
  - getXfrecs
```
public AbstractList getXfrecs()
```
    Returns:
    
    Returns the xfrecs.
  - getFontRecs
```
public AbstractList getFontRecs()
```
    Return the font records
  - getXfrecsAsString
```
public Map getXfrecsAsString()
```
    Returns a map of xml strings representing the XF's in this workbook/Integer of lookup. These are used as a comparitor to determine if additional xf's need to be brought in or not and to give the new XF number if the xf exists. Changed 20080226 KSC: to use XF toString as XML is limited in format, toString is more complete
    
    Returns:
    
    map (String XfXml, Integer xfLookup)
  - getFontRecsAsXML
```
public Map getFontRecsAsXML()
```
    Returns a map of xml strings representing the XF's in this workbook/Integer of lookup. These are used as a comparitor to determine if additional xf's need to be brought in or not and to give the new XF number if the xf exists.
    
    Returns:
    
    map (String XfXml, Integer xfLookup)
  - getLastbound
```
public Boundsheet getLastbound()
```
    Returns:
    
    Returns the lastbound.
  - setLastbound
```
public void setLastbound(Boundsheet lastbound)
```
    Parameters:
    
    lastbound - The lastbound to set.
  - addFormula
```
public void addFormula(Formula rec)
```
    add formula to book and init the ptgs
    
    Parameters:
    
    rec -
  - isSharedupes
```
public boolean isSharedupes()
```
  - setSharedupes
```
public void setSharedupes(boolean sharedupes)
```
  - is1904
```
@Deprecated
public boolean is1904()
```
    Deprecated. Use getDateFormat() instead.
    
    Returns whether this book uses the 1904 date format.
  - getDateFormat
```
public DateConverter.DateFormat getDateFormat()
```
    Gets the date format used by this book.
  - getRefTracker
```
public ReferenceTracker getRefTracker()
```
  - setIsExcel2007
```
public void setIsExcel2007(boolean b)
```
    set truth of "Is Excel 2007" true increases maximums of base storage, etc.
    
    Parameters:
    
    b -
  - getIsExcel2007
```
public boolean getIsExcel2007()
```
    returns truth of "Excel 2007" format
  - getCodename
```
public String getCodename()
```
    returns the workbook codename used by vba macros OOXML-specific
  - defaultLanguageIsDBCS
```
public boolean defaultLanguageIsDBCS()
```
    returns true if the default language selected in Excel is one of the DBCS (Double-Byte Code Set) languages
    The languages that support DBCS include
    Japanese, Chinese (Simplified), Chinese (Traditional), and Korean
```
   
        Language        Country code    Countries/regions 
        -------------------------------------------------------------
        
        Arabic                966       (Saudi Arabia)
        Czech                 42        (Czech Republic)
        Danish                45        (Denmark)
        Dutch                 31        (The Netherlands)
        English               1         (The United States of America)
        Farsi                 98        (Iran)
        Finnish               358       (Finland)
        French                33        (France)
        German                49        (Germany)
        Greek                 30        (Greece)
        Hebrew                972       (Israel)
        Hungarian             36        (Hungary)
        Indian                91        (India)
        Italian               39        (Italy)
        Japanese              81        (Japan)
        Korean                82        (Korea)
        Norwegian             47        (Norway)
        Polish                48        (Poland)
        Portuguese (Brazil)   55        (Brazil)
        Portuguese            351       (Portugal)
        Russian               7         (Russian Federation)
        Simplified Chinese    86        (People's Republic of China)
        Spanish               34        (Spain)
        Swedish               46        (Sweden)
        Thai                  66        (Thailand)
        Traditional Chinese   886       (Taiwan)
        Turkish               90        (Turkey)
        Urdu                  92        (Pakistan)
        Vietnamese            84        (Vietnam)   
                
```
    Returns:
    
    boolean
  - setCodename
```
public void setCodename(String s)
```
    sets the workbook codename used by vba macros OOXML-specific
    
    Parameters:
    
    s -
  - setFirstSheet
```
public void setFirstSheet(int f)
```
    sets the first sheet (int) in the workbook OOXML-specific naive implementaiton does not account for hidden sheets Mar 15, 2010
    
    Parameters:
    
    f -
  - getFirstSheet
```
public int getFirstSheet()
```
    returns the first non-hidden sheet (int) in the workbook OOXML-specific Mar 15, 2010
    
    Returns:
  - setDxfs
```
public void setDxfs(ArrayList dxfs)
```
    sets the list of dxf's (incremental style info) (int) OOXML-specific
  - getDxfs
```
public ArrayList getDxfs()
```
    returns the list of dxf's (incremental style info) (int) OOXML-specific
  - getAllStrings
```
public String[] getAllStrings()
```
    Returns all strings that are in the SharedStringTable for this workbook. The SST contains all standard string records in cells, but may not include such things as strings that are contained within formulas. This is useful for such things as full text indexing of workbooks
    
    Returns:
    
    Strings in the workbook.
  - setPivotCache
```
public void setPivotCache(PivotCache pc)
```
    set the pivot cache pointer
    
    Parameters:
    
    pc - initialized pivot cache
  - getPivotCache
```
public PivotCache getPivotCache()
```
    return the pivot cache, if any
    
    Returns:
  - closeSheets
```
public void closeSheets()
```
    clear out ALL sheet object refs
  - closeRecords
```
protected void closeRecords()
```
  - close
```
public void close()
```
    clear out object references in prep for closing workbook
  - getColorTable
```
public Color[] getColorTable()
```
  - setColorTable
```
public void setColorTable(Color[] clrtable)
```
  - getDefaultIxfe
```
public int getDefaultIxfe()
```
  - setDefaultIxfe
```
public void setDefaultIxfe(int defaultIxfe)
```
  - getCalcId
```
public int getCalcId()
```
  - setCalcId
```
public void setCalcId(int i)
```

Class WorkBook

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STRING_ENCODING_AUTO

STRING_ENCODING_UNICODE

STRING_ENCODING_COMPRESSED

ALLOWDUPES

SHAREDUPES

colorTable

CONVERTMULBLANKS

formatCache

msodgMerge

msodg

lastSPID

Constructor Detail

WorkBook

Method Detail

reflectiveClone

createByteStreamer

getProtectionManager

mergeMSODrawingRecords

updateMsodrawingHeaderRec

getMSODrawingGroup

setMSODrawingGroup

createMSODrawingGroup

getStats

getStats

getXLSVersionString

prestream

getCharts

getSupBooks

getOOXMLObjects

addOOXMLObject

getTheme

setTheme

getExternalSupbook

getSupbookIndex

getChartVect

getPivotTableView

addPivotTable

getAllPivotTableViews

getNPivotTableViews

getExternSheet

getExternSheet

getFormatId

initializeNames

addName

addNameUpdateSheetRefs

addExternalName

getExternalNames

getExternalName

addDefaultExternsheet

getExtenalNameNumber

getNames

getWorkbookScopedNames

getFormulaList

getFormulas

removeFormula

getRecalculationMode

setRecalcuationMode

getName

setNewName

associateDereferencedNames

getName

getScopedName

getNameNumber

getFontIdx

getMatchingFontIndex

insertFont

addFont

getNumFonts

getFont

insertFormat

getFormula

addFormat

getNumFormats