Modifier and Type | Class | Description |
---|---|---|
class |
SXSSFRow.CellIterator |
returns all cells including empty cells in which case "null" is returned
|
class |
SXSSFRow.FilledCellIterator |
returns all filled cells (created via Row.createCell())
|
Row.MissingCellPolicy
CREATE_NULL_AS_BLANK, RETURN_BLANK_AS_NULL, RETURN_NULL_AND_BLANK
Constructor | Description |
---|---|
SXSSFRow(SXSSFSheet sheet,
int initialSize) |
Modifier and Type | Method | Description |
---|---|---|
java.util.Iterator<Cell> |
allCellsIterator() |
|
java.util.Iterator<Cell> |
cellIterator() |
|
Cell |
createCell(int column) |
Use this to create new cells within the row and return it.
|
Cell |
createCell(int column,
int type) |
Use this to create new cells within the row and return it.
|
Cell |
getCell(int cellnum) |
Get the cell representing a given column (logical cell) 0-based.
|
Cell |
getCell(int cellnum,
Row.MissingCellPolicy policy) |
Returns the cell at the given (0 based) index, with the specified
Row.MissingCellPolicy |
java.lang.Boolean |
getCollapsed() |
|
short |
getFirstCellNum() |
Get the number of the first cell contained in this row.
|
short |
getHeight() |
Get the row's height measured in twips (1/20th of a point).
|
float |
getHeightInPoints() |
Returns row height measured in point size.
|
java.lang.Boolean |
getHidden() |
|
short |
getLastCellNum() |
Gets the index of the last cell contained in this row PLUS ONE.
|
int |
getOutlineLevel() |
Returns the rows outline level.
|
int |
getPhysicalNumberOfCells() |
Gets the number of defined cells (NOT number of cells in the actual row!).
|
int |
getRowNum() |
Get row number this row represents
|
CellStyle |
getRowStyle() |
Returns the whole-row cell style.
|
Sheet |
getSheet() |
Returns the Sheet this row belongs to
|
boolean |
getZeroHeight() |
Get whether or not to display this row with 0 height
|
boolean |
hasCustomHeight() |
|
boolean |
isFormatted() |
Is this row formatted? Most aren't, but some rows
do have whole-row styles.
|
java.util.Iterator<Cell> |
iterator() |
|
void |
removeCell(Cell cell) |
Remove the Cell from this row.
|
void |
setCollapsed(java.lang.Boolean collapsed) |
|
void |
setHeight(short height) |
Set the row's height or set to ff (-1) for undefined/default-height.
|
void |
setHeightInPoints(float height) |
Set the row's height in points.
|
void |
setHidden(java.lang.Boolean hidden) |
|
void |
setRowNum(int rowNum) |
Set the row number of this row.
|
void |
setRowStyle(CellStyle style) |
Applies a whole-row cell styling to the row.
|
void |
setZeroHeight(boolean zHeight) |
Set whether or not to display this row with 0 height
|
public SXSSFRow(SXSSFSheet sheet, int initialSize)
public java.util.Iterator<Cell> allCellsIterator()
public boolean hasCustomHeight()
public int getOutlineLevel()
Row
getOutlineLevel
in interface Row
public java.lang.Boolean getHidden()
public void setHidden(java.lang.Boolean hidden)
public java.lang.Boolean getCollapsed()
public void setCollapsed(java.lang.Boolean collapsed)
public java.util.Iterator<Cell> iterator()
iterator
in interface java.lang.Iterable<Cell>
public Cell createCell(int column)
The cell that is returned is a Cell.CELL_TYPE_BLANK
. The type can be changed
either through calling setCellValue
or setCellType
.
createCell
in interface Row
column
- - the column number this cell representsjava.lang.IllegalArgumentException
- if columnIndex < 0 or greater than the maximum number of supported columns
(255 for *.xls, 1048576 for *.xlsx)public Cell createCell(int column, int type)
The cell that is returned is a Cell.CELL_TYPE_BLANK
. The type can be changed
either through calling setCellValue or setCellType.
createCell
in interface Row
column
- - the column number this cell representstype
- - the cell's data typejava.lang.IllegalArgumentException
- if columnIndex < 0 or greate than a maximum number of supported columns
(255 for *.xls, 1048576 for *.xlsx)Cell.CELL_TYPE_BLANK
,
Cell.CELL_TYPE_BOOLEAN
,
Cell.CELL_TYPE_ERROR
,
Cell.CELL_TYPE_FORMULA
,
Cell.CELL_TYPE_NUMERIC
,
Cell.CELL_TYPE_STRING
public void removeCell(Cell cell)
removeCell
in interface Row
cell
- the cell to removepublic void setRowNum(int rowNum)
public int getRowNum()
public Cell getCell(int cellnum)
getCell
in interface Row
cellnum
- 0 based column numbergetCell(int, org.apache.poi.ss.usermodel.Row.MissingCellPolicy)
public Cell getCell(int cellnum, Row.MissingCellPolicy policy)
Row.MissingCellPolicy
getCell
in interface Row
java.lang.IllegalArgumentException
- if cellnum < 0 or the specified MissingCellPolicy is invalidRow.RETURN_NULL_AND_BLANK
,
Row.RETURN_BLANK_AS_NULL
,
Row.CREATE_NULL_AS_BLANK
public short getFirstCellNum()
getFirstCellNum
in interface Row
public short getLastCellNum()
short minColIx = row.getFirstCellNum(); short maxColIx = row.getLastCellNum(); for(short colIx=minColIx; colIx<maxColIx; colIx++) { Cell cell = row.getCell(colIx); if(cell == null) { continue; } //... do something with cell }
getLastCellNum
in interface Row
public int getPhysicalNumberOfCells()
getPhysicalNumberOfCells
in interface Row
public void setHeight(short height)
public void setZeroHeight(boolean zHeight)
setZeroHeight
in interface Row
zHeight
- height is zero or not.public boolean getZeroHeight()
getZeroHeight
in interface Row
public void setHeightInPoints(float height)
setHeightInPoints
in interface Row
height
- the height in points. -1
resets to the default heightpublic short getHeight()
Sheet.getDefaultRowHeightInPoints()
public float getHeightInPoints()
Sheet.getDefaultRowHeightInPoints()
getHeightInPoints
in interface Row
Sheet.getDefaultRowHeightInPoints()
public boolean isFormatted()
getRowStyle()
isFormatted
in interface Row
public CellStyle getRowStyle()
isFormatted()
to check first.getRowStyle
in interface Row
public void setRowStyle(CellStyle style)
setRowStyle
in interface Row
public java.util.Iterator<Cell> cellIterator()
cellIterator
in interface Row
Copyright 2018 The Apache Software Foundation or its licensors, as applicable.