Row (OpenXLS Java Spreadsheet SDK 11.0.4 API)

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

All Implemented Interfaces:: BlockByteConsumer, BiffRec, XLSConstants, Serializable

public final class Row
extends XLSRecord

ROW 0x208: Describes a single row on a MS Excel Sheet.

offset name size contents --------------------------------------------------------------- 0 rw 2 Row number 2 colMic 2 First defined column in the row 4 colMac 2 Last defined column in the row plus 1 6 miyRw 2 Row Height in twips (1/20 of a printer's point, or 1/1440 of an inch) 14-0 7FFFH Height of the row, in twips 15 8000H 0 = Row has custom height; 1 = Row has default height 8 irwMac 2 Optimizing, set to 0 10 reserved 2 12 grBit 2 Option Flags 14 ixfe 2 Index to XF record for row grib options offset Bits mask name contents --------------------------------------------------------------- 2-0 07H outlineLevel Outline level of the row 4 10H fCollapsed 1 = Outline group starts or ends here (depending on where the outline buttons are located, see WSBOOL record and is fCollapsed 5 20H fHidden 1 = Row is fHidden (manually, or by a filter or outline group) 6 40H altered 1 = Row height and default font height do not match 7 80H fFormatted 1 = Row has explicit default format (fl) 8 100H Always 1 27-16 0FFF0000H If fl = 1: Index to default XF record 28 10000000H 1 = Additional space above the row. This flag is set, if the upper border of at least one cell in this row or if the lower border of at least one cell in the row above is formatted with a thick line style. Thin and medium line styles are not taken into account. 29 20000000H 1 = Additional space below the row. This flag is set, if the lower border of at least one cell in this row or if the upper border of at least one cell in the row below is formatted with a medium or thick line style. Thin line styles are not taken into account.

See Also:: WorkBook, BOUNDSHEET, INDEX, Dbcell, ROW, Cell, XLSRecord, Serialized Form

Field Summary
- Fields inherited from class io.starter.formats.XLS.XLSRecord
  col, continues, DEBUGLEVEL, hyperlink, idx, isBlank, isBoolean, isContinueMerged, isString, lastidx, myxf, offset, rw, streamer, wkbook, worksheet
- Fields inherited from interface io.starter.formats.XLS.XLSConstants
  AI, ALLOWDUPES, ALRUNS, AREA, AREAFORMAT, ARRAY, ATTACHEDLABEL, AUTOFILTER, AXCENT, AXESUSED, AXIS, AXISLINEFORMAT, AXISPARENT, BACKUP, BAR, BEGIN, BLANK, BOF, BOOKBOOL, BOOLERR, BOPPOP, BOPPOPCUSTOM, BOTTOM_MARGIN, BOTTOMMARGIN, BOUNDSHEET, CALC_MODE_PROP, CALCCOUNT, CALCMODE, CALCULATE_ALWAYS, CALCULATE_AUTO, CALCULATE_EXPLICIT, CATLAB, CATSERRANGE, CF, CF12, CHART, CHART3DBARSHAPE, CHARTFORMAT, CHARTFORMATLINK, CHARTFRTINFO, CHARTLINE, CODENAME, COLINFO, CONDFMT, CONDFMT12, CONTINUE, COUNTRY, CRN, CRTLAYOUT12, CRTLAYOUT12A, DAT, DATAFORMAT, DATALABEXT, DATALABEXTCONTENTS, DATE1904, DBCELL, DCON, DCONBIN, DCONNAME, DCONREF, DEBUG_HIGH, DEBUG_LOW, DEBUG_MEDIUM, DEFAULTENCODING, DEFAULTROWHEIGHT, DEFAULTTEXT, DEFCOLWIDTH, DELTA, DIMENSIONS, DROPBAR, DSF, DV, DVAL, END, ENDBLOCK, ENDEXTSST, ENDOBJECT, EOF, EXCEL2K, EXTERNCOUNT, EXTERNNAME, EXTERNSHEET, EXTSST, FBI, FEATHEADR, FILE_LOCK, FILEPASS, FONT, FONTBASIS, FONTX, FOOTERREC, FORMAT, FORMULA, FRAME, FRTFONTLIST, FRTWRAPPER, GARBAGE, GELFRAME, GUTS, HCENTER, HEADERREC, HLINK, HORIZONTAL_PAGE_BREAKS, IFMT, INDEX, INTERFACE_HDR, ITERATION, LABEL, LABELSST, LEFT_MARGIN, LEFTMARGIN, LEGEND, LEGENDXN, LINE, LINEFORMAT, MARKERFORMAT, MAXCOLS, MAXCOLS_BIFF8, MAXRECLEN, MAXROWS, MAXROWS_BIFF8, MERGEDCELLS, MSODRAWING, MSODRAWINGGROUP, MSODRAWINGSELECTION, MULBLANK, MULRK, NAME, NOTE, NUMBER, OBJ, OBJECTLINK, OBJPROTECT, OBPROJ, PALETTE, PANE, PASSWORD, PHONETIC, PICF, PIE, PIEFORMAT, PIVOTCHARTBITS, PIVOTCHARTLINK, PLOTAREA, PLOTGROWTH, PLS, PLV, POS, PRECISION, PRINT_GRIDLINES, PRINT_ROW_HEADERS, PRINTGRID, PRINTROWCOL, PROT4REV, PROTECT, QSISXTAG, RADAR, RADARAREA, RANGEPROTECTION, REFMODE, REFTRACK_PROP, RIGHT_MARGIN, RIGHTMARGIN, RK, ROW, RRD_HEAD, RRD_INFO, RSTRING, RTENTEXU, RTMERGECELLS, SBASEREF, SCATTER, SCENPROTECT, SCL, SELECTION, SERAUXERRBAR, SERAUXTREND, SERFMT, SERIES, SERIESLIST, SERIESTEXT, SERPARENT, SERTOCRT, SETUP, SHAREDUPES, SHEETLAYOUT, SHEETPROTECTION, SHRFMLA, SHTPROPS, SIIINDEX, SST, STARTBLOCK, STARTOBJECT, STRING_ENCODING_AUTO, STRING_ENCODING_COMPRESSED, STRING_ENCODING_UNICODE, STRINGREC, STYLE, SUPBOOK, SURFACE, SXADDL, SXBOOL, SXDB, SXDBB, SXDBEX, SXDI, SXEX, SXFDB, SXFDBTYPE, SXFORMAT, SXIVD, SXLI, SXNUM, SXPI, SXSTREAMID, SXSTRING, SXVD, SXVDEX, SXVI, SXVIEW, SXVIEWEX9, SXVIEWLINK, SXVS, TABID, TABLE, TABLESTYLES, TEXTDISP, THREED, TICK, TOP_MARGIN, TOPMARGIN, TXO, TYPE_BLANK, TYPE_BOOLEAN, TYPE_DOUBLE, TYPE_FORMULA, TYPE_FP, TYPE_INT, TYPE_STRING, UNICODEENCODING, UNITS, USERBVIEW, USERSVIEWBEGIN, USERSVIEWEND, USETEMPFILE_PROP, USR_EXCL, VALIDATEWORKBOOK, VALUERANGE, VB_MODULE, VCENTER, VERTICAL_PAGE_BREAKS, WINDOW_PROTECT, WINDOW1, WINDOW2, WK_CHART, WK_FILE, WK_GLOBALS, WK_MACROSHEET, WK_WORKSHEET, WSBOOL, XCT, XF, XLS_MAX_COLS, YMULT

Constructor Summary

Constructors
Constructor and Description

Row()

Row(int rowNum, WorkBook book)

Constructors
Constructor and Description
`Row()`
`Row(int rowNum, WorkBook book)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearHeight()`
`void`	`clearIxfe()` Removes the format currently applied to this row, if any.
`void`	`close()` clear out object references in prep for closing workbook
`BiffRec`	`getCell(short d)` Get a cell from the row
`Object[]`	`getCellArray()` get the cells as an array.
`Collection<BiffRec>`	`getCells()` get a collection of cells in column-based order *
`int[]`	`getColDimensions()` return the min/max column for this row
`boolean`	`getExplicitFormatSet()` This flag determines if the row has been formatted.
`boolean`	`getHasAnyBottomBorder()` Additional space below the row.
`boolean`	`getHasAnyThickTopBorder()` Additional space above the row.
`boolean`	`getHasThickBottomBorder()` returns true if there is a thick bottom border set on the row
`boolean`	`getHasThickTopBorder()` returns true if there is a thick bottom border set on the row
`int`	`getIxfe()` Gets the ID of the format currently applied to this row.
`int`	`getLastRecIndex()` iterate and get the record index of the last val record
`int`	`getNumberOfCells()`
`int`	`getOutlineLevel()` Returns the Outline level (depth) of the row
`int`	`getRowHeight()` Get the height of a row
`int`	`getRowNumber()` get the position of the ROW on the Worksheet
`List`	`getValRecs(int outputId)` Return an ordered array of the BiffRecs associated with this row.
`boolean`	`hasIxfe()` Returns whether a format has been set for this row.
`void`	`init()` perform record initialization
`boolean`	`isAlteredHeight()` true if row height has been altered from default i.e.
`boolean`	`isCollapsed()` Returns whether the row is collapsed
`boolean`	`isHidden()` Returns whether the row is hidden TODO: same issue as setHidden above!
`void`	`preStream()` do any pre-streaming processing such as expensive index updates or other deferrable processing.
`void`	`setCollapsed(boolean b)` Set whether the row is fCollapsed hides all contiguous rows with the same outline level
`void`	`setDBCell(Dbcell d)` set the Dbcell record which contains the cell offsets for this row.
`void`	`setHasAnyThickBottomBorder(boolean hasBorder)` flags this row to have at least one cell that has a thick bottom border For internal use only
`void`	`setHasAnyThickTopBorder(boolean hasBorder)` flags this row to have at least one cell that has a thick top border For internal use only
`void`	`setHasThickBottomBorder(boolean hasBorder)` sets this row to have a thick bottom border
`void`	`setHasThickTopBorder(boolean hasBorder)` sets this row to have a thick top border
`void`	`setHeight(int twips)`
`void`	`setHidden(boolean b)` Set whether the row is fHidden
`void`	`setIxfe(int ixfe)` Applies the format with the given ID to this row.
`void`	`setOutlineLevel(int x)` Set the Outline level (depth) of the row
`void`	`setRowHeight(int x)` Set the height of a row in twips (1/20th of a point)
`void`	`setRowNumber(int n)` set the position of the ROW on the Worksheet
`void`	`setUnsynched(boolean bUnsynced)` sets or clears the Unsynced flag The Unsynched flag is true if the row height is manually set If false, the row height should auto adjust when necessary
`String`	`toString()`
`void`	`updateColDimensions(short col)` update the col indexes

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, getLastBlock, getLength, getMergeRange, getOffset, getOpcode, getPrototype, getRealRecordIndex, getRecDesc, getRecordIndex, getRow, getSheet, getStreamer, getStringVal, getStringVal, getWorkBook, getXfRec, hasContinues, initRowCol, isFormula, isNumber, isReadOnly, isValueForCell, mergeContinues, postStream, remove, removeContinues, resetCacheBytes, setBooleanVal, setByteReader, setCol, setData, setDebugLevel, setDoubleVal, setEncryptedByteReader, setFirstBlock, setFloatVal, setHyperlink, setIndex, setIntVal, setIsValueForCell, setLastBlock, setLength, setMergeRange, setOffset, setOpcode, setRow, setRowCol, setSheet, setStreamer, setStringVal, setValueForCell, setWorkBook, setXFRecord, setXFRecord, shouldEncrypt, toHexDump

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

- Constructor Detail
  - Row
```
public Row()
```
  - Row
```
public Row(int rowNum,
           WorkBook book)
```
- Method Detail
  - close
```
public void close()
```
    clear out object references in prep for closing workbook
    
    Overrides:
    
    close in class XLSRecord
  - setRowHeight
```
public void setRowHeight(int x)
```
    Set the height of a row in twips (1/20th of a point)
  - getRowHeight
```
public int getRowHeight()
```
    Get the height of a row
  - setRowNumber
```
public void setRowNumber(int n)
```
    set the position of the ROW on the Worksheet
    
    Specified by:
    
    setRowNumber in interface BiffRec
    
    Overrides:
    
    setRowNumber in class XLSRecord
  - getRowNumber
```
public int getRowNumber()
```
    get the position of the ROW on the Worksheet
    
    Specified by:
    
    getRowNumber in interface BiffRec
    
    Overrides:
    
    getRowNumber in class XLSRecord
  - setDBCell
```
public void setDBCell(Dbcell d)
```
    set the Dbcell record which contains the cell offsets for this row. needed in computing new INDEX offset values
  - getCell
```
public BiffRec getCell(short d)
                throws CellNotFoundException
```
    Get a cell from the row
    
    Throws:
    
    CellNotFoundException
  - getCells
```
public Collection<BiffRec> getCells()
```
    get a collection of cells in column-based order *
  - getCellArray
```
public Object[] getCellArray()
```
    get the cells as an array. Needed when operations will be used on the cell array causing concurrentModificationException problems on the TreeMap collection
    
    Returns:
  - getNumberOfCells
```
public int getNumberOfCells()
```
  - getValRecs
```
public List getValRecs(int outputId)
```
    Return an ordered array of the BiffRecs associated with this row. This includes child records, and other non-cell-associated records that should be in the row block (such as Formula Shrfmlas and Arrays)
  - getLastRecIndex
```
public int getLastRecIndex()
```
    iterate and get the record index of the last val record
  - init
```
public void init()
```
    Description copied from class: XLSRecord
    
    perform record initialization
    
    Specified by:
    
    init in interface BiffRec
    
    Overrides:
    
    init in class XLSRecord
  - preStream
```
public void preStream()
```
    Description copied from class: XLSRecord
    
    do any pre-streaming processing such as expensive index updates or other deferrable processing.
    
    Specified by:
    
    preStream in interface BiffRec
    
    Overrides:
    
    preStream in class XLSRecord
  - setUnsynched
```
public void setUnsynched(boolean bUnsynced)
```
    sets or clears the Unsynced flag
    The Unsynched flag is true if the row height is manually set
    If false, the row height should auto adjust when necessary
    
    Parameters:
    
    bUnsynced -
  - getExplicitFormatSet
```
public boolean getExplicitFormatSet()
```
    This flag determines if the row has been formatted. If this flag is not set, the XF reference will not affect the row. However, if it's true then the row will be formatted according to the XF ref.
    
    Returns:
  - getColDimensions
```
public int[] getColDimensions()
```
    return the min/max column for this row
    
    Returns:
  - updateColDimensions
```
public void updateColDimensions(short col)
```
    update the col indexes
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class XLSRecord
  - setHeight
```
public void setHeight(int twips)
```
  - clearHeight
```
public void clearHeight()
```
  - setCollapsed
```
public void setCollapsed(boolean b)
```
    Set whether the row is fCollapsed hides all contiguous rows with the same outline level
    
    Parameters:
    
    b -
  - setHidden
```
public void setHidden(boolean b)
```
    Set whether the row is fHidden
    
    Parameters:
    
    b -
  - setOutlineLevel
```
public void setOutlineLevel(int x)
```
    Set the Outline level (depth) of the row
    
    Parameters:
    
    x -
  - getOutlineLevel
```
public int getOutlineLevel()
```
    Returns the Outline level (depth) of the row
    
    Returns:
  - isCollapsed
```
public boolean isCollapsed()
```
    Returns whether the row is collapsed
    
    Returns:
  - isHidden
```
public boolean isHidden()
```
    Returns whether the row is hidden TODO: same issue as setHidden above!
    
    Returns:
  - isAlteredHeight
```
public boolean isAlteredHeight()
```
    true if row height has been altered from default i.e. set manually
    
    Returns:
  - setIxfe
```
public void setIxfe(int ixfe)
```
    Applies the format with the given ID to this row.
    
    Specified by:
    
    setIxfe in interface BiffRec
    
    Overrides:
    
    setIxfe in class XLSRecord
    
    Parameters:
    
    ixfe - the format ID. Must be between 0x0 and 0xFFF.
    
    Throws:
    
    IllegalArgumentException - if the given format ID cannot be encoded in the 1.5 byte wide field provided for it
  - clearIxfe
```
public void clearIxfe()
```
    Removes the format currently applied to this row, if any.
  - getIxfe
```
public int getIxfe()
```
    Gets the ID of the format currently applied to this row.
    
    Specified by:
    
    getIxfe in interface BiffRec
    
    Overrides:
    
    getIxfe in class XLSRecord
    
    Returns:
    
    the ID of the current format, or the default format ID if no format has been applied
  - hasIxfe
```
public boolean hasIxfe()
```
    Returns whether a format has been set for this row.
  - getHasThickTopBorder
```
public boolean getHasThickTopBorder()
```
    returns true if there is a thick bottom border set on the row
  - getHasAnyThickTopBorder
```
public boolean getHasAnyThickTopBorder()
```
    Additional space above the row. This flag is set, if the upper border of at least one cell in this row or if the lower border of at least one cell in the row above is formatted with a thick line style. Thin and medium line styles are not taken into account.
  - getHasThickBottomBorder
```
public boolean getHasThickBottomBorder()
```
    returns true if there is a thick bottom border set on the row
  - getHasAnyBottomBorder
```
public boolean getHasAnyBottomBorder()
```
    Additional space below the row. This flag is set, if the lower border of at least one cell in this row or if the upper border of at least one cell in the row below is formatted with a medium or thick line style. Thin line styles are not taken into account.
  - setHasThickTopBorder
```
public void setHasThickTopBorder(boolean hasBorder)
```
    sets this row to have a thick top border
  - setHasThickBottomBorder
```
public void setHasThickBottomBorder(boolean hasBorder)
```
    sets this row to have a thick bottom border
  - setHasAnyThickTopBorder
```
public void setHasAnyThickTopBorder(boolean hasBorder)
```
    flags this row to have at least one cell that has a thick top border For internal use only
    
    Parameters:
    
    hasBorder -
  - setHasAnyThickBottomBorder
```
public void setHasAnyThickBottomBorder(boolean hasBorder)
```
    flags this row to have at least one cell that has a thick bottom border For internal use only
    
    Parameters:
    
    hasBorder -

Class Row

Field Summary

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

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

Constructor Detail

Row

Row

Method Detail

close

setRowHeight

getRowHeight

setRowNumber

getRowNumber

setDBCell

getCell

getCells

getCellArray

getNumberOfCells

getValRecs

getLastRecIndex

init

preStream

setUnsynched

getExplicitFormatSet

getColDimensions

updateColDimensions

toString

setHeight

clearHeight

setCollapsed

setHidden

setOutlineLevel

getOutlineLevel

isCollapsed

isHidden

isAlteredHeight

setIxfe

clearIxfe

getIxfe

hasIxfe

getHasThickTopBorder

getHasAnyThickTopBorder

getHasThickBottomBorder

getHasAnyBottomBorder

setHasThickTopBorder

setHasThickBottomBorder

setHasAnyThickTopBorder

setHasAnyThickBottomBorder