Save This Page
Home » cocoon-2.1.11-src » org.apache.cocoon.poi » hssf » usermodel » [javadoc | source]
org.apache.cocoon.poi.hssf.usermodel
public class: HSSFRow [javadoc | source]
java.lang.Object
   org.apache.cocoon.poi.hssf.usermodel.HSSFRow
High level representation of a row of a spreadsheet. Only rows that have cells should be added to a Sheet.
Field Summary
public static final  int INITIAL_CAPACITY     
Constructor:
 protected HSSFRow(Workbook book,
    Sheet sheet,
    short rowNum) 
    Creates new HSSFRow from scratch. Only HSSFSheet should do this.
    Parameters:
    book - low-level Workbook object containing the sheet that contains this row
    sheet - low-level Sheet object that contains this Row
    rowNum - the row number of this row (0 based)
    Also see:
    org.apache.cocoon.poi.hssf.usermodel.HSSFSheet#createRow(short)
 protected HSSFRow(Workbook book,
    Sheet sheet,
    RowRecord record) 
    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
    sheet - low-level Sheet object that contains this Row
    RowRecord - - the low level api object this row should represent
    Also see:
    org.apache.cocoon.poi.hssf.usermodel.HSSFSheet#createRow(short)
Method from org.apache.cocoon.poi.hssf.usermodel.HSSFRow Summary:
createCell,   createCellFromRecord,   getCell,   getCells,   getFirstCellNum,   getHeight,   getHeightInPoints,   getLastCellNum,   getPhysicalCellAt,   getPhysicalNumberOfCells,   getRowNum,   getRowRecord,   removeCell,   setHeight,   setHeightInPoints,   setRowNum
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.cocoon.poi.hssf.usermodel.HSSFRow Detail:
 public HSSFCell createCell(short column,
    int type) 
    Use this to create new cells within the row and return it.
 protected HSSFCell createCellFromRecord(CellValueRecordInterface cell) 
    create a high level HSSFCell object from an existing low level record. Should only be called from HSSFSheet or HSSFRow itself.
 public HSSFCell getCell(short cellnum) 
    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.
 public List getCells() 
    gets a list of cells in the row.
 public short getFirstCellNum() 
    get the number of the first cell contained in this row.
 public short getHeight() 
    get the row's height or ff (-1) for undefined/default-height in twips (1/20th of a point)
 public float getHeightInPoints() 
    get the row's height or ff (-1) for undefined/default-height in points (20*getHeight())
 public short getLastCellNum() 
    get the number of the last cell contained in this row.
 public HSSFCell getPhysicalCellAt(int num) 
    gets the phsyically defined cell at location (num) NOT its column number. That is to say if only columns 0,4,5 have values then index 2 would equal cell with a column number of 4. (though the order is not assured)
 public int getPhysicalNumberOfCells() 
    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.
 public short 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
 public  void removeCell(HSSFCell cell) 
    remove the HSSFCell from this row.
 public  void setHeight(short height) 
    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.
 public  void setHeightInPoints(float height) 
    set the row's height in points.
 public  void setRowNum(short rowNum) 
    set the row number of this row.