BiffRec (OpenXLS Java Spreadsheet SDK 11.0.4 API)

All Known Subinterfaces:

CellRec, Mulled, Sheet

All Known Implementing Classes:

Ai, AlRuns, Area, AreaFormat, Array, AttachedLabel, AutoFilter, Axcent, Axesused, Axis, AxisLineFormat, AxisParent, Bar, Begin, Blank, Bof, BookBool, Boolerr, Boppop, BoppopCustom, BottomMargin, Boundsheet, CalcMode, CatLab, CatserRange, Cf, Cf12, Chart, Chart3DBarShape, ChartFormat, ChartFormatLink, ChartFrtInfo, ChartLine, Codename, Colinfo, Condfmt, Condfmt12, Continue, Country, Crn, CrtLayout12, CrtLayout12A, Dat, DataFormat, DataLabExt, DataLabExtContents, Dbcell, DConBin, DConName, DConRef, DefaultRowHeight, DefaultText, DefColWidth, Dimensions, Dropbar, Dsf, Dv, Dval, End, EndBlock, EndObject, Eof, Externname, Externsheet, Extsst, Fbi, FeatHeadr, FileLock, Font, FontBasis, Fontx, Footerrec, Format, Formula, Frame, FrtFontList, FrtWrapper, GelFrame, GenericChartObject, Guts, HCenter, Headerrec, Hlink, Ifmt, Index, InterfaceHdr, Label, Labelsst, LeftMargin, Legend, Legendxn, Line, LineFormat, MarkerFormat, Mergedcells, MSODrawing, MSODrawingGroup, MSODrawingSelection, Mulblank, Mulrk, Name, NineteenOhFour, Note, NumberRec, Obj, ObjectLink, ObjProtect, Obproj, OOXMLChart, Palette, Pane, Password, Phonetic, Picf, Pie, PieFormat, PivotChartBits, PivotChartLink, PlotArea, PlotGrowth, Pls, PLV, Pos, PrintGrid, PrintRowCol, Prot4rev, Protect, QsiSXTag, Radar, RadarArea, RightMargin, Rk, Row, RrdHead, RrdInfo, Rstring, SbaseRef, Scatter, ScenProtect, Scl, Selection, SerauxErrBar, SerauxTrend, Serfmt, Series, SeriesList, SeriesText, SerParent, SerToCrt, Setup, Shrfmla, ShtProps, SiIndex, 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, TableStyles, TextDisp, ThreeD, Tick, TopMargin, Txo, UnencryptedXLSRecord, Units, Usersviewbegin, Usersviewend, UsrExcl, ValueRange, VCenter, Window1, Window2, Writeaccess, WsBool, Xct, Xf, XLSCellRecord, XLSRecord, YMult
```
public interface BiffRec
```
To change the template for this generated type comment go to Window>Preferences>Java>Code Generation>Code and Comments

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addContinue(Continue c)` adds a CONTINUE record to the array of CONTINUE records for this record, containing all data beyond the 8224 byte record size limit.
`void`	`copyFormat(BiffRec source)`
`boolean`	`getBooleanVal()`
`byte`	`getByteAt(int off)` Gets the byte from the specified position in the record byte array.
`BlockByteReader`	`getByteReader()`
`byte[]`	`getBytes()` gets the full record bytes for this record including header bytes
`byte[]`	`getBytesAt(int off, int len)` Gets the byte from the specified position in the record byte array.
`String`	`getCellAddress()` get a string address for the cell based on row and col ie: "H22"
`short`	`getColNumber()`
`List`	`getContinueVect()` returns the array of CONTINUE records for this record, containing all data beyond the 8224 byte record size limit.
`byte[]`	`getData()` gets the record data merging any Continue record data.
`String`	`getDataType()` get the data type name for this record
`double`	`getDblVal()`
`Object`	`getDefaultVal()` get a default "empty" data value for this record
`BlockByteReader`	`getEncryptedByteReader()`
`float`	`getFloatVal()` Get the value of the record as a Float.
`Font`	`getFont()`
`String`	`getFormatPattern()`
`Formula`	`getFormulaRec()`
`Hlink`	`getHyperlink()`
`Object`	`getInternalVal()`
`int`	`getIntVal()`
`int`	`getIxfe()` get the ixfe
`int`	`getLength()` Returns the length of this record, including the 4 header bytes
`CellRange`	`getMergeRange()`
`int`	`getOffset()` Get the relative position within the data underlying the block vector represented by the BlockByteReader.
`short`	`getOpcode()`
`int`	`getRecordIndex()` return the record index of this object
`Row`	`getRow()`
`int`	`getRowNumber()`
`Boundsheet`	`getSheet()` get the WorkSheet for this record.
`ByteStreamer`	`getStreamer()`
`String`	`getStringVal()` Get the value of the record as a String.
`String`	`getStringVal(String encoding)` Get the value of the record as a String.
`WorkBook`	`getWorkBook()`
`Xf`	`getXfRec()`
`boolean`	`hasContinues()` returns whether this record has a CONTINUE record containing data beyond the 8228 byte record size limit.
`void`	`init()` perform record initialization
`boolean`	`isReadOnly()`
`boolean`	`isValueForCell()`
`void`	`postStream()` do any post-streaming cleanup such as expensive index updates or other deferrable processing.
`void`	`preStream()` do any pre-streaming processing such as expensive index updates or other deferrable processing.
`boolean`	`remove(boolean t)`
`void`	`removeContinues()` remove all Continue records
`void`	`setBooleanVal(boolean b)`
`void`	`setByteReader(BlockByteReader db)`
`void`	`setCol(short i)` set the column
`void`	`setData(byte[] b)`
`void`	`setDebugLevel(int b)` set the DEBUG level
`void`	`setDoubleVal(double v)`
`void`	`setEncryptedByteReader(BlockByteReader db)`
`void`	`setHyperlink(Hlink h)`
`void`	`setIndex(Index id)` associate this record with its Index record
`void`	`setIntVal(int v)`
`void`	`setIsValueForCell(boolean b)` set whether this record contains the value of the Cell.
`void`	`setIxfe(int xf)`
`void`	`setLength(int len)`
`void`	`setMergeRange(CellRange r)`
`void`	`setOffset(int pos)` Set the relative position within the data underlying the block vector represented by the BlockByteReader.
`void`	`setOpcode(short opcode)`
`void`	`setRow(Row r)`
`void`	`setRowCol(int[] x)`
`void`	`setRowNumber(int i)`
`void`	`setSheet(Sheet b)` Associate this record with a worksheet.
`void`	`setStreamer(ByteStreamer streamer)`
`void`	`setStringVal(String v)`
`void`	`setWorkBook(WorkBook wk)`
`void`	`setXFRecord()` set the XF (format) record for this rec
`void`	`setXFRecord(int i)` set the XF (format) record for this rec
`String`	`toHexDump()` Dumps this record as a human-readable string.

- Method Detail
  - getInternalVal
```
Object getInternalVal()
```
  - setHyperlink
```
void setHyperlink(Hlink h)
```
  - getHyperlink
```
Hlink getHyperlink()
```
  - getMergeRange
```
CellRange getMergeRange()
```
  - setMergeRange
```
void setMergeRange(CellRange r)
```
  - getRow
```
Row getRow()
```
  - getFormatPattern
```
String getFormatPattern()
```
  - copyFormat
```
void copyFormat(BiffRec source)
```
  - getFont
```
Font getFont()
```
  - getXfRec
```
Xf getXfRec()
```
  - remove
```
boolean remove(boolean t)
```
  - getFormulaRec
```
Formula getFormulaRec()
```
  - setRow
```
void setRow(Row r)
```
  - setRowNumber
```
void setRowNumber(int i)
```
  - setIxfe
```
void setIxfe(int xf)
```
  - getIntVal
```
int getIntVal()
```
  - getDblVal
```
double getDblVal()
```
  - getBooleanVal
```
boolean getBooleanVal()
```
  - isReadOnly
```
boolean isReadOnly()
```
  - setDebugLevel
```
void setDebugLevel(int b)
```
    set the DEBUG level
  - getRecordIndex
```
int getRecordIndex()
```
    return the record index of this object
  - addContinue
```
void addContinue(Continue c)
```
    adds a CONTINUE record to the array of CONTINUE records for this record, containing all data beyond the 8224 byte record size limit.
  - removeContinues
```
void removeContinues()
```
    remove all Continue records
  - getContinueVect
```
List getContinueVect()
```
    returns the array of CONTINUE records for this record, containing all data beyond the 8224 byte record size limit.
  - hasContinues
```
boolean hasContinues()
```
    returns whether this record has a CONTINUE record containing data beyond the 8228 byte record size limit. XLSRecords can have 0 or more CONTINUE records.
  - setIsValueForCell
```
void setIsValueForCell(boolean b)
```
    set whether this record contains the value of the Cell.
  - setIndex
```
void setIndex(Index id)
```
    associate this record with its Index record
  - setSheet
```
void setSheet(Sheet b)
```
    Associate this record with a worksheet. First checks to see if there is already a cell with this address.
  - getSheet
```
Boundsheet getSheet()
```
    get the WorkSheet for this record.
  - setWorkBook
```
void setWorkBook(WorkBook wk)
```
  - getWorkBook
```
WorkBook getWorkBook()
```
  - setCol
```
void setCol(short i)
```
    set the column
  - setRowCol
```
void setRowCol(int[] x)
```
  - getColNumber
```
short getColNumber()
```
  - getRowNumber
```
int getRowNumber()
```
  - getCellAddress
```
String getCellAddress()
```
    get a string address for the cell based on row and col ie: "H22"
  - init
```
void init()
```
    perform record initialization
  - getDefaultVal
```
Object getDefaultVal()
```
    get a default "empty" data value for this record
  - getDataType
```
String getDataType()
```
    get the data type name for this record
  - getFloatVal
```
float getFloatVal()
```
    Get the value of the record as a Float. Value must be parseable as an Float or it will throw a NumberFormatException.
  - getStringVal
```
String getStringVal()
```
    Get the value of the record as a String.
  - getStringVal
```
String getStringVal(String encoding)
```
    Get the value of the record as a String.
  - setStringVal
```
void setStringVal(String v)
```
  - setBooleanVal
```
void setBooleanVal(boolean b)
```
  - setIntVal
```
void setIntVal(int v)
```
  - setDoubleVal
```
void setDoubleVal(double v)
```
  - preStream
```
void preStream()
```
    do any pre-streaming processing such as expensive index updates or other deferrable processing.
  - postStream
```
void postStream()
```
    do any post-streaming cleanup such as expensive index updates or other deferrable processing.
  - setXFRecord
```
void setXFRecord()
```
    set the XF (format) record for this rec
  - setXFRecord
```
void setXFRecord(int i)
```
    set the XF (format) record for this rec
  - getIxfe
```
int getIxfe()
```
    get the ixfe
  - getOpcode
```
short getOpcode()
```
  - setOpcode
```
void setOpcode(short opcode)
```
  - getLength
```
int getLength()
```
    Returns the length of this record, including the 4 header bytes
  - setLength
```
void setLength(int len)
```
  - setByteReader
```
void setByteReader(BlockByteReader db)
```
  - getByteReader
```
BlockByteReader getByteReader()
```
  - setEncryptedByteReader
```
void setEncryptedByteReader(BlockByteReader db)
```
  - getEncryptedByteReader
```
BlockByteReader getEncryptedByteReader()
```
  - setData
```
void setData(byte[] b)
```
  - getBytes
```
byte[] getBytes()
```
    gets the full record bytes for this record including header bytes
    
    Returns:
    
    byte[] of all rec bytes
  - getData
```
byte[] getData()
```
    gets the record data merging any Continue record data.
  - getByteAt
```
byte getByteAt(int off)
```
    Gets the byte from the specified position in the record byte array.
    
    Parameters:
    
    off -
    
    Returns:
  - getBytesAt
```
byte[] getBytesAt(int off,
                  int len)
```
    Gets the byte from the specified position in the record byte array.
    
    Parameters:
    
    off -
    
    Returns:
  - setOffset
```
void setOffset(int pos)
```
    Set the relative position within the data underlying the block vector represented by the BlockByteReader. In other words, this is the relative position used by the BlockByteReader to offset the Consumer's read position within the collection of Data Blocks. This may be an offset relative to the data in a file, or within a Storage contained in a file. The Workbook Storage for example will contain a non-contiguous collection of Blocks containing data from any number of positions in a file. This collection forms a contiguous span of bytes comprising an XLS Workbook. The XLSRecords within this span of bytes will set their relative position within this 'virtual' array. Thus the XLSRecord positions are relative to the order of bytes contained in the Block collection. The BOF record then is at offset 0 within the data of the first Block, even though the underlying data of this first Block may be anywhere on disk.
    
    Parameters:
    
    pos -
  - getOffset
```
int getOffset()
```
    Get the relative position within the data underlying the block vector represented by the BlockByteReader.
    
    Returns:
    
    relative position
  - getStreamer
```
ByteStreamer getStreamer()
```
    Returns:
  - setStreamer
```
void setStreamer(ByteStreamer streamer)
```
    Parameters:
    
    streamer -
  - isValueForCell
```
boolean isValueForCell()
```
    Returns:
  - toHexDump
```
String toHexDump()
```
    Dumps this record as a human-readable string. This method's output is more verbose than that of #toString(). It generally includes a hex dump of the record's contents.

Interface BiffRec

Method Summary

Method Detail

getInternalVal

setHyperlink

getHyperlink

getMergeRange

setMergeRange

getRow

getFormatPattern

copyFormat

getFont

getXfRec

remove

getFormulaRec

setRow

setRowNumber

setIxfe

getIntVal

getDblVal

getBooleanVal

isReadOnly

setDebugLevel

getRecordIndex

addContinue

removeContinues

getContinueVect

hasContinues

setIsValueForCell

setIndex

setSheet

getSheet

setWorkBook

getWorkBook

setCol

setRowCol

getColNumber

getRowNumber

getCellAddress

init

getDefaultVal

getDataType

getFloatVal

getStringVal

getStringVal

setStringVal

setBooleanVal

setIntVal

setDoubleVal

preStream

postStream

setXFRecord

setXFRecord

getIxfe

getOpcode

setOpcode

getLength

setLength

setByteReader

getByteReader

setEncryptedByteReader

getEncryptedByteReader

setData

getBytes

getData

getByteAt

getBytesAt

setOffset

getOffset

getStreamer

setStreamer

isValueForCell

toHexDump