| java.lang.Object
 org.apache.poi.hssf.usermodel.HSSFCell
| HSSFCell | | public class HSSFCell (Code) | | High level representation of a cell in a row of a spreadsheet.
Cells can be numeric, formula-based or string-based (text). The cell type
specifies this. String cells cannot conatin numbers and numeric cells cannot
contain strings (at least according to our model). Client apps should do the
conversions themselves. Formula cells have the formula string, as well as
the formula result, which can be numeric or string.
Cells should have their number (0 based) before being added to a row. Only
cells that have values should be added.
author:
Andrew C. Oliver (acoliver at apache dot org)
author:
Dan Sherman (dsherman at isisph.com)
author:
Brian Sanders (kestrel at burdell dot org) Active Cell support
author:
Yegor Kozlov cell comments support
version:
1.0-pre |
| Constructor Summary | |
| protected | HSSFCell(Workbook book, Sheet sheet, int row, short col)
Creates new Cell - Should only be called by HSSFRow. | | protected | HSSFCell(Workbook book, Sheet sheet, int row, short col, int type)
Creates new Cell - Should only be called by HSSFRow. | | protected | HSSFCell(Workbook book, Sheet sheet, int row, CellValueRecordInterface cval)
Creates an HSSFCell from a CellValueRecordInterface. |
| ENCODING_COMPRESSED_UNICODE | | final public static short ENCODING_COMPRESSED_UNICODE(Code) | | |
| ENCODING_UNCHANGED | | final public static short ENCODING_UNCHANGED(Code) | | |
| ENCODING_UTF_16 | | final public static short ENCODING_UTF_16(Code) | | |
| HSSFCell | | protected HSSFCell(Workbook book, Sheet sheet, int row, short col)(Code) | | Creates new Cell - Should only be called by HSSFRow. This creates a cell
from scratch.
When the cell is initially created it is set to CELL_TYPE_BLANK. Cell types
can be changed/overwritten by calling setCellValue with the appropriate
type as a parameter although conversions from one type to another may be
prohibited.
Parameters:
book - - Workbook record of the workbook containing this cell
Parameters:
sheet - - Sheet record of the sheet containing this cell
Parameters:
row - - the row of this cell
Parameters:
col - - the column for this cell
See Also: org.apache.poi.hssf.usermodel.HSSFRow.createCell(short) |
| HSSFCell | | protected HSSFCell(Workbook book, Sheet sheet, int row, short col, int type)(Code) | | Creates new Cell - Should only be called by HSSFRow. This creates a cell
from scratch.
Parameters:
book - - Workbook record of the workbook containing this cell
Parameters:
sheet - - Sheet record of the sheet containing this cell
Parameters:
row - - the row of this cell
Parameters:
col - - the column for this cell
Parameters:
type - - CELL_TYPE_NUMERIC, CELL_TYPE_STRING, CELL_TYPE_FORMULA, CELL_TYPE_BLANK,CELL_TYPE_BOOLEAN, CELL_TYPE_ERRORType of cell
See Also: org.apache.poi.hssf.usermodel.HSSFRow.createCell(shortint) |
| HSSFCell | | protected HSSFCell(Workbook book, Sheet sheet, int row, CellValueRecordInterface cval)(Code) | | Creates an HSSFCell from a CellValueRecordInterface. HSSFSheet uses this when
reading in cells from an existing sheet.
Parameters:
book - - Workbook record of the workbook containing this cell
Parameters:
sheet - - Sheet record of the sheet containing this cell
Parameters:
cval - - the Cell Value Record we wish to represent |
| findCellComment | | protected static HSSFComment findCellComment(Sheet sheet, int row, int column)(Code) | | Cell comment finder.
Returns cell comment for the specified sheet, row and column.
cell comment or null if not found |
| getBooleanCellValue | | public boolean getBooleanCellValue()(Code) | | get the value of the cell as a boolean. For strings, numbers, and errors, we throw an exception.
For blank cells we return a false.
|
| getBoundWorkbook | | protected Workbook getBoundWorkbook()(Code) | | Returns the Workbook that this Cell is bound to
|
| getCellComment | | public HSSFComment getCellComment()(Code) | | Returns comment associated with this cell
comment associated with this cell |
| getCellNum | | public short getCellNum()(Code) | | get the cell's number within the row
short reperesenting the column number (logical!) |
| getCellValueRecord | | protected CellValueRecordInterface getCellValueRecord()(Code) | | Should only be used by HSSFSheet and friends. Returns the low level CellValueRecordInterface record
CellValueRecordInterface representing the cell via the low level api. |
| getDateCellValue | | public Date getDateCellValue()(Code) | | get the value of the cell as a date. For strings we throw an exception.
For blank cells we return a null.
|
| getErrorCellValue | | public byte getErrorCellValue()(Code) | | get the value of the cell as an error code. For strings, numbers, and booleans, we throw an exception.
For blank cells we return a 0.
|
| getNumericCellValue | | public double getNumericCellValue()(Code) | | get the value of the cell as a number. For strings we throw an exception.
For blank cells we return a 0.
|
| getRichStringCellValue | | public HSSFRichTextString getRichStringCellValue()(Code) | | get the value of the cell as a string - for numeric cells we throw an exception.
For blank cells we return an empty string.
For formulaCells that are not string Formulas, we return empty String
|
| getStringCellValue | | public String getStringCellValue()(Code) | | get the value of the cell as a string - for numeric cells we throw an exception.
For blank cells we return an empty string.
For formulaCells that are not string Formulas, we return empty String
|
| setAsActiveCell | | public void setAsActiveCell()(Code) | | Sets this cell as the active cell for the worksheet
|
| setCellComment | | public void setCellComment(HSSFComment comment)(Code) | | Assign a comment to this cell
Parameters:
comment - comment associated with this cell |
| setCellErrorValue | | public void setCellErrorValue(byte value)(Code) | | set a error value for the cell
Parameters:
value - the error value to set this cell to. For formulas we'll set theprecalculated value ??? IS THIS RIGHT??? , for errors we'll setits value. For other types we will change the cell to an errorcell and set its value. |
| setCellFormula | | public void setCellFormula(String formula)(Code) | | |
| setCellNum | | public void setCellNum(short num)(Code) | | set the cell's number within the row (0 based)
Parameters:
num - short the cell number |
| setCellValue | | public void setCellValue(double value)(Code) | | set a numeric value for the cell
Parameters:
value - the numeric value to set this cell to. For formulas we'll set theprecalculated value, for numerics we'll set its value. For other types wewill change the cell to a numeric cell and set its value. |
| setCellValue | | public void setCellValue(Date value)(Code) | | set a date value for the cell. Excel treats dates as numeric so you will need to format the cell as
a date.
Parameters:
value - the date value to set this cell to. For formulas we'll set theprecalculated value, for numerics we'll set its value. For other types wewill change the cell to a numeric cell and set its value. |
| setCellValue | | public void setCellValue(Calendar value)(Code) | | set a date value for the cell. Excel treats dates as numeric so you will need to format the cell as
a date.
Parameters:
value - the date value to set this cell to. For formulas we'll set theprecalculated value, for numerics we'll set its value. For othertypes wewill change the cell to a numeric cell and set its value. |
| setCellValue | | public void setCellValue(String value)(Code) | | set a string value for the cell. Please note that if you are using
full 16 bit unicode you should call setEncoding() first.
Parameters:
value - value to set the cell to. For formulas we'll set the formulastring, for String cells we'll set its value. For other types we willchange the cell to a string cell and set its value.If value is null then we will change the cell to a Blank cell. |
| setCellValue | | public void setCellValue(HSSFRichTextString value)(Code) | | set a string value for the cell. Please note that if you are using
full 16 bit unicode you should call setEncoding() first.
Parameters:
value - value to set the cell to. For formulas we'll set the formulastring, for String cells we'll set its value. For other types we willchange the cell to a string cell and set its value.If value is null then we will change the cell to a Blank cell. |
| setCellValue | | public void setCellValue(boolean value)(Code) | | set a boolean value for the cell
Parameters:
value - the boolean value to set this cell to. For formulas we'll set theprecalculated value, for booleans we'll set its value. For other types wewill change the cell to a boolean cell and set its value. |
| toString | | public String toString()(Code) | | Returns a string representation of the cell
This method returns a simple representation,
anthing more complex should be in user code, with
knowledge of the semantics of the sheet being processed.
Formula cells return the formula string,
rather than the formula result.
Dates are displayed in dd-MMM-yyyy format
Errors are displayed as #ERR<errIdx>
|
|
|