Boundsheet (OpenXLS Java Spreadsheet SDK 11.0.4 API)

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

All Implemented Interfaces:

BlockByteConsumer, BiffRec, Sheet, XLSConstants, Serializable
```
public final class Boundsheet
extends XLSRecord
implements Sheet
```
Boundsheet: WorkSheet Information 0x85
This record stores the sheet name, type and stream position.
```
    offset  name        size    contents
    ---
    4       lbPlyPos    4       Stream position of the BOF for the sheet
    8       grbit       2       Option flags
    10      cch         1       Length of sheet name
    11      grbitChr    1       Compressed/Uncompressed Unicode
    12      rgch        var     Sheet name
    
```
---- File Layout ---- BOUNDSHEET Bof Index Row1 is first index in DBCELL Row2 is the offset of any DBCELLS Row... CELLREC CELLREC CELLREC DBCELL rgdb rg rg rg rg ROWS CELLS DBCELL rg rg rg ... EOF ---------------------- lbplypos used to be the most important thing on earth. now it is not an issue.
See Also:

WorkBook, Index, Dbcell, Row, Cell, XLSRecord, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected AbstractList`	`arrayformulas`
`boolean`	`fastCellAdds`
`protected Footerrec`	`ftr`
`protected Headerrec`	`hdr`
`static byte`	`HIDDEN`
`HashMap`	`imageMap`
`int`	`lastObjId`
`static byte`	`VERY_HIDDEN`
`static byte`	`VISIBLE`

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.Sheet
TYPE_CHART, TYPE_SHEET_DIALOG, TYPE_VBMODULE, TYPE_XL4_MACRO

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, 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

Boundsheet()

Constructors
Constructor and Description
`Boundsheet()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addArrayFormula(Array a)` associate an Array formula with this Boundsheet
`AutoFilter`	`addAutoFilter(int column)` Adds a new AutoFilter to the specified column
`void`	`addCell(CellRec cell)` Add a cell to this boundsheet record and populate the cells array
`Chart`	`addChart(byte[] inbytes, short[] coords)` Adds a chart from a bytestream, keeps the title intact.
`Chart`	`addChart(byte[] inbytes, String NewChartName, short[] coords)`
`void`	`addChart(Chart c)` add chart to sheet-specific list of charts
`void`	`addColinfo(Colinfo c)` column formatting records Note that it checks if exists.
`Colinfo`	`addColinfo(int begCol, int endCol, int width, int ixfe, int grbit)` Add a new colinfo
`void`	`addConditionalFormat(Condfmt cf)` add a new Condtional Format rec for this sheet
`protected static void`	`addExternalInfo(Map<String,String> externalobjs, org.xmlpull.v1.XmlPullParser xpp)` associates external reference info with the r:id of the external reference for instance, oleObject elements are associated with a shape Id that links back to a .vml file entry
`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 sheet, adding them here will not add them to the workbook;
`void`	`addMarginRecord(BiffRec r)` add pritner setting record to worksheet recs
`Mergedcells`	`addMergedCellRec()` adds a merged cell to this sheet
`void`	`addMergedCellsRec(Mergedcells r)`
`void`	`addOOXMLObject(Object o)` adds the object-specific signature of the external or auxillary Excel 2007 object e.g.
`void`	`addOOXMLShape(Object vml)` Store Excel 2007 legacy drawing shapes
`void`	`addOOXMLShape(OneCellAnchor oca)` store Excel 2007 shape via Shape Name
`void`	`addOOXMLShape(TwoCellAnchor tca)` store Excel 2007 shape via Shape Name
`void`	`addParentArrayRef(String addr, String ref)` map array formula range reference to the parent array formula address for Array Formula Parent Records only boundsheet
`Sxview`	`addPivotTable(String ref, WorkBookHandle wbh, int sId, String tablename)` adds a sxview - pivot table lead record - and required associated records to the worksheet other methods that add data, row, col and page fields will fill in the pivot table fields and formatting info
`void`	`addPrintRec(BiffRec record)` Adds a print-related record to the list of said.
`void`	`addRecord(BiffRec rec, int[] rc)` Add an XLSRecord to a WorkSheet.
`void`	`addRowRec(Row r)` associate an existing Row with this Boundsheet if the row already exists...
`BiffRec`	`addValue(Object obj, int[] rc, boolean fixNumberAsString)` adds a value to the sheet
`BiffRec`	`addValue(Object obj, int[] rc, int FORMAT_ID)` adds a cell to the Sheet
`BiffRec`	`addValue(Object obj, int[] rc, int FORMAT_ID, boolean fixNumberAsString)` adds a cell to the Sheet
`BiffRec`	`addValue(Object obj, String address)` Add a Value record to a WorkSheet.
`BiffRec`	`addValue(Object obj, String address, boolean fixNumberAsString)` Add a Value record to a WorkSheet.
`List`	`assembleSheetRecs()` assembleSheetRecs assembles the array of records, then ouputs the ordered list to the bytestreamer, which should be the only thing calling this.
`void`	`close()` clear out object references in prep for closing workbook
`Cf`	`createCf(Condfmt cfx)` Create a Cf (Conditional format rule) record and add it to sheet recs
`Colinfo`	`createColinfo(int first, int last)`
`Colinfo`	`createColinfo(int first, int last, Colinfo template)` Create a colinfo using the values from an existing colinfo
`Colinfo`	`createColinfo(int first, int last, int width, int ixfe, int grbit)` Add a new colinfo
`Condfmt`	`createCondfmt(String location, WorkBookHandle wbh)` Create a Condfmt (Conditional format) record and add it to sheet recs
`Dv`	`createDv(String location)` Create a dv (validation record) record gets inserted into the byte stream from within Dval
`Note`	`createNote(String address, String txt, String author)` Adds a new Note or Comment to the sheet at the desired address
`Note`	`createNote(String address, Unicodestring txt, String author)` Adds a new Note or Comment to the sheet at the desired address with Formatting (Font) information
`void`	`evaluateAutoFilters()` update row filter (hidden status) by evaluating AutoFilter conditions on the sheet Must do after autofilter updates or additions
`Name[]`	`getAllNames()` Get all the names for this boundsheet
`Array`	`getArrayFormula(String addr)` Returns an array formula for the set address
`Object`	`getArrayFormulaParent(int[] rc)` see if an array formula is part of an existing array formula by checking to see if the address in quesion is referenced by any array formula references on this sheet
`String`	`getArrayRef(String formAddress)` given an parent array formula at address formAddress, look up in saved arrFormulaLocs for the cell range it references
`List`	`getAutoFilters()` return the AutoFilter record for this Boundsheet, if any TODO: Merge with OOXML Autofilter
`BiffRec`	`getCell(int row, int col)` Gets a cell on this sheet by its row and column indexes.
`BiffRec`	`getCell(String address)` Deprecated. Use `getCell(int, int)` instead.
`BiffRec[]`	`getCells()` get an array of all cells for this worksheet
`ArrayList<BiffRec>`	`getCellsByCol(int colNum)` Access an arrayList of cells by column
`ArrayList<BiffRec>`	`getCellsByRow(int rowNum)` Access an arrayList of cells by column
`List`	`getCharts()` This seems incorrect, should we not be just returning charts for the boundsheet in question?
`Colinfo`	`getColInfo(int col)` get a handle to a specific column of cells in this sheet
`Colinfo`	`getColinfo(String c)` get a colinfo by name
`Collection<Colinfo>`	`getColinfos()` get the Collection of Colinfos
`List`	`getColNames()` get the FastAddVector of columns defined on this sheet
`List`	`getConditionalFormats()`
`float`	`getDefaultColumnWidth()` return the default column width in # characters of the maximum digit width of the normal style's font This is currently a floating point value, something I question.
`double`	`getDefaultRowHeight()` return the default row height in points (Excel 2007-Specific)
`DefColWidth`	`getDefColWidth()`
`Dimensions`	`getDimensions()` the beginning of the Dimensions record is the index of the RowBlocks
`Dval`	`getDvalRec()`
`List`	`getDvRecs()` Return an array of all the dvRecs within this boundsheet (Dval parent rec)
`Footerrec`	`getFooter()`
`byte`	`getGrbitChr()`
`Guts`	`getGuts()`
`Headerrec`	`getHeader()`
`boolean`	`getHidden()` get whether this sheet is hidden upon opening (either regular or "very hidden"
`ImageHandle`	`getImageByMsoIndex(int index)` obtain the desired image handle via the MsoDrawing Image Index used for mapping images from copied worksheets
`ImageHandle[]`	`getImages()` for whatever reason, we return a Handle from an internal class
`List`	`getImageVect()` returns the images list
`int`	`getIndexOf(short opc)`
`int`	`getIndexOfDimensions()`
`int`	`getIndexOfMsodrawingselection()`
`int`	`getIndexOfWindow2()`
`BiffRec`	`getLastCell()` get the last BiffRec added to this sheet
`Selection`	`getLastselection()`
`long`	`getLbPlyPos()` return the pos of the Bof for this Sheet
`List`	`getLocalRecs()`
`int`	`getMaxCol()`
`int`	`getMaxRow()` return true maximum/last row on the sheet
`List`	`getMergedCells()` return existing merged cell records without adding new blank
`Mergedcells`	`getMergedCellsRec()`
`List`	`getMergedCellsRecs()`
`int`	`getMinCol()`
`int`	`getMinRow()`
`Bof`	`getMyBof()`
`Eof`	`getMyEof()`
`Name`	`getName(String name)` Get a sheet scoped name record from the boundsheet
`ArrayList`	`getNotes()` returns an arrayList of notes in the worksheet
`int`	`getNumCells()` get the number of defined cells on this sheet
`int`	`getNumCols()` get the Number of columns defined on this sheet
`int`	`getNumRows()` get the number of defined rows on this sheet
`AutoFilter`	`getOOAutoFilter()` returns the Excel 2007 autoFilter element for this sheet (temporarily hides rows based upon filter criteria) TODO: Merge with 2003 AutoFilter
`List`	`getOOXMLObjects()` returns the list of Excel 2007 objects which are external or auxillary to this sheet e.g printerSeettings, vmlDrawings
`HashMap`	`getOOXMLShapes()` return map of Excel 2007 shapes in this workbook
`Pane`	`getPane()` retrieve the Pane rec for this sheet
`String`	`getPrintArea()` Get the print area set for this WorkSheetHandle.
`protected Name`	`getPrintAreaNameRec()` Get the print area name rec for this boundsheet, return null if not exists
`protected Name`	`getPrintAreaNameRec(byte type)` Get the print area or titles name rec for this boundsheet, return null if not exists
`PrinterSettingsHandle`	`getPrinterSetupHandle()` Gets the printer setup handle for this sheet.
`List`	`getPrintRecs()` Gets a list of the print related records for this sheet.
`String`	`getPrintTitles()` Get the Print Titles range set for this WorkSheetHandle.
`SheetProtectionManager`	`getProtectionManager()` Gets this sheet's SheetProtectionManager.
`int`	`getRealMaxCol()` Returns the real last col num.
`Row`	`getRowByNumber(int r)` get a handle to the Row at the specified row index Zero-based Index.
`Map`	`getRowMap()` return a Map of the Rows
`List`	`getRowNums()` get the FastAddVector of rows defined on this sheet
`Row[]`	`getRows()` return an Array of the Rows
`Scl`	`getScl()` scl is for zoom
`Name`	`getScopedName(String nameRef)` returns a scoped named range by name string
`byte[]`	`getSheetBytes()` Returns a serialized copy of this Boundsheet
`String`	`getSheetHash()` Sheet hash is a cross-workbook identifier for OpenXLS.
`Index`	`getSheetIDX()` set the associated sheet index
`String`	`getSheetName()` get the name of the sheet
`int`	`getSheetNum()` set the numeric sheet number
`SheetPr`	`getSheetPr()` returns the Excel 2007 sheetPr sheet Properties element for this sheet (controls codename, tabColor ...)
`BiffRec`	`getSheetRec(short opc)` return the desired record from the sheetrecs, or null if doesn't exist
`List`	`getSheetRecs()`
`Name[]`	`getSheetScopedNames()` Get a collection of all names in the worksheet
`short`	`getSheetType()` get the type of sheet as a short
`String`	`getSheetTypeString()` get the type of sheet as a string
`SheetView`	`getSheetView()` returns the Excel 2007 sheetView element for this sheet (controls topLeftCell, pane attributes ...
`SortedMap`	`getSortedRows()` return the map of row in this sheet sorted by row # (will be unsorted if insertions and deletions)
`protected List`	`getTransferFonts()` return local Font records, used for boundsheet transferral.
`protected List`	`getTransferXfs()` return local XF records, used for boundsheet transferral.
`boolean`	`getVeryHidden()`
`Window2`	`getWindow2()`
`WorkBook`	`getWorkBook()`
`WsBool`	`getWsBool()`
`boolean`	`hasCustomHeight()` return true if defaultrowheight is manually set (Excel 2007-Specific)
`boolean`	`hasMergedCells()` return truth of "has merged cells"
`boolean`	`hasThickBottom()` set if row has thick bottom by default (Excel 2007-Specific)
`boolean`	`hasThickTop()` return true if row has thick top by default (Excel 2007-Specific)
`boolean`	`hasZeroHeight()` return true if rows are hidden by default (Excel 2007-Specific)
`void`	`init()` initialize the SheetImpl with data from the byte array.
`void`	`insertCols(int first, int count)` inserts a col and shifts all of the other rows over one
`int`	`insertDropDownBox(int colNum)` Handles the MSO records necessary for defining a DropDown list object
`Dval`	`insertDvalRec()` For workbooks that do not contain a dval record, insert a default dval rec
`void`	`insertImage(ImageHandle im)` Insert an image into the WorkBook
`void`	`insertImage(ImageHandle im, boolean bAddUnconditionally)` Please add comments for this method
`Row`	`insertRow(int rownum, int firstcol, int flag, boolean shiftrows)` Inserts a row and shifts subsequent rows down by one.
`void`	`insertSheetRecordAt(BiffRec r, int index)`
`boolean`	`isArrayFormulaParent(String addr)` return true if address refers to an Array Formula Parent i.e.
`boolean`	`isChartOnlySheet()` Determine if the boundsheet is a chart only boundsheet
`boolean`	`isShiftInclusive()` return whether to shift (formula cells, named ranges) "inclusive" or not
`void`	`moveCell(String startaddr, String endaddr)` Moves a cell location from one address to another
`protected void`	`parseSheetElements(WorkBookHandle bk, ZipFile zip, ArrayList cl, String parentDir, String externalDir, ArrayList formulas, ArrayList hyperlinks, HashMap inlineStrs, HashMap<String,WorkSheetHandle> pivotTables)` parses OOXML content files given a content list cl from zip file zip recurses if content file has it's own content ************************************* NOTE: certain elements we do not as of yet process; we "pass-through" or store such elements along with any embedded objects associated with them for example, activeX objects, vbaProject.bin, etc.
`void`	`populateForTransfer()` populateForTransfer is a method that takes all of the shared resources (SST, XF, Font, etc) records and verifies that they are populated for use in a destination workbook
`void`	`preStream()` do all of the expensive updating here only right before streaming record.
`void`	`removeAllRecords()` remove all Sheet records from Sheet.
`void`	`removeAutoFilter()` removes all autofilters from this sheet
`void`	`removeCell(BiffRec cell)` remove a BiffRec from the worksheet.
`void`	`removeCell(int row, int col)` Remove a BiffRec from this WorkSheet.
`void`	`removeCell(String celladdr)` Deprecated. Use `removeCell(int, int)` instead.
`void`	`removeCols(int first, int count, boolean shift)` Removes a set of columns and their associated cells from this sheet.
`boolean`	`removeImage(ImageHandle img)` removes an image from the imagehandle cache (should be in WSH) Jan 22, 2010
`void`	`removeLocalName(Name name)` Remove a sheet-scoped name record from the boundsheet.
`void`	`removeMulrk(Rk thisrk)` Called from removeCell(), removeMulrk() handles the fact that you are trying to delete a rk that is really just a part of a Mulrk.
`void`	`removeNote(Note n)` removes the desired note from the sheet
`void`	`removePane()` remove pane rec, effectively unfreezing
`void`	`removeRecFromVec(BiffRec rec)` remove rec from the vector, includes firing a changeevent.
`void`	`removeRecFromVec(int idx)` remove a record from the vector via it's index into the SheetRecs aray, includes firing a change event
`void`	`removeRowContents(int rownum)` Remove a row, do not shift any other rows
`void`	`removeRows(int first, int count, boolean shift)` Removes some rows and all associated cells from this sheet.
`boolean`	`selected()` returns the selected sheet status
`void`	`setBOF(Bof b)` set the Bof record for this Boundsheet
`void`	`setCopyPriorCellFormats(boolean f)`
`void`	`setDefaultColumnWidth(float w)` set the default column width in # characters of the maximum digit width of the normal style's font
`void`	`setDefaultRowHeight(double h)` set the default row height in points (Excel 2007-Specific)
`void`	`setDefColWidth(DefColWidth defColWidth)`
`void`	`setDimensions(Dimensions d)`
`void`	`setDvalRec(Dval d)`
`void`	`setEOF(Eof f)`
`void`	`setFastCellAdds(boolean fastCellAdds)` Set to true to turn off checking for existing cells, conditional formats and merged ranges in order to accelerate adding new cells
`void`	`setFooter(BiffRec ftr)`
`void`	`setGrbitChr(byte gb)`
`void`	`setGuts(Guts g)`
`void`	`setHasCustomHeight(boolean b)` set if defaultrowheight is manually set (Excel 2007-Specific)
`void`	`setHeader(BiffRec h)`
`void`	`setHidden(int gr)` set whether this sheet is hidden upon opening
`void`	`setLastselection(Selection lastselection)`
`void`	`setLbPlyPos(long newpos)` set the pos of the Bof for this Sheet
`void`	`setLocalRecs()` prior to serializing the worksheet, we need to initialize the records which belong to this sheet instance.
`void`	`setLocalRecs(FastAddVector l)`
`void`	`setOOAutoFilter(AutoFilter a)` set the Excel 2007 autoFilter element for this sheet (temporarily hides rows based upon filter criteria) TODO: Merge with 2003 AutoFilter
`void`	`setPane(Pane p)` set/save the Pane rec for this sheet also links the Window2 rec to the pane rec
`void`	`setPrintArea(String range)` Set the print area for this worksheet.
`void`	`setPrintArea(String printarea, byte type)` Set the print area or titles for this worksheet.
`void`	`setPrintTitles(String range)` Set the print titles for this worksheet= row(s) or col(s) to repeat at the top of each page
`void`	`setScl(Scl s)` scl is for zoom
`void`	`setSelected(boolean b)` set whether this sheet is selected upon opening
`void`	`setSheetIDX(Index idx)` set the associated sheet index
`void`	`setSheetName(String newname)` change the displayed name of the sheet Affects the following byte values: 10 cch 1 Length of sheet name 11 grbitChr 1 Compressed/Uncompressed Unicode 12 rgch var Sheet name
`void`	`setSheetPr(SheetPr s)` set the Excel 2007 sheetView element for this sheet (controls topLeftCell, pane attributes ...
`void`	`setSheetRecs(AbstractList shtRecs)`
`void`	`setSheetView(SheetView s)` set the Excel 2007 sheetView element for this sheet (controls topLeftCell, pane attributes ...
`void`	`setShiftRule(boolean bShiftInclusive)` Set whether to shift formula cells inclusively i.e.
`void`	`setThickBottom(boolean b)` set if row has thick bottom by default (Excel 2007-Specific)
`void`	`setThickTop(boolean b)` set if row has thick top by default (Excel 2007-Specific)
`void`	`setWindow2(Window2 w)`
`void`	`setWsBool(WsBool ws)`
`void`	`setZeroHeight(boolean b)` set if rows are hidden by default (Excel 2007-Specific)
`String`	`toString()` get the name of the sheet
`void`	`updateCellReferences(BiffRec c, String endaddr)` Moves a cell location from one address to another, without any clearing of previous locations.
`void`	`updateDimensions(int row, int c)` update the INDEX record with the new max Row # why we need so many redundant references to the Min/Max Row/Cols is a question for the Redmond sages.
`void`	`updateMergedCells()` shifts Merged cells.
`void`	`writeAsTabbedText(OutputStream dest)` write this sheet as tabbed text output: All rows and all characters in each cell are saved.

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, getPrototype, getRealRecordIndex, getRecDesc, getRecordIndex, getRow, getRowNumber, getSheet, getStreamer, getStringVal, getStringVal, 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

Methods inherited from interface io.starter.formats.XLS.BiffRec
addContinue, copyFormat, getBooleanVal, getByteAt, getByteReader, getBytes, getBytesAt, getCellAddress, getColNumber, getContinueVect, getData, getDataType, getDblVal, getDefaultVal, getEncryptedByteReader, getFloatVal, getFont, getFormatPattern, getFormulaRec, getHyperlink, getInternalVal, getIntVal, getIxfe, getLength, getMergeRange, getOffset, getOpcode, getRecordIndex, getRow, getRowNumber, getSheet, getStreamer, getStringVal, getStringVal, getXfRec, hasContinues, isReadOnly, isValueForCell, postStream, remove, removeContinues, setBooleanVal, setByteReader, setCol, setData, setDebugLevel, setDoubleVal, setEncryptedByteReader, setHyperlink, setIndex, setIntVal, setIsValueForCell, setIxfe, setLength, setMergeRange, setOffset, setOpcode, setRow, setRowCol, setRowNumber, setSheet, setStreamer, setStringVal, setWorkBook, setXFRecord, setXFRecord, toHexDump

- Field Detail
  - arrayformulas
```
protected AbstractList arrayformulas
```
  - imageMap
```
public HashMap imageMap
```
  - hdr
```
protected Headerrec hdr
```
  - ftr
```
protected Footerrec ftr
```
  - lastObjId
```
public int lastObjId
```
  - VISIBLE
```
public static final byte VISIBLE
```
    See Also:
    
    Constant Field Values
  - HIDDEN
```
public static final byte HIDDEN
```
    See Also:
    
    Constant Field Values
  - VERY_HIDDEN
```
public static final byte VERY_HIDDEN
```
    See Also:
    
    Constant Field Values
  - fastCellAdds
```
public boolean fastCellAdds
```
- Constructor Detail
  - Boundsheet
```
public Boundsheet()
```
- Method Detail
  - getHeader
```
public Headerrec getHeader()
```
    Specified by:
    
    getHeader in interface Sheet
  - setHeader
```
public void setHeader(BiffRec h)
```
    Specified by:
    
    setHeader in interface Sheet
  - getFooter
```
public Footerrec getFooter()
```
    Specified by:
    
    getFooter in interface Sheet
  - setFooter
```
public void setFooter(BiffRec ftr)
```
    Specified by:
    
    setFooter in interface Sheet
  - setDvalRec
```
public void setDvalRec(Dval d)
```
  - getDvalRec
```
public Dval getDvalRec()
```
  - getProtectionManager
```
public SheetProtectionManager getProtectionManager()
```
    Gets this sheet's SheetProtectionManager.
  - getLastCell
```
public BiffRec getLastCell()
```
    get the last BiffRec added to this sheet
    
    Specified by:
    
    getLastCell in interface Sheet
  - getSheetRecs
```
public List getSheetRecs()
```
    Specified by:
    
    getSheetRecs in interface Sheet
  - insertImage
```
public void insertImage(ImageHandle im)
```
    Insert an image into the WorkBook
    
    Parameters:
    
    im -
  - insertImage
```
public void insertImage(ImageHandle im,
                        boolean bAddUnconditionally)
```
    Please add comments for this method
    
    Parameters:
    
    bAddUnconditionally -
  - getImageVect
```
public List getImageVect()
```
    returns the images list
  - getSheetScopedNames
```
public Name[] getSheetScopedNames()
```
    Get a collection of all names in the worksheet
  - getImages
```
public ImageHandle[] getImages()
```
    for whatever reason, we return a Handle from an internal class
    
    Returns:
  - addColinfo
```
public void addColinfo(Colinfo c)
```
    column formatting records Note that it checks if exists. This is due to externally copied boundsheets already having the record in the array when addrecord occurs.
    
    Specified by:
    
    addColinfo in interface Sheet
  - insertDvalRec
```
public Dval insertDvalRec()
```
    For workbooks that do not contain a dval record, insert a default dval rec
    
    Returns:
  - createDv
```
public Dv createDv(String location)
```
    Create a dv (validation record) record gets inserted into the byte stream from within Dval
    
    Parameters:
    
    location -
    
    Returns:
  - createCondfmt
```
public Condfmt createCondfmt(String location,
                             WorkBookHandle wbh)
```
    Create a Condfmt (Conditional format) record and add it to sheet recs
    
    Parameters:
    
    location -
    
    Returns:
  - createCf
```
public Cf createCf(Condfmt cfx)
```
    Create a Cf (Conditional format rule) record and add it to sheet recs
    
    Parameters:
    
    Conditional - format
    
    range -
    
    Returns:
  - getImageByMsoIndex
```
public ImageHandle getImageByMsoIndex(int index)
```
    obtain the desired image handle via the MsoDrawing Image Index used for mapping images from copied worksheets
    
    Parameters:
    
    index -
    
    Returns:
  - getIndexOfMsodrawingselection
```
public int getIndexOfMsodrawingselection()
```
  - getIndexOfWindow2
```
public int getIndexOfWindow2()
```
  - getIndexOfDimensions
```
public int getIndexOfDimensions()
```
  - getIndexOf
```
public int getIndexOf(short opc)
```
  - getSheetRec
```
public BiffRec getSheetRec(short opc)
```
    return the desired record from the sheetrecs, or null if doesn't exist
    
    Parameters:
    
    opc -
    
    Returns:
  - insertSheetRecordAt
```
public void insertSheetRecordAt(BiffRec r,
                                int index)
```
  - getSheetHash
```
public String getSheetHash()
```
    Sheet hash is a cross-workbook identifier for OpenXLS. The first time it is called it creates the sheet hash.
    
    Returns:
  - assembleSheetRecs
```
public List assembleSheetRecs()
```
    assembleSheetRecs assembles the array of records, then ouputs the ordered list to the bytestreamer, which should be the only thing calling this.
  - writeAsTabbedText
```
public void writeAsTabbedText(OutputStream dest)
                       throws IOException
```
    write this sheet as tabbed text output:
    All rows and all characters in each cell are saved. Columns of data are separated by tab characters, and each row of data ends in a carriage return. If a cell contains a comma, the cell contents are enclosed in double quotation marks. All formatting, graphics, objects, and other worksheet contents are lost. The euro symbol will be converted to a question mark. If cells display formulas instead of formula values, the formulas are saved as text.
    
    Throws:
    
    IOException
  - preStream
```
public void preStream()
```
    do all of the expensive updating here only right before streaming record.
    
    Specified by:
    
    preStream in interface BiffRec
    
    Specified by:
    
    preStream in interface Sheet
    
    Overrides:
    
    preStream in class XLSRecord
  - getMyBof
```
public Bof getMyBof()
```
    Specified by:
    
    getMyBof in interface Sheet
  - getMyEof
```
public Eof getMyEof()
```
    Specified by:
    
    getMyEof in interface Sheet
  - getDvRecs
```
public List getDvRecs()
```
    Return an array of all the dvRecs within this boundsheet (Dval parent rec)
    
    Returns:
  - getConditionalFormats
```
public List getConditionalFormats()
```
    Returns:
    
    conditional formats for this sheet
  - addConditionalFormat
```
public void addConditionalFormat(Condfmt cf)
```
    add a new Condtional Format rec for this sheet
    
    Parameters:
    
    cf -
  - setWindow2
```
public void setWindow2(Window2 w)
```
    Specified by:
    
    setWindow2 in interface Sheet
  - getWindow2
```
public Window2 getWindow2()
```
    Specified by:
    
    getWindow2 in interface Sheet
  - setPane
```
public void setPane(Pane p)
```
    set/save the Pane rec for this sheet also links the Window2 rec to the pane rec
    
    Parameters:
    
    p -
  - getPane
```
public Pane getPane()
```
    retrieve the Pane rec for this sheet
    
    Returns:
  - removePane
```
public void removePane()
```
    remove pane rec, effectively unfreezing
  - getWorkBook
```
public WorkBook getWorkBook()
```
    Specified by:
    
    getWorkBook in interface BiffRec
    
    Overrides:
    
    getWorkBook in class XLSRecord
  - removeCell
```
@Deprecated
public void removeCell(String celladdr)
```
    Deprecated. Use removeCell(int, int) instead.
    
    Remove a BiffRec from this WorkSheet.
    
    Specified by:
    
    removeCell in interface Sheet
  - removeCell
```
public void removeCell(int row,
                       int col)
```
    Remove a BiffRec from this WorkSheet.
  - removeCell
```
public void removeCell(BiffRec cell)
```
    remove a BiffRec from the worksheet. Unfortunately this also has to manage mulrecs
    
    Specified by:
    
    removeCell in interface Sheet
  - removeImage
```
public boolean removeImage(ImageHandle img)
```
    removes an image from the imagehandle cache (should be in WSH) Jan 22, 2010
    
    Parameters:
    
    img -
    
    Returns:
  - removeRecFromVec
```
public void removeRecFromVec(int idx)
```
    remove a record from the vector via it's index into the SheetRecs aray, includes firing a change event
    
    Parameters:
    
    idx -
  - removeRows
```
public void removeRows(int first,
                       int count,
                       boolean shift)
```
    Removes some rows and all associated cells from this sheet. References are not handled; for those see ReferenceTracker.
    
    Parameters:
    
    first - the zero-based index of the first row to be removed
    
    count - the number of rows to be removed
    
    shift - whether to shift subsequent rows up to fill the empty space
  - removeRecFromVec
```
public void removeRecFromVec(BiffRec rec)
```
    remove rec from the vector, includes firing a changeevent.
    
    Specified by:
    
    removeRecFromVec in interface Sheet
  - removeMulrk
```
public void removeMulrk(Rk thisrk)
```
    Called from removeCell(), removeMulrk() handles the fact that you are trying to delete a rk that is really just a part of a Mulrk. This is handled by truncating the mulrk at the cell, then creating individual numbers after the deleted cell.
    
    Specified by:
    
    removeMulrk in interface Sheet
  - removeRowContents
```
public void removeRowContents(int rownum)
                       throws RowNotFoundException
```
    Remove a row, do not shift any other rows
    
    Throws:
    
    RowNotFoundException
  - removeCols
```
public void removeCols(int first,
                       int count,
                       boolean shift)
```
    Removes a set of columns and their associated cells from this sheet. Optionally shifts the subsequent columns left to fill the empty space. This method only updates the sheet and cell records. It doesn't adjust references; that's handled by WorkSheetHandle.removeCols(int, int).
    
    Parameters:
    
    first - this zero-based index of the first column to be removed
    
    count - the number of columns to remove
    
    shift - whether to shift subsequent columns left
  - getCellsByCol
```
public ArrayList<BiffRec> getCellsByCol(int colNum)
                                 throws CellNotFoundException
```
    Access an arrayList of cells by column
    
    Parameters:
    
    colNum -
    
    Returns:
    
    Throws:
    
    CellNotFoundException
  - getCellsByRow
```
public ArrayList<BiffRec> getCellsByRow(int rowNum)
                                 throws CellNotFoundException
```
    Access an arrayList of cells by column
    
    Parameters:
    
    colNum -
    
    Returns:
    
    Throws:
    
    CellNotFoundException
  - getColInfo
```
public Colinfo getColInfo(int col)
```
    get a handle to a specific column of cells in this sheet
    
    Specified by:
    
    getColInfo in interface Sheet
  - removeAllRecords
```
public void removeAllRecords()
```
    remove all Sheet records from Sheet.
    
    Specified by:
    
    removeAllRecords in interface Sheet
  - setBOF
```
public void setBOF(Bof b)
```
    set the Bof record for this Boundsheet
    
    Specified by:
    
    setBOF in interface Sheet
  - isChartOnlySheet
```
public boolean isChartOnlySheet()
```
    Determine if the boundsheet is a chart only boundsheet
    
    Specified by:
    
    isChartOnlySheet in interface Sheet
    
    Returns:
  - setEOF
```
public void setEOF(Eof f)
```
    Specified by:
    
    setEOF in interface Sheet
  - getLbPlyPos
```
public long getLbPlyPos()
```
    return the pos of the Bof for this Sheet
    
    Specified by:
    
    getLbPlyPos in interface Sheet
  - setLbPlyPos
```
public void setLbPlyPos(long newpos)
```
    set the pos of the Bof for this Sheet
    
    Specified by:
    
    setLbPlyPos in interface Sheet
  - getDimensions
```
public Dimensions getDimensions()
```
    the beginning of the Dimensions record is the index of the RowBlocks
    
    Specified by:
    
    getDimensions in interface Sheet
  - setDimensions
```
public void setDimensions(Dimensions d)
```
    Specified by:
    
    setDimensions in interface Sheet
  - getMinRow
```
public int getMinRow()
```
    Specified by:
    
    getMinRow in interface Sheet
  - getMaxRow
```
public int getMaxRow()
```
    return true maximum/last row on the sheet
    
    Specified by:
    
    getMaxRow in interface Sheet
  - getMinCol
```
public int getMinCol()
```
    Specified by:
    
    getMinCol in interface Sheet
  - getMaxCol
```
public int getMaxCol()
```
    Specified by:
    
    getMaxCol in interface Sheet
  - updateDimensions
```
public void updateDimensions(int row,
                             int c)
```
    update the INDEX record with the new max Row # why we need so many redundant references to the Min/Max Row/Cols is a question for the Redmond sages.
    
    Specified by:
    
    updateDimensions in interface Sheet
  - setSheetIDX
```
public void setSheetIDX(Index idx)
```
    set the associated sheet index
    
    Specified by:
    
    setSheetIDX in interface Sheet
  - getSheetIDX
```
public Index getSheetIDX()
```
    set the associated sheet index
  - getSheetNum
```
public int getSheetNum()
```
    set the numeric sheet number
    
    Specified by:
    
    getSheetNum in interface Sheet
  - insertRow
```
public Row insertRow(int rownum,
                     int firstcol,
                     int flag,
                     boolean shiftrows)
```
    Inserts a row and shifts subsequent rows down by one.
    
    Parameters:
    
    rownum - the zero-based index of the row to be created
    
    Returns:
    
    the row that was just inserted
  - updateMergedCells
```
public void updateMergedCells()
```
    shifts Merged cells. 10-15-04 -jm
    
    Specified by:
    
    updateMergedCells in interface Sheet
  - addRowRec
```
public void addRowRec(Row r)
```
    associate an existing Row with this Boundsheet if the row already exists... ignore?
  - getHidden
```
public boolean getHidden()
```
    get whether this sheet is hidden upon opening (either regular or "very hidden"
    
    Specified by:
    
    getHidden in interface Sheet
  - getVeryHidden
```
public boolean getVeryHidden()
```
  - setHidden
```
public void setHidden(int gr)
```
    set whether this sheet is hidden upon opening
    
    Specified by:
    
    setHidden in interface Sheet
  - selected
```
public boolean selected()
```
    returns the selected sheet status
    
    Specified by:
    
    selected in interface Sheet
  - setSelected
```
public void setSelected(boolean b)
```
    set whether this sheet is selected upon opening
    
    Specified by:
    
    setSelected in interface Sheet
  - addArrayFormula
```
public void addArrayFormula(Array a)
```
    associate an Array formula with this Boundsheet
  - getArrayFormula
```
public Array getArrayFormula(String addr)
```
    Returns an array formula for the set address
  - addParentArrayRef
```
public void addParentArrayRef(String addr,
                              String ref)
```
    map array formula range reference to the parent array formula address
    for Array Formula Parent Records only boundsheet
  - getArrayFormulaParent
```
public Object getArrayFormulaParent(int[] rc)
```
    see if an array formula is part of an existing array formula
    by checking to see if the address in quesion is referenced by any array formula references on this sheet
    
    Parameters:
    
    rc - row col of cell in question
    
    Returns:
    
    See Also:
    
    addArrayFormula
  - isArrayFormulaParent
```
public boolean isArrayFormulaParent(String addr)
```
    return true if address refers to an Array Formula Parent
    i.e. the parent array formula refers to one or multiple cell addreses
    
    Parameters:
    
    addr -
    
    Returns:
  - getArrayRef
```
public String getArrayRef(String formAddress)
```
    given an parent array formula at address formAddress, look up in saved arrFormulaLocs for the cell range it references
    
    Parameters:
    
    formAddress -
    
    Returns:
  - insertCols
```
public void insertCols(int first,
                       int count)
```
    inserts a col and shifts all of the other rows over one
    
    Parameters:
    
    first - zero-based int for the column (0='A')
  - getNumRows
```
public int getNumRows()
```
    get the number of defined rows on this sheet
    
    Specified by:
    
    getNumRows in interface Sheet
  - getNumCells
```
public int getNumCells()
```
    get the number of defined cells on this sheet
    
    Specified by:
    
    getNumCells in interface Sheet
  - getColNames
```
public List getColNames()
```
    get the FastAddVector of columns defined on this sheet
    
    Specified by:
    
    getColNames in interface Sheet
  - getNumCols
```
public int getNumCols()
```
    get the Number of columns defined on this sheet
    
    Specified by:
    
    getNumCols in interface Sheet
  - createColinfo
```
public Colinfo createColinfo(int first,
                             int last,
                             int width,
                             int ixfe,
                             int grbit)
```
    Add a new colinfo
    
    Parameters:
    
    first - The beginning column number (0 based)
    
    last - The end column number
    
    width - Initial width of the column
    
    ixfe - formatting
    
    grbit - ??
    
    Returns:
    
    Colinfo
  - createColinfo
```
public Colinfo createColinfo(int first,
                             int last,
                             Colinfo template)
```
    Create a colinfo using the values from an existing colinfo
    
    Parameters:
    
    first - first col in the colinfo
    
    last - last col in the colinfo
    
    template - template column
    
    Returns:
  - createColinfo
```
public Colinfo createColinfo(int first,
                             int last)
```
  - getRowByNumber
```
public Row getRowByNumber(int r)
```
    get a handle to the Row at the specified row index Zero-based Index. ie: row 0 contains cell A1
    
    Specified by:
    
    getRowByNumber in interface Sheet
  - getRowNums
```
public List getRowNums()
```
    get the FastAddVector of rows defined on this sheet
    
    Specified by:
    
    getRowNums in interface Sheet
  - getSortedRows
```
public SortedMap getSortedRows()
```
    return the map of row in this sheet sorted by row # (will be unsorted if insertions and deletions)
    
    Returns:
  - getRows
```
public Row[] getRows()
```
    return an Array of the Rows
    
    Specified by:
    
    getRows in interface Sheet
  - getRowMap
```
public Map getRowMap()
```
    return a Map of the Rows
  - addValue
```
public BiffRec addValue(Object obj,
                        String address)
```
    Description copied from interface: Sheet
    
    Add a Value record to a WorkSheet.
    
    Specified by:
    
    addValue in interface Sheet
    
    Parameters:
    
    obj - the value of the new Cell
    
    address - the address of the new Cell
  - addValue
```
public BiffRec addValue(Object obj,
                        String address,
                        boolean fixNumberAsString)
```
    Add a Value record to a WorkSheet. This method's purpose is to handle default formatting of the cell that is being added, and to do any manipulations neccessary to handle mulrks, mulblanks, etc. It is also the main entry point of adding values to the boundsheet. These values are then passed into createValrec() which
    
    Parameters:
    
    obj - the value of the new Cell
    
    address - the address of the new Cell
  - addValue
```
public BiffRec addValue(Object obj,
                        int[] rc,
                        boolean fixNumberAsString)
```
    adds a value to the sheet
    
    Parameters:
    
    obj -
    
    rc -
    
    Returns:
  - addValue
```
public BiffRec addValue(Object obj,
                        int[] rc,
                        int FORMAT_ID)
```
    adds a cell to the Sheet
    
    Parameters:
    
    obj -
    
    rc -
    
    FORMAT_ID -
    
    Returns:
  - addValue
```
public BiffRec addValue(Object obj,
                        int[] rc,
                        int FORMAT_ID,
                        boolean fixNumberAsString)
```
    adds a cell to the Sheet
    
    Parameters:
    
    obj -
    
    rc -
    
    FORMAT_ID -
    
    fixNumberAsString - - whether to attempt to convert to a number if it is a NSaS situation
    
    Returns:
  - addRecord
```
public void addRecord(BiffRec rec,
                      int[] rc)
```
    Add an XLSRecord to a WorkSheet. Creates the container cell for a record, sets the default information on the valrec (ie row/col/bs), checks to see if there is a container row for the cell, if not, then it creates the row. Finally, the cell is passed on to addCellToRowCol where it performs final initialization and is added to it's row
    
    Specified by:
    
    addRecord in interface Sheet
  - addCell
```
public void addCell(CellRec cell)
```
    Add a cell to this boundsheet record and populate the cells array
    
    Specified by:
    
    addCell in interface Sheet
    
    Parameters:
    
    cell -
  - setCopyPriorCellFormats
```
public void setCopyPriorCellFormats(boolean f)
```
    Specified by:
    
    setCopyPriorCellFormats in interface Sheet
  - getRealMaxCol
```
public int getRealMaxCol()
```
    Returns the *real* last col num. Unfortunately the dimensions record cannot be counted on to give a correct value.
  - addColinfo
```
public Colinfo addColinfo(int begCol,
                          int endCol,
                          int width,
                          int ixfe,
                          int grbit)
```
    Add a new colinfo
    
    Parameters:
    
    begCol - The beginning column number (0 based)
    
    endCol - The end column number
    
    width - Initial width of the column
    
    ixfe - formatting
    
    grbit - ??
    
    Returns:
    
    Colinfo
  - getColinfo
```
public Colinfo getColinfo(String c)
```
    get a colinfo by name
    
    Specified by:
    
    getColinfo in interface Sheet
  - getColinfos
```
public Collection<Colinfo> getColinfos()
```
    get the Collection of Colinfos
    
    Specified by:
    
    getColinfos in interface Sheet
  - moveCell
```
public void moveCell(String startaddr,
                     String endaddr)
```
    Moves a cell location from one address to another
  - updateCellReferences
```
public void updateCellReferences(BiffRec c,
                                 String endaddr)
```
    Moves a cell location from one address to another, without any clearing of previous locations. This is used in sorting and other cell movements where we do not want to delete from starting address
  - getCell
```
@Deprecated
public BiffRec getCell(String address)
```
    Deprecated. Use getCell(int, int) instead.
    
    Gets a cell on this sheet by its Excel A1-style address.
    
    Specified by:
    
    getCell in interface Sheet
    
    Parameters:
    
    address - the A1-style address of the cell to retrieve
    
    Returns:
    
    the cell record or null if no cell exists at the given address
  - getCell
```
public BiffRec getCell(int row,
                       int col)
                throws CellNotFoundException
```
    Gets a cell on this sheet by its row and column indexes.
    
    Specified by:
    
    getCell in interface Sheet
    
    Parameters:
    
    row - the zero-based index of the cell's parent row
    
    col - the zero-based index of the cell's parent column
    
    Returns:
    
    the cell record at the given address
    
    Throws:
    
    CellNotFoundException - if no cell exists at the given address
  - getCells
```
public BiffRec[] getCells()
```
    get an array of all cells for this worksheet
    
    Specified by:
    
    getCells in interface Sheet
  - addMergedCellsRec
```
public void addMergedCellsRec(Mergedcells r)
```
    Specified by:
    
    addMergedCellsRec in interface Sheet
  - getPrintAreaNameRec
```
protected Name getPrintAreaNameRec(byte type)
```
    Get the print area or titles name rec for this boundsheet, return null if not exists
    
    Returns:
  - getPrintAreaNameRec
```
protected Name getPrintAreaNameRec()
```
    Get the print area name rec for this boundsheet, return null if not exists
    
    Returns:
  - getPrintArea
```
public String getPrintArea()
```
    Get the print area set for this WorkSheetHandle. If no print area is set return null;
  - getPrintTitles
```
public String getPrintTitles()
```
    Get the Print Titles range set for this WorkSheetHandle. If no Print Titles are set, this returns null;
  - setPrintArea
```
public void setPrintArea(String range)
```
    Set the print area for this worksheet.
  - setPrintTitles
```
public void setPrintTitles(String range)
```
    Set the print titles for this worksheet= row(s) or col(s) to repeat at the top of each page
  - setPrintArea
```
public void setPrintArea(String printarea,
                         byte type)
```
    Set the print area or titles for this worksheet.
  - getNotes
```
public ArrayList getNotes()
```
    returns an arrayList of notes in the worksheet
    
    Returns:
  - getMergedCellsRec
```
public Mergedcells getMergedCellsRec()
```
    Specified by:
    
    getMergedCellsRec in interface Sheet
  - getMergedCellsRecs
```
public List getMergedCellsRecs()
```
    Specified by:
    
    getMergedCellsRecs in interface Sheet
  - addMergedCellRec
```
public Mergedcells addMergedCellRec()
```
    adds a merged cell to this sheet
    
    Returns:
  - getMergedCells
```
public List getMergedCells()
```
    return existing merged cell records without adding new blank
    
    Returns:
  - hasMergedCells
```
public boolean hasMergedCells()
```
    return truth of "has merged cells"
    
    Returns:
  - getSheetName
```
public String getSheetName()
```
    get the name of the sheet
    
    Specified by:
    
    getSheetName in interface Sheet
  - toString
```
public String toString()
```
    get the name of the sheet
    
    Specified by:
    
    toString in interface Sheet
    
    Overrides:
    
    toString in class XLSRecord
  - init
```
public void init()
```
    initialize the SheetImpl with data from the byte array.
    
    Specified by:
    
    init in interface BiffRec
    
    Specified by:
    
    init in interface Sheet
    
    Overrides:
    
    init in class XLSRecord
  - setSheetName
```
public void setSheetName(String newname)
```
    change the displayed name of the sheet Affects the following byte values: 10 cch 1 Length of sheet name 11 grbitChr 1 Compressed/Uncompressed Unicode 12 rgch var Sheet name
    
    Specified by:
    
    setSheetName in interface Sheet
  - getSheetBytes
```
public byte[] getSheetBytes()
                     throws IOException
```
    Returns a serialized copy of this Boundsheet
    
    Specified by:
    
    getSheetBytes in interface Sheet
    
    Throws:
    
    IOException
  - setLocalRecs
```
public void setLocalRecs()
```
    prior to serializing the worksheet, we need to initialize the records which belong to this sheet instance.
    
    Specified by:
    
    setLocalRecs in interface Sheet
  - getCharts
```
public List getCharts()
```
    This seems incorrect, should we not be just returning charts for the boundsheet in question?
    
    Returns:
  - getSheetType
```
public short getSheetType()
```
    get the type of sheet as a short
    
    Specified by:
    
    getSheetType in interface Sheet
  - getSheetTypeString
```
public String getSheetTypeString()
```
    get the type of sheet as a string
    
    Specified by:
    
    getSheetTypeString in interface Sheet
  - addChart
```
public void addChart(Chart c)
```
    add chart to sheet-specific list of charts
    
    Parameters:
    
    c -
    
    See Also:
    
    WorkBook.addRecord
  - addChart
```
public Chart addChart(byte[] inbytes,
                      short[] coords)
```
    Adds a chart from a bytestream, keeps the title intact.
    
    Parameters:
    
    inbytes -
    
    Returns:
  - addChart
```
public Chart addChart(byte[] inbytes,
                      String NewChartName,
                      short[] coords)
```
    Specified by:
    
    addChart in interface Sheet
  - populateForTransfer
```
public void populateForTransfer()
```
    populateForTransfer is a method that takes all of the shared resources (SST, XF, Font, etc) records and verifies that they are populated for use in a destination workbook
  - getTransferXfs
```
protected List getTransferXfs()
```
    return local XF records, used for boundsheet transferral.
  - getTransferFonts
```
protected List getTransferFonts()
```
    return local Font records, used for boundsheet transferral.
  - getGuts
```
public Guts getGuts()
```
    Specified by:
    
    getGuts in interface Sheet
  - setGuts
```
public void setGuts(Guts g)
```
    Specified by:
    
    setGuts in interface Sheet
  - setWsBool
```
public void setWsBool(WsBool ws)
```
    Specified by:
    
    setWsBool in interface Sheet
  - getWsBool
```
public WsBool getWsBool()
```
    Specified by:
    
    getWsBool in interface Sheet
  - getLocalRecs
```
public List getLocalRecs()
```
    Specified by:
    
    getLocalRecs in interface Sheet
    
    Returns:
    
    Returns the localrecs.
  - setLocalRecs
```
public void setLocalRecs(FastAddVector l)
```
    Parameters:
    
    localrecs - The localrecs to set.
  - setSheetRecs
```
public void setSheetRecs(AbstractList shtRecs)
```
  - getGrbitChr
```
public byte getGrbitChr()
```
    Specified by:
    
    getGrbitChr in interface Sheet
    
    Returns:
    
    Returns the grbitChr.
  - setGrbitChr
```
public void setGrbitChr(byte gb)
```
    Specified by:
    
    setGrbitChr in interface Sheet
    
    Parameters:
    
    grbitChr - The grbitChr to set.
  - getLastselection
```
public Selection getLastselection()
```
    Returns:
    
    Returns the lastselection.
  - setLastselection
```
public void setLastselection(Selection lastselection)
```
    Parameters:
    
    lastselection - The lastselection to set.
  - setFastCellAdds
```
public void setFastCellAdds(boolean fastCellAdds)
```
    Set to true to turn off checking for existing cells, conditional formats and merged ranges in order to accelerate adding new cells
    
    Parameters:
    
    fastCellAdds - The fastCellAdds to set.
  - getScl
```
public Scl getScl()
```
    scl is for zoom
    
    Returns:
  - setScl
```
public void setScl(Scl s)
```
    scl is for zoom
    
    Parameters:
    
    scl -
  - setShiftRule
```
public void setShiftRule(boolean bShiftInclusive)
```
    Set whether to shift formula cells inclusively i.e. if inserting row 5, shift formula D5:D6 down or D6:D7 OR shift inclusive by D5:D7
  - isShiftInclusive
```
public boolean isShiftInclusive()
```
    return whether to shift (formula cells, named ranges) "inclusive" or not
    
    Returns:
  - getPrinterSetupHandle
```
public PrinterSettingsHandle getPrinterSetupHandle()
```
    Gets the printer setup handle for this sheet.
  - getPrintRecs
```
public List getPrintRecs()
```
    Gets a list of the print related records for this sheet.
    
    Returns:
    
    an unmodifiable list of all printing-related records
  - addPrintRec
```
public void addPrintRec(BiffRec record)
```
    Adds a print-related record to the list of said.
  - getAutoFilters
```
public List getAutoFilters()
```
    return the AutoFilter record for this Boundsheet, if any TODO: Merge with OOXML Autofilter
    
    Returns:
  - createNote
```
public Note createNote(String address,
                       String txt,
                       String author)
```
    Adds a new Note or Comment to the sheet at the desired address
    
    Parameters:
    
    address - - String cell address
    
    txt - - Text of Note
    
    author - - String Author of Note
    
    Returns:
    
    NoteHandle - a handle to the Note object which allows manipulation
  - insertDropDownBox
```
public int insertDropDownBox(int colNum)
```
    Handles the MSO records necessary for defining a DropDown list object
    
    Returns:
  - createNote
```
public Note createNote(String address,
                       Unicodestring txt,
                       String author)
```
    Adds a new Note or Comment to the sheet at the desired address with Formatting (Font) information
    
    Parameters:
    
    address - - String cell address
    
    txt - - Unicode string reprentation of the note, including formatting
    
    author - - String Author of Note
    
    Returns:
    
    NoteHandle - a handle to the Note object which allows manipulation
  - removeNote
```
public void removeNote(Note n)
```
    removes the desired note from the sheet
    
    Parameters:
    
    n -
  - addAutoFilter
```
public AutoFilter addAutoFilter(int column)
```
    Adds a new AutoFilter to the specified column
    
    Parameters:
    
    int - column - 0-based column number
    
    Returns:
    
    AutoFilterHandle Handle to the new AutoFilter
  - removeAutoFilter
```
public void removeAutoFilter()
```
    removes all autofilters from this sheet
  - addPivotTable
```
public Sxview addPivotTable(String ref,
                            WorkBookHandle wbh,
                            int sId,
                            String tablename)
```
    adds a sxview - pivot table lead record - and required associated records to the worksheet
    other methods that add data, row, col and page fields will fill in the pivot table fields and formatting info
    
    Parameters:
    
    ref - Cell Range which identifies pivot table data range
    
    wbh - WorkBookHandle
    
    sId - Stream or cachid Id -- links back to SxStream set of records
    
    Returns:
  - evaluateAutoFilters
```
public void evaluateAutoFilters()
```
    update row filter (hidden status) by evaluating AutoFilter conditions on the sheet
    Must do after autofilter updates or additions
  - getOOXMLObjects
```
public List getOOXMLObjects()
```
    returns the list of Excel 2007 objects which are external or auxillary to this sheet e.g printerSeettings, vmlDrawings
    
    Returns:
  - addOOXMLObject
```
public void addOOXMLObject(Object o)
```
    adds the object-specific signature of the external or auxillary Excel 2007 object e.g. oleObjects, vmlDrawings
    
    Parameters:
    
    o -
  - hasThickBottom
```
public boolean hasThickBottom()
```
    set if row has thick bottom by default (Excel 2007-Specific)
  - hasThickTop
```
public boolean hasThickTop()
```
    return true if row has thick top by default (Excel 2007-Specific)
  - hasZeroHeight
```
public boolean hasZeroHeight()
```
    return true if rows are hidden by default (Excel 2007-Specific)
  - hasCustomHeight
```
public boolean hasCustomHeight()
```
    return true if defaultrowheight is manually set (Excel 2007-Specific)
  - getDefaultRowHeight
```
public double getDefaultRowHeight()
```
    return the default row height in points (Excel 2007-Specific)
  - getDefaultColumnWidth
```
public float getDefaultColumnWidth()
```
    return the default column width in # characters of the maximum digit width of the normal style's font This is currently a floating point value, something I question. I don't understand the need for this, and possibly it should be an int?
  - setThickBottom
```
public void setThickBottom(boolean b)
```
    set if row has thick bottom by default (Excel 2007-Specific)
  - setThickTop
```
public void setThickTop(boolean b)
```
    set if row has thick top by default (Excel 2007-Specific)
  - setZeroHeight
```
public void setZeroHeight(boolean b)
```
    set if rows are hidden by default (Excel 2007-Specific)
  - setHasCustomHeight
```
public void setHasCustomHeight(boolean b)
```
    set if defaultrowheight is manually set (Excel 2007-Specific)
  - setDefaultRowHeight
```
public void setDefaultRowHeight(double h)
```
    set the default row height in points (Excel 2007-Specific)
  - setDefaultColumnWidth
```
public void setDefaultColumnWidth(float w)
```
    set the default column width in # characters of the maximum digit width of the normal style's font
  - addOOXMLShape
```
public void addOOXMLShape(TwoCellAnchor tca)
```
    store Excel 2007 shape via Shape Name
    
    Parameters:
    
    tca -
  - addOOXMLShape
```
public void addOOXMLShape(OneCellAnchor oca)
```
    store Excel 2007 shape via Shape Name
    
    Parameters:
    
    tca -
  - addOOXMLShape
```
public void addOOXMLShape(Object vml)
```
    Store Excel 2007 legacy drawing shapes
    
    Parameters:
    
    vml -
  - getOOXMLShapes
```
public HashMap getOOXMLShapes()
```
    return map of Excel 2007 shapes in this workbook
    
    Returns:
  - getSheetView
```
public SheetView getSheetView()
```
    returns the Excel 2007 sheetView element for this sheet (controls topLeftCell, pane attributes ...
    
    Returns:
  - setSheetView
```
public void setSheetView(SheetView s)
```
    set the Excel 2007 sheetView element for this sheet (controls topLeftCell, pane attributes ...
    
    Parameters:
    
    s -
  - getSheetPr
```
public SheetPr getSheetPr()
```
    returns the Excel 2007 sheetPr sheet Properties element for this sheet (controls codename, tabColor ...)
    
    Returns:
  - setSheetPr
```
public void setSheetPr(SheetPr s)
```
    set the Excel 2007 sheetView element for this sheet (controls topLeftCell, pane attributes ...
    
    Parameters:
    
    s -
  - getOOAutoFilter
```
public AutoFilter getOOAutoFilter()
```
    returns the Excel 2007 autoFilter element for this sheet (temporarily hides rows based upon filter criteria) TODO: Merge with 2003 AutoFilter
    
    Returns:
  - setOOAutoFilter
```
public void setOOAutoFilter(AutoFilter a)
```
    set the Excel 2007 autoFilter element for this sheet (temporarily hides rows based upon filter criteria) TODO: Merge with 2003 AutoFilter
    
    Parameters:
    
    strref -
  - getScopedName
```
public Name getScopedName(String nameRef)
```
    returns a scoped named range by name string
    
    Parameters:
    
    t -
    
    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 sheet, adding them here will not add them to the workbook;
    
    Parameters:
    
    sheetNameRecs -
  - 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 sheet, removing them here will not remove them completely from the workbook. In order to do that you will need to call book.removeName
    
    Parameters:
    
    sheetNameRecs -
  - getName
```
public Name getName(String name)
```
    Get a sheet scoped name record from the boundsheet
    
    Returns:
  - getAllNames
```
public Name[] getAllNames()
```
    Get all the names for this boundsheet
    
    Returns:
  - addMarginRecord
```
public void addMarginRecord(BiffRec r)
```
    add pritner setting record to worksheet recs
    
    Parameters:
    
    r - printer setting record (Margins, PLS)
  - addExternalInfo
```
protected static void addExternalInfo(Map<String,String> externalobjs,
                                      org.xmlpull.v1.XmlPullParser xpp)
```
    associates external reference info with the r:id of the external reference for instance, oleObject elements are associated with a shape Id that links back to a .vml file entry
    
    Parameters:
    
    externalobjs -
    
    xpp -
  - parseSheetElements
```
protected void parseSheetElements(WorkBookHandle bk,
                                  ZipFile zip,
                                  ArrayList cl,
                                  String parentDir,
                                  String externalDir,
                                  ArrayList formulas,
                                  ArrayList hyperlinks,
                                  HashMap inlineStrs,
                                  HashMap<String,WorkSheetHandle> pivotTables)
                           throws org.xmlpull.v1.XmlPullParserException,
                                  CellNotFoundException
```
    parses OOXML content files given a content list cl from zip file zip recurses if content file has it's own content ************************************* NOTE: certain elements we do not as of yet process; we "pass-through" or store such elements along with any embedded objects associated with them for example, activeX objects, vbaProject.bin, etc. *************************************
    
    Parameters:
    
    bk - WorkBookHandle
    
    sheet - WorkSheetHandle (set if recursing)
    
    zip - currently open ZipOutputStream
    
    cl - ArrayList of Contents (type, filename, rId) to parse
    
    parentDir - Parent Directory for relative paths in content lists
    
    formulas, - hyperlinks, inlineStrs -- ArrayLists/Hashmaps stores sheet-specific info for later entry
    
    Throws:
    
    CellNotFoundException
    
    org.xmlpull.v1.XmlPullParserException
  - close
```
public void close()
```
    clear out object references in prep for closing workbook
    
    Overrides:
    
    close in class XLSRecord
  - getDefColWidth
```
public DefColWidth getDefColWidth()
```
  - setDefColWidth
```
public void setDefColWidth(DefColWidth defColWidth)
```

Class Boundsheet

Field Summary

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

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

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

Methods inherited from interface io.starter.formats.XLS.BiffRec

Field Detail

arrayformulas

imageMap

hdr

ftr

lastObjId

VISIBLE

HIDDEN

VERY_HIDDEN

fastCellAdds

Constructor Detail

Boundsheet

Method Detail

getHeader

setHeader

getFooter

setFooter

setDvalRec

getDvalRec

getProtectionManager

getLastCell

getSheetRecs

insertImage

insertImage

getImageVect

getSheetScopedNames

getImages

addColinfo

insertDvalRec

createDv

createCondfmt

createCf

getImageByMsoIndex

getIndexOfMsodrawingselection

getIndexOfWindow2

getIndexOfDimensions

getIndexOf

getSheetRec

insertSheetRecordAt

getSheetHash

assembleSheetRecs

writeAsTabbedText

preStream

getMyBof

getMyEof

getDvRecs

getConditionalFormats

addConditionalFormat

setWindow2

getWindow2

setPane

getPane

removePane

getWorkBook

removeCell

removeCell

removeCell

removeImage

removeRecFromVec

removeRows

removeRecFromVec

removeMulrk

removeRowContents

removeCols

getCellsByCol

getCellsByRow

getColInfo

removeAllRecords

setBOF

isChartOnlySheet