|
| |
|
| java.lang.Object
 org.apache.poi.hssf.usermodel.HSSFRow
| HSSFRow | | public class HSSFRow implements Comparable(Code) | | High level representation of a row of a spreadsheet.
Only rows that have cells should be added to a Sheet.
version:
1.0-pre
author:
Andrew C. Oliver (acoliver at apache dot org)
author:
Glen Stampoultzis (glens at apache.org) |
| INITIAL_CAPACITY | | final public static int INITIAL_CAPACITY(Code) | | |
| HSSFRow | | protected HSSFRow()(Code) | | |
| HSSFRow | | protected HSSFRow(Workbook book, Sheet sheet, int rowNum)(Code) | | Creates new HSSFRow from scratch. Only HSSFSheet should do this.
Parameters:
book - low-level Workbook object containing the sheet that contains this row
Parameters:
sheet - low-level Sheet object that contains this Row
Parameters:
rowNum - the row number of this row (0 based)
See Also: org.apache.poi.hssf.usermodel.HSSFSheet.createRow(int) |
| HSSFRow | | protected HSSFRow(Workbook book, Sheet sheet, RowRecord record)(Code) | | Creates an HSSFRow from a low level RowRecord object. Only HSSFSheet should do
this. HSSFSheet uses this when an existing file is read in.
Parameters:
book - low-level Workbook object containing the sheet that contains this row
Parameters:
sheet - low-level Sheet object that contains this Row
Parameters:
record - the low level api object this row should represent
See Also: org.apache.poi.hssf.usermodel.HSSFSheet.createRow(int) |
| cellIterator | | public Iterator cellIterator()(Code) | | cell iterator of the physically defined cells. Note element 4 mayactually be row cell depending on how many are defined! |
| createCell | | public HSSFCell createCell(short column)(Code) | | Use this to create new cells within the row and return it.
The cell that is returned is a CELL_TYPE_BLANK. The type can be changed
either through calling setCellValue or setCellType.
Parameters:
column - - the column number this cell represents HSSFCell a high level representation of the created cell. |
| createCell | | public HSSFCell createCell(short column, int type)(Code) | | Use this to create new cells within the row and return it.
The cell that is returned is a CELL_TYPE_BLANK. The type can be changed
either through calling setCellValue or setCellType.
Parameters:
column - - the column number this cell represents HSSFCell a high level representation of the created cell. |
| createCellFromRecord | | protected HSSFCell createCellFromRecord(CellValueRecordInterface cell)(Code) | | create a high level HSSFCell object from an existing low level record. Should
only be called from HSSFSheet or HSSFRow itself.
Parameters:
cell - low level cell to create the high level representation from HSSFCell representing the low level record passed in |
| getCell | | public HSSFCell getCell(short cellnum)(Code) | | get the hssfcell representing a given column (logical cell) 0-based. If you
ask for a cell that is not defined....you get a null.
Parameters:
cellnum - 0 based column number HSSFCell representing that column or null if undefined. |
| getFirstCellNum | | public short getFirstCellNum()(Code) | | get the number of the first cell contained in this row.
short representing the first logical cell in the row, or -1 if the row does not contain any cells. |
| getHeight | | public short getHeight()(Code) | | get the row's height or ff (-1) for undefined/default-height in twips (1/20th of a point)
rowheight or 0xff for undefined (use sheet default) |
| getHeightInPoints | | public float getHeightInPoints()(Code) | | get the row's height or ff (-1) for undefined/default-height in points (20*getHeight())
rowheight or 0xff for undefined (use sheet default) |
| getLastCellNum | | public short getLastCellNum()(Code) | | gets the number of the last cell contained in this row PLUS ONE.
short representing the last logical cell in the row PLUS ONE, or -1 if the row does not contain any cells. |
| getPhysicalNumberOfCells | | public int getPhysicalNumberOfCells()(Code) | | gets the number of defined cells (NOT number of cells in the actual row!).
That is to say if only columns 0,4,5 have values then there would be 3.
int representing the number of defined cells in the row. |
| getRowNum | | public int getRowNum()(Code) | | get row number this row represents
the row number (0 based) |
| getRowRecord | | protected RowRecord getRowRecord()(Code) | | get the lowlevel RowRecord represented by this object - should only be called
by other parts of the high level API
RowRecord this row represents |
| getZeroHeight | | public boolean getZeroHeight()(Code) | | get whether or not to display this row with 0 height
- zHeight height is zero or not. |
| removeCell | | public void removeCell(HSSFCell cell)(Code) | | remove the HSSFCell from this row.
Parameters:
cell - to remove |
| setHeight | | public void setHeight(short height)(Code) | | set the row's height or set to ff (-1) for undefined/default-height. Set the height in "twips" or
1/20th of a point.
Parameters:
height - rowheight or 0xff for undefined (use sheet default) |
| setHeightInPoints | | public void setHeightInPoints(float height)(Code) | | set the row's height in points.
Parameters:
height - row height in points |
| setRowNum | | public void setRowNum(int rowNum)(Code) | | set the row number of this row.
Parameters:
rowNum - the row number (0-based)
throws:
IndexOutOfBoundsException - if the row number is not within the range 0-65535. |
| setZeroHeight | | public void setZeroHeight(boolean zHeight)(Code) | | set whether or not to display this row with 0 height
Parameters:
zHeight - height is zero or not. |
|
|
|