Sheet (OpenXLS Java Spreadsheet SDK 11.0.4 API)

All Superinterfaces:

BiffRec

All Known Implementing Classes:

Boundsheet
```
public interface Sheet
extends BiffRec
```

Field Summary

Fields
Modifier and Type	Field and Description
`static byte`	`HIDDEN`
`static byte`	`TYPE_CHART`
`static byte`	`TYPE_SHEET_DIALOG`
`static byte`	`TYPE_VBMODULE`
`static byte`	`TYPE_XL4_MACRO`
`static byte`	`VERY_HIDDEN`
`static byte`	`VISIBLE`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addCell(CellRec cell)` add a cell to the worksheet cell collection associates with Row and Col
`Chart`	`addChart(byte[] inbytes, String NewChartName, short[] coords)`
`void`	`addColinfo(Colinfo c)` column formatting records
`void`	`addMergedCellsRec(Mergedcells r)`
`void`	`addRecord(BiffRec rec, int[] rc)` Add an BiffRec to a WorkSheet
`BiffRec`	`addValue(Object obj, String address)` Add a Value record to a WorkSheet.
`BiffRec`	`getCell(int row, int col)` Returns a BiffRec for working with the value of a BiffRec on a WorkSheet.
`BiffRec`	`getCell(String s)` get a cell by address from the worksheet
`BiffRec[]`	`getCells()` get an array of all cells for this worksheet
`Colinfo`	`getColInfo(int colin)` get a handle to a specific column of cells in this sheet
`Colinfo`	`getColinfo(String c)` get a colinfo by first col in range
`Collection<Colinfo>`	`getColinfos()` get the Collection of Colinfos
`List`	`getColNames()` get the List of columns defined on this sheet
`Dimensions`	`getDimensions()` the beginning of the Dimensions record is the index of the RowBlocks
`Footerrec`	`getFooter()`
`byte`	`getGrbitChr()`
`Guts`	`getGuts()`
`Headerrec`	`getHeader()`
`boolean`	`getHidden()` get whether this sheet is hidden upon opening
`BiffRec`	`getLastCell()` get the last BiffRec added to this sheet
`long`	`getLbPlyPos()` return the pos of the Bof for this Sheet
`List`	`getLocalRecs()`
`int`	`getMaxCol()`
`int`	`getMaxRow()`
`Mergedcells`	`getMergedCellsRec()`
`List`	`getMergedCellsRecs()`
`int`	`getMinCol()`
`int`	`getMinRow()`
`Bof`	`getMyBof()`
`Eof`	`getMyEof()`
`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
`Row`	`getRowByNumber(int r)` get a handle to the Row at the specified row index
`List`	`getRowNums()` get the List of rows defined on this sheet
`Row[]`	`getRows()` return an Array of the Rows in no particular order
`byte[]`	`getSheetBytes()`
`String`	`getSheetName()` get the name of the sheet
`int`	`getSheetNum()` set the numeric sheet number
`List`	`getSheetRecs()`
`short`	`getSheetType()` get the type of sheet as a short
`String`	`getSheetTypeString()` get the type of sheet as a string
`Window2`	`getWindow2()`
`WsBool`	`getWsBool()`
`void`	`init()` initialize the SheetImpl with data from the byte array.
`boolean`	`isChartOnlySheet()` remove rec from the vector, includes firing a changeevent.
`void`	`preStream()` do all of the expensive updating here only right before streaming record.
`void`	`removeAllRecords()` remove all Sheet records from Sheet.
`void`	`removeCell(BiffRec c)` Remove a BiffRec from this WorkSheet.
`void`	`removeCell(String celladdr)` Remove a BiffRec from this WorkSheet.
`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`	`removeRecFromVec(BiffRec rec)`
`boolean`	`selected()` returns the selected sheet status
`void`	`setBOF(Bof b)` set the Bof record for this SheetImpl
`void`	`setCopyPriorCellFormats(boolean f)`
`void`	`setDimensions(Dimensions d)`
`void`	`setEOF(Eof f)`
`void`	`setFooter(BiffRec r)`
`void`	`setGrbitChr(byte b)`
`void`	`setGuts(Guts g)`
`void`	`setHeader(BiffRec hr)`
`void`	`setHidden(int gr)` set whether this sheet is hidden upon opening
`void`	`setLbPlyPos(long newpos)` set the pos of the Bof for this Sheet
`void`	`setLocalRecs()`
`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`	`setWindow2(Window2 w)`
`void`	`setWsBool(WsBool ws)`
`String`	`toString()` get the name of the sheet
`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 a row down

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, getWorkBook, 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
  - VISIBLE
```
static final byte VISIBLE
```
    See Also:
    
    Constant Field Values
  - HIDDEN
```
static final byte HIDDEN
```
    See Also:
    
    Constant Field Values
  - VERY_HIDDEN
```
static final byte VERY_HIDDEN
```
    See Also:
    
    Constant Field Values
  - TYPE_SHEET_DIALOG
```
static final byte TYPE_SHEET_DIALOG
```
    See Also:
    
    Constant Field Values
  - TYPE_XL4_MACRO
```
static final byte TYPE_XL4_MACRO
```
    See Also:
    
    Constant Field Values
  - TYPE_CHART
```
static final byte TYPE_CHART
```
    See Also:
    
    Constant Field Values
  - TYPE_VBMODULE
```
static final byte TYPE_VBMODULE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getSheetRecs
```
List getSheetRecs()
```
  - getMyEof
```
Eof getMyEof()
```
  - getHeader
```
Headerrec getHeader()
```
  - setHeader
```
void setHeader(BiffRec hr)
```
  - getFooter
```
Footerrec getFooter()
```
  - setFooter
```
void setFooter(BiffRec r)
```
  - getLastCell
```
BiffRec getLastCell()
```
    get the last BiffRec added to this sheet
  - getLocalRecs
```
List getLocalRecs()
```
  - preStream
```
void preStream()
```
    do all of the expensive updating here only right before streaming record.
    
    Specified by:
    
    preStream in interface BiffRec
  - getMyBof
```
Bof getMyBof()
```
  - setWindow2
```
void setWindow2(Window2 w)
```
  - getWindow2
```
Window2 getWindow2()
```
  - removeCell
```
void removeCell(String celladdr)
```
    Remove a BiffRec from this WorkSheet.
  - removeCell
```
void removeCell(BiffRec c)
```
    Remove a BiffRec from this WorkSheet.
  - isChartOnlySheet
```
boolean isChartOnlySheet()
```
    remove rec from the vector, includes firing a changeevent.
  - removeRecFromVec
```
void removeRecFromVec(BiffRec rec)
```
  - removeMulrk
```
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.
  - getColInfo
```
Colinfo getColInfo(int colin)
```
    get a handle to a specific column of cells in this sheet
  - removeAllRecords
```
void removeAllRecords()
```
    remove all Sheet records from Sheet.
  - setBOF
```
void setBOF(Bof b)
```
    set the Bof record for this SheetImpl
  - setEOF
```
void setEOF(Eof f)
```
  - getLbPlyPos
```
long getLbPlyPos()
```
    return the pos of the Bof for this Sheet
  - setLbPlyPos
```
void setLbPlyPos(long newpos)
```
    set the pos of the Bof for this Sheet
  - getDimensions
```
Dimensions getDimensions()
```
    the beginning of the Dimensions record is the index of the RowBlocks
  - setDimensions
```
void setDimensions(Dimensions d)
```
  - getMinRow
```
int getMinRow()
```
  - getMaxRow
```
int getMaxRow()
```
  - getMinCol
```
int getMinCol()
```
  - getMaxCol
```
int getMaxCol()
```
  - updateDimensions
```
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.
  - setSheetIDX
```
void setSheetIDX(Index idx)
```
    set the associated sheet index
  - getSheetNum
```
int getSheetNum()
```
    set the numeric sheet number
  - updateMergedCells
```
void updateMergedCells()
```
    Shifts a row down
    
    Parameters:
    
    shiftamount - - number of rows shifted
  - getHidden
```
boolean getHidden()
```
    get whether this sheet is hidden upon opening
  - setHidden
```
void setHidden(int gr)
```
    set whether this sheet is hidden upon opening
  - selected
```
boolean selected()
```
    returns the selected sheet status
  - setSelected
```
void setSelected(boolean b)
```
    set whether this sheet is selected upon opening
  - getNumRows
```
int getNumRows()
```
    get the number of defined rows on this sheet
  - getNumCells
```
int getNumCells()
```
    get the number of defined cells on this sheet
  - getColNames
```
List getColNames()
```
    get the List of columns defined on this sheet
  - getNumCols
```
int getNumCols()
```
    get the Number of columns defined on this sheet
  - getRowByNumber
```
Row getRowByNumber(int r)
```
    get a handle to the Row at the specified row index
  - getRowNums
```
List getRowNums()
```
    get the List of rows defined on this sheet
  - getRows
```
Row[] getRows()
```
    return an Array of the Rows in no particular order
  - addValue
```
BiffRec addValue(Object obj,
                 String address)
```
    Add a Value record to a WorkSheet.
    
    Parameters:
    
    obj - the value of the new Cell
    
    address - the address of the new Cell
  - addRecord
```
void addRecord(BiffRec rec,
               int[] rc)
```
    Add an BiffRec to a WorkSheet
  - setCopyPriorCellFormats
```
void setCopyPriorCellFormats(boolean f)
```
  - addCell
```
void addCell(CellRec cell)
```
    add a cell to the worksheet cell collection associates with Row and Col
  - addColinfo
```
void addColinfo(Colinfo c)
```
    column formatting records
  - getColinfo
```
Colinfo getColinfo(String c)
```
    get a colinfo by first col in range
  - getColinfos
```
Collection<Colinfo> getColinfos()
```
    get the Collection of Colinfos
  - getCell
```
BiffRec getCell(String s)
```
    get a cell by address from the worksheet
  - getCell
```
BiffRec getCell(int row,
                int col)
         throws CellNotFoundException
```
    Returns a BiffRec for working with the value of a BiffRec on a WorkSheet.
    
    Parameters:
    
    int - Row the integer row of the Cell
    
    int - Col the integer col of the Cell
    
    Throws:
    
    CellNotFoundException - is thrown if there is no existing BiffRec at the specified address.
  - getCells
```
BiffRec[] getCells()
```
    get an array of all cells for this worksheet
  - addMergedCellsRec
```
void addMergedCellsRec(Mergedcells r)
```
  - getMergedCellsRecs
```
List getMergedCellsRecs()
```
  - getMergedCellsRec
```
Mergedcells getMergedCellsRec()
```
  - getSheetName
```
String getSheetName()
```
    get the name of the sheet
  - toString
```
String toString()
```
    get the name of the sheet
    
    Overrides:
    
    toString in class Object
  - init
```
void init()
```
    initialize the SheetImpl with data from the byte array.
    
    Specified by:
    
    init in interface BiffRec
  - getGrbitChr
```
byte getGrbitChr()
```
  - setGrbitChr
```
void setGrbitChr(byte b)
```
    Parameters:
    
    b -
  - setSheetName
```
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
  - getSheetBytes
```
byte[] getSheetBytes()
              throws IOException
```
    Throws:
    
    IOException
  - setLocalRecs
```
void setLocalRecs()
```
  - getSheetType
```
short getSheetType()
```
    get the type of sheet as a short
  - getSheetTypeString
```
String getSheetTypeString()
```
    get the type of sheet as a string
  - addChart
```
Chart addChart(byte[] inbytes,
               String NewChartName,
               short[] coords)
```
  - getGuts
```
Guts getGuts()
```
  - setGuts
```
void setGuts(Guts g)
```
  - setWsBool
```
void setWsBool(WsBool ws)
```
  - getWsBool
```
WsBool getWsBool()
```

Interface Sheet

Field Summary

Method Summary

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

Field Detail

VISIBLE

HIDDEN

VERY_HIDDEN

TYPE_SHEET_DIALOG

TYPE_XL4_MACRO

TYPE_CHART

TYPE_VBMODULE

Method Detail

getSheetRecs

getMyEof

getHeader

setHeader

getFooter

setFooter

getLastCell

getLocalRecs

preStream

getMyBof

setWindow2

getWindow2

removeCell

removeCell

isChartOnlySheet

removeRecFromVec

removeMulrk

getColInfo

removeAllRecords

setBOF

setEOF

getLbPlyPos

setLbPlyPos

getDimensions

setDimensions

getMinRow

getMaxRow

getMinCol

getMaxCol

updateDimensions

setSheetIDX

getSheetNum

updateMergedCells

getHidden

setHidden

selected

setSelected

getNumRows

getNumCells

getColNames

getNumCols

getRowByNumber

getRowNums

getRows

addValue

addRecord

setCopyPriorCellFormats

addCell

addColinfo

getColinfo

getColinfos

getCell

getCell

getCells

addMergedCellsRec

getMergedCellsRecs

getMergedCellsRec

getSheetName

toString

init

getGrbitChr

setGrbitChr

setSheetName

getSheetBytes

setLocalRecs

getSheetType

getSheetTypeString