|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.hssf.usermodel.HSSFRow
public final class HSSFRow
High level representation of a row of a spreadsheet. Only rows that have cells should be added to a Sheet.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.apache.poi.ss.usermodel.Row |
---|
org.apache.poi.ss.usermodel.Row.MissingCellPolicy |
Field Summary | |
---|---|
static int |
INITIAL_CAPACITY
|
Fields inherited from interface org.apache.poi.ss.usermodel.Row |
---|
CREATE_NULL_AS_BLANK, RETURN_BLANK_AS_NULL, RETURN_NULL_AND_BLANK |
Method Summary | |
---|---|
java.util.Iterator |
cellIterator()
|
int |
compareTo(java.lang.Object obj)
|
HSSFCell |
createCell(int column)
Use this to create new cells within the row and return it. |
HSSFCell |
createCell(int columnIndex,
int type)
Use this to create new cells within the row and return it. |
HSSFCell |
createCell(short columnIndex)
Deprecated. (Aug 2008) use createCell(int) |
HSSFCell |
createCell(short columnIndex,
int type)
Deprecated. (Aug 2008) use createCell(int, int) |
protected HSSFCell |
createCellFromRecord(CellValueRecordInterface cell)
create a high level HSSFCell object from an existing low level record. |
boolean |
equals(java.lang.Object obj)
|
HSSFCell |
getCell(int cellnum)
Get the hssfcell representing a given column (logical cell) 0-based. |
HSSFCell |
getCell(int cellnum,
org.apache.poi.ss.usermodel.Row.MissingCellPolicy policy)
Get the hssfcell representing a given column (logical cell) 0-based. |
HSSFCell |
getCell(short cellnum)
Deprecated. (Aug 2008) use getCell(int) |
short |
getFirstCellNum()
get the number of the first cell contained in this row. |
short |
getHeight()
get the row's height or ff (-1) for undefined/default-height in twips (1/20th of a point) |
float |
getHeightInPoints()
get the row's height or ff (-1) for undefined/default-height in points (20*getHeight()) |
short |
getLastCellNum()
Gets the index of the last cell contained in this row PLUS ONE. |
protected 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 |
protected RowRecord |
getRowRecord()
get the lowlevel RowRecord represented by this object - should only be called by other parts of the high level API |
boolean |
getZeroHeight()
get whether or not to display this row with 0 height |
java.util.Iterator |
iterator()
Alias for cellIterator() to allow
foreach loops |
void |
moveCell(HSSFCell cell,
short newColumn)
Moves the supplied cell to a new column, which must not already have a cell there! |
protected void |
removeAllCells()
Removes all the cells from the row, and their records too. |
void |
removeCell(org.apache.poi.ss.usermodel.Cell cell)
remove the HSSFCell from this row. |
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 |
setRowNum(int rowNum)
set the row number of this row. |
void |
setZeroHeight(boolean zHeight)
set whether or not to display this row with 0 height |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int INITIAL_CAPACITY
Method Detail |
---|
public HSSFCell createCell(short columnIndex)
createCell(int)
createCell
in interface org.apache.poi.ss.usermodel.Row
public HSSFCell createCell(short columnIndex, int type)
createCell(int, int)
public HSSFCell createCell(int column)
The cell that is returned is a CELL_TYPE_BLANK. The type can be changed
either through calling setCellValue
or setCellType
.
createCell
in interface org.apache.poi.ss.usermodel.Row
column
- - the column number this cell represents
public HSSFCell createCell(int columnIndex, int type)
The cell that is returned is a CELL_TYPE_BLANK. The type can be changed either through calling setCellValue or setCellType.
createCell
in interface org.apache.poi.ss.usermodel.Row
columnIndex
- - the column number this cell represents
public void removeCell(org.apache.poi.ss.usermodel.Cell cell)
removeCell
in interface org.apache.poi.ss.usermodel.Row
cell
- to removeprotected void removeAllCells()
protected HSSFCell createCellFromRecord(CellValueRecordInterface cell)
cell
- low level cell to create the high level representation from
public void setRowNum(int rowNum)
setRowNum
in interface org.apache.poi.ss.usermodel.Row
rowNum
- the row number (0-based)
java.lang.IndexOutOfBoundsException
- if the row number is not within the range 0-65535.public int getRowNum()
getRowNum
in interface org.apache.poi.ss.usermodel.Row
protected int getOutlineLevel()
public void moveCell(HSSFCell cell, short newColumn)
cell
- The cell to movenewColumn
- The new column number (0 based)public HSSFCell getCell(short cellnum)
getCell(int)
public HSSFCell getCell(int cellnum)
MissingCellPolicy
on the base workbook.
getCell
in interface org.apache.poi.ss.usermodel.Row
cellnum
- 0 based column number
public HSSFCell getCell(int cellnum, org.apache.poi.ss.usermodel.Row.MissingCellPolicy policy)
getCell
in interface org.apache.poi.ss.usermodel.Row
cellnum
- 0 based column numberpolicy
- Policy on blank / missing cells
public short getFirstCellNum()
getFirstCellNum
in interface org.apache.poi.ss.usermodel.Row
public short getLastCellNum()
short minColIx = row.getFirstCellNum(); short maxColIx = row.getLastCellNum(); for(short colIx=minColIx; colIx<maxColIx; colIx++) { HSSFCell cell = row.getCell(colIx); if(cell == null) { continue; } //... do something with cell }
getLastCellNum
in interface org.apache.poi.ss.usermodel.Row
public int getPhysicalNumberOfCells()
getPhysicalNumberOfCells
in interface org.apache.poi.ss.usermodel.Row
public void setHeight(short height)
setHeight
in interface org.apache.poi.ss.usermodel.Row
height
- rowheight or 0xff for undefined (use sheet default)public void setZeroHeight(boolean zHeight)
setZeroHeight
in interface org.apache.poi.ss.usermodel.Row
zHeight
- height is zero or not.public boolean getZeroHeight()
getZeroHeight
in interface org.apache.poi.ss.usermodel.Row
public void setHeightInPoints(float height)
setHeightInPoints
in interface org.apache.poi.ss.usermodel.Row
height
- row height in pointspublic short getHeight()
getHeight
in interface org.apache.poi.ss.usermodel.Row
public float getHeightInPoints()
getHeightInPoints
in interface org.apache.poi.ss.usermodel.Row
protected RowRecord getRowRecord()
public java.util.Iterator cellIterator()
cellIterator
in interface org.apache.poi.ss.usermodel.Row
MissingCellPolicy
has no effect.public java.util.Iterator iterator()
cellIterator()
to allow
foreach loops
iterator
in interface java.lang.Iterable<org.apache.poi.ss.usermodel.Cell>
iterator
in interface org.apache.poi.ss.usermodel.Row
public int compareTo(java.lang.Object obj)
compareTo
in interface java.lang.Comparable
compareTo
in interface org.apache.poi.ss.usermodel.Row
public boolean equals(java.lang.Object obj)
equals
in interface org.apache.poi.ss.usermodel.Row
equals
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |