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: HSSFSheet [javadoc | source]
java.lang.Object
   org.apache.cocoon.poi.hssf.usermodel.HSSFSheet
High level representation of a worksheet.
Field Summary
public static final  int INITIAL_CAPACITY    Used for compile-time optimization. This is the initial size for the collection of rows. It is currently set to 20. If you generate larger sheets you may benefit by setting this to a higher number and recompiling a custom edition of HSSFSheet. 
Constructor:
 protected HSSFSheet(Workbook book) 
    Creates new HSSFSheet - called by HSSFWorkbook to create a sheet from scratch. You should not be calling this from application code (its protected anyhow).
    Parameters:
    book - - lowlevel Workbook object associated with the sheet.
    Also see:
    org.apache.cocoon.poi.hssf.usermodel.HSSFWorkbook#createSheet()
 protected HSSFSheet(Workbook book,
    Sheet sheet) 
    Creates an HSSFSheet representing the given Sheet object. Should only be called by HSSFWorkbook when reading in an exisiting file.
    Parameters:
    book - - lowlevel Workbook object associated with the sheet.
    sheet - - lowlevel Sheet object this sheet will represent
    Also see:
    org.apache.cocoon.poi.hssf.usermodel.HSSFWorkbook#createSheet()
Method from org.apache.cocoon.poi.hssf.usermodel.HSSFSheet Summary:
createRow,   getColumnWidth,   getDefaultColumnWidth,   getDefaultRowHeight,   getDefaultRowHeightInPoints,   getFirstRowNum,   getLastRowNum,   getPhysicalNumberOfRows,   getPhysicalRowAt,   getRow,   getRows,   getSheet,   removeRow,   setColumnWidth,   setDefaultColumnWidth,   setDefaultRowHeight,   setDefaultRowHeightInPoints
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.cocoon.poi.hssf.usermodel.HSSFSheet Detail:
 public HSSFRow createRow(short rownum) 
    Create a new row within the sheet and return the high level representation
 public short getColumnWidth(short column) 
    get the width (in units of 1/256th of a character width )
 public short getDefaultColumnWidth() 
    get the default column width for the sheet (if the columns do not define their own width) in characters
 public short getDefaultRowHeight() 
    get the default row height for the sheet (if the rows do not define their own height) in twips (1/20 of a point)
 public float getDefaultRowHeightInPoints() 
    get the default row height for the sheet (if the rows do not define their own height) in points.
 public int getFirstRowNum() 
    gets the first row on the sheet
 public int getLastRowNum() 
    gets the last row on the sheet
 public int getPhysicalNumberOfRows() 
    Returns the number of phsyically defined rows (NOT the number of rows in the sheet)
 public HSSFRow getPhysicalRowAt(int rownum) 
    Returns the row physically defined at (rownum). NOT the location on the sheet. This is to say the row physically defined at location 5 might actually be 50 if rows 0,2,25,30,40,50, 55 were the only rows on the sheet.
 public HSSFRow getRow(int rownum) 
    Returns the logical row (not physical) 0-based. If you ask for a row that is not defined you get a null. This is to say row 4 represents the fifth row on a sheet.
 public List getRows() 
    get a List of the rows in this sheet.
 protected Sheet getSheet() 
    used internally in the API to get the low level Sheet record represented by this Object.
 public  void removeRow(HSSFRow row) 
    Remove a row from this sheet. All cells contained in the row are removed as well
 public  void setColumnWidth(short column,
    short width) 
    set the width (in units of 1/256th of a character width)
 public  void setDefaultColumnWidth(short width) 
    set the default column width for the sheet (if the columns do not define their own width) in characters
 public  void setDefaultRowHeight(short height) 
    set the default row height for the sheet (if the rows do not define their own height) in twips (1/20 of a point)
 public  void setDefaultRowHeightInPoints(float height) 
    set the default row height for the sheet (if the rows do not define their own height) in points