CELL_TYPE_BLANK, CELL_TYPE_BOOLEAN, CELL_TYPE_ERROR, CELL_TYPE_FORMULA, CELL_TYPE_NUMERIC, CELL_TYPE_STRING
Modifier and Type | Method and Description |
---|---|
CellRangeAddress |
getArrayFormulaRange()
Only valid for array formula cells
|
boolean |
getBooleanCellValue()
Get the value of the cell as a boolean.
|
int |
getCachedFormulaResultType()
Only valid for formula cells
|
Comment |
getCellComment()
Returns comment associated with this cell
|
java.lang.String |
getCellFormula()
Return a formula for the cell, for example,
SUM(C4:E4) |
CellStyle |
getCellStyle()
Return the cell's style.
|
int |
getCellType()
Return the cell type.
|
int |
getColumnIndex()
Returns column index of this cell
|
java.util.Date |
getDateCellValue()
Get the value of the cell as a date.
|
byte |
getErrorCellValue()
Get the value of the cell as an error code.
|
Hyperlink |
getHyperlink() |
double |
getNumericCellValue()
Get the value of the cell as a number.
|
RichTextString |
getRichStringCellValue()
Get the value of the cell as a XSSFRichTextString
For numeric cells we throw an exception.
|
Row |
getRow()
Returns the Row this cell belongs to
|
int |
getRowIndex()
Returns row index of a row in the sheet that contains this cell
|
Sheet |
getSheet()
Returns the sheet this cell belongs to
|
java.lang.String |
getStringCellValue()
Get the value of the cell as a string
For numeric cells we throw an exception.
|
boolean |
isCalcOnLoad()
Old Excel spec(Used in old XLS Excel).
|
boolean |
isPartOfArrayFormulaGroup() |
void |
removeCellComment()
Removes the comment for this cell, if there is one.
|
void |
setAsActiveCell()
Sets this cell as the active cell for the worksheet
|
void |
setCellComment(Comment comment)
Assign a comment to this cell
|
void |
setCellErrorValue(byte value)
Set a error value for the cell
|
void |
setCellFormula(java.lang.String formula)
Sets formula for this cell.
|
void |
setCellStyle(CellStyle style)
Set the style for the cell.
|
void |
setCellType(int cellType)
Set the cells type (numeric, formula or string)
|
void |
setCellValue(boolean value)
Set a boolean value for the cell
|
void |
setCellValue(java.util.Calendar value)
Set a date value for the cell.
|
void |
setCellValue(java.util.Date value)
Converts the supplied date to its equivalent Excel numeric value and sets
that into the cell.
|
void |
setCellValue(double value)
Set a numeric value for the cell
|
void |
setCellValue(RichTextString value)
Set a rich string value for the cell.
|
void |
setCellValue(java.lang.String value)
Set a string value for the cell.
|
void |
setHyperlink(Hyperlink link)
Assign a hyperlink to this cell
|
java.lang.String |
toString()
Returns a string representation of the cell
Formula cells return the formula string, rather than the formula result.
|
public SXSSFCell(SXSSFRow row, int cellType)
public int getColumnIndex()
getColumnIndex
in interface Cell
public int getRowIndex()
getRowIndex
in interface Cell
public Sheet getSheet()
public Row getRow()
public void setCellType(int cellType)
setCellType
in interface Cell
java.lang.IllegalArgumentException
- if the specified cell type is invalidCell.CELL_TYPE_NUMERIC
,
Cell.CELL_TYPE_STRING
,
Cell.CELL_TYPE_FORMULA
,
Cell.CELL_TYPE_BLANK
,
Cell.CELL_TYPE_BOOLEAN
,
Cell.CELL_TYPE_ERROR
public int getCellType()
getCellType
in interface Cell
Cell.CELL_TYPE_BLANK
,
Cell.CELL_TYPE_NUMERIC
,
Cell.CELL_TYPE_STRING
,
Cell.CELL_TYPE_FORMULA
,
Cell.CELL_TYPE_BOOLEAN
,
Cell.CELL_TYPE_ERROR
public int getCachedFormulaResultType()
getCachedFormulaResultType
in interface Cell
Cell.CELL_TYPE_NUMERIC
, Cell.CELL_TYPE_STRING
,
Cell.CELL_TYPE_BOOLEAN
, Cell.CELL_TYPE_ERROR
) depending
on the cached value of the formulapublic void setCellValue(double value)
setCellValue
in interface Cell
value
- the numeric value to set this cell to. For formulas we'll set the
precalculated value, for numerics we'll set its value. For other types we
will change the cell to a numeric cell and set its value.public void setCellValue(java.util.Date value)
Cell.CELL_TYPE_NUMERIC
. POI
does not attempt to replicate this behaviour. To make a numeric cell
display as a date, use setCellStyle(CellStyle)
etc.setCellValue
in interface Cell
value
- the numeric value to set this cell to. For formulas we'll set the
precalculated value, for numerics we'll set its value. For other types we
will change the cell to a numerics cell and set its value.public void setCellValue(java.util.Calendar value)
This will set the cell value based on the Calendar's timezone. As Excel
does not support timezones this means that both 20:00+03:00 and
20:00-03:00 will be reported as the same value (20:00) even that there
are 6 hours difference between the two times. This difference can be
preserved by using setCellValue(value.getTime())
which will
automatically shift the times to the default timezone.
setCellValue
in interface Cell
value
- the date value to set this cell to. For formulas we'll set the
precalculated value, for numerics we'll set its value. For othertypes we
will change the cell to a numeric cell and set its value.public void setCellValue(RichTextString value)
setCellValue
in interface Cell
value
- value to set the cell to. For formulas we'll set the formula
string, for String cells we'll set its value. For other types we will
change the cell to a string cell and set its value.
If value is null then we will change the cell to a Blank cell.public void setCellValue(java.lang.String value)
setCellValue
in interface Cell
value
- value to set the cell to. For formulas we'll set the formula
string, for String cells we'll set its value. For other types we will
change the cell to a string cell and set its value.
If value is null then we will change the cell to a Blank cell.public void setCellFormula(java.lang.String formula) throws FormulaParseException
Note, this method only sets the formula string and does not calculate the formula value.
To set the precalculated value use setCellValue(double)
or setCellValue(String)
setCellFormula
in interface Cell
formula
- the formula to set, e.g. "SUM(C4:E4)"
.
If the argument is null
then the current formula is removed.FormulaParseException
- if the formula has incorrect syntax or is otherwise invalidpublic java.lang.String getCellFormula()
SUM(C4:E4)
getCellFormula
in interface Cell
java.lang.IllegalStateException
- if the cell type returned by getCellType()
is not CELL_TYPE_FORMULApublic double getNumericCellValue()
For strings we throw an exception. For blank cells we return a 0. For formulas or error cells we return the precalculated value;
getNumericCellValue
in interface Cell
java.lang.IllegalStateException
- if the cell type returned by getCellType()
is CELL_TYPE_STRINGjava.lang.NumberFormatException
- if the cell value isn't a parsable double
.for turning this number into a string similar to that which Excel would render this number as.
public java.util.Date getDateCellValue()
For strings we throw an exception. For blank cells we return a null.
getDateCellValue
in interface Cell
java.lang.IllegalStateException
- if the cell type returned by getCellType()
is CELL_TYPE_STRINGjava.lang.NumberFormatException
- if the cell value isn't a parsable double
.for formatting this date into a string similar to how excel does.
public RichTextString getRichStringCellValue()
For numeric cells we throw an exception. For blank cells we return an empty string. For formula cells we return the pre-calculated value if a string, otherwise an exception.
getRichStringCellValue
in interface Cell
public java.lang.String getStringCellValue()
For numeric cells we throw an exception. For blank cells we return an empty string. For formulaCells that are not string Formulas, we throw an exception.
getStringCellValue
in interface Cell
public void setCellValue(boolean value)
setCellValue
in interface Cell
value
- the boolean value to set this cell to. For formulas we'll set the
precalculated value, for booleans we'll set its value. For other types we
will change the cell to a boolean cell and set its value.public void setCellErrorValue(byte value)
setCellErrorValue
in interface Cell
value
- the error value to set this cell to. For formulas we'll set the
precalculated value , for errors we'll set
its value. For other types we will change the cell to an error
cell and set its value.FormulaError
public boolean getBooleanCellValue()
For strings, numbers, and errors, we throw an exception. For blank cells we return a false.
getBooleanCellValue
in interface Cell
java.lang.IllegalStateException
- if the cell type returned by getCellType()
is not CELL_TYPE_BOOLEAN, CELL_TYPE_BLANK or CELL_TYPE_FORMULApublic byte getErrorCellValue()
For strings, numbers, and booleans, we throw an exception. For blank cells we return a 0.
getErrorCellValue
in interface Cell
java.lang.IllegalStateException
- if the cell type returned by getCellType()
isn't CELL_TYPE_ERRORfor error codes
public void setCellStyle(CellStyle style)
setCellStyle
in interface Cell
style
- reference contained in the workbook.
If the value is null then the style information is removed causing the cell to used the default workbook style.Workbook.createCellStyle()
public CellStyle getCellStyle()
getCellStyle
in interface Cell
workbook.getCellStyleAt(0)
org.zkoss.poi.ss.usermodel.Workbook#getCellStyleAt(short)
public void setAsActiveCell()
setAsActiveCell
in interface Cell
public void setCellComment(Comment comment)
setCellComment
in interface Cell
comment
- comment associated with this cellpublic Comment getCellComment()
getCellComment
in interface Cell
null
if not foundpublic void removeCellComment()
removeCellComment
in interface Cell
public Hyperlink getHyperlink()
getHyperlink
in interface Cell
null
if not foundpublic void setHyperlink(Hyperlink link)
setHyperlink
in interface Cell
link
- hyperlink associated with this cellpublic CellRangeAddress getArrayFormulaRange()
getArrayFormulaRange
in interface Cell
public boolean isPartOfArrayFormulaGroup()
isPartOfArrayFormulaGroup
in interface Cell
true
if this cell is part of group of cells having a common array formula.public java.lang.String toString()
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>
toString
in class java.lang.Object
public boolean isCalcOnLoad()
Cell
isCalcOnLoad
in interface Cell
Copyright © 2005-2010 Potix Corporation. All Rights Reserved.