|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.poi.hssf.usermodel.HSSFCell
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 are treated like string cells, simply containing a formula string. They'll be rendered differently.
Cells should have their number (0 based) before being added to a row. Only cells that have values should be added.
NOTE: the alpha won't be implementing formulas
Field Summary | |
static int |
CELL_TYPE_BLANK
Blank Cell type (3) |
static int |
CELL_TYPE_BOOLEAN
Boolean Cell type (4) |
static int |
CELL_TYPE_ERROR
Error Cell type (5) |
static int |
CELL_TYPE_FORMULA
Formula Cell type (2) |
static int |
CELL_TYPE_NUMERIC
Numeric Cell type (0) |
static int |
CELL_TYPE_STRING
String Cell type (1) |
static short |
ENCODING_COMPRESSED_UNICODE
|
static short |
ENCODING_UTF_16
|
Constructor Summary | |
protected |
HSSFCell(Workbook book,
Sheet sheet,
short row,
CellValueRecordInterface cval)
Creates an HSSFCell from a CellValueRecordInterface. |
protected |
HSSFCell(Workbook book,
Sheet sheet,
short row,
short col)
Creates new Cell - Should only be called by HSSFRow. |
protected |
HSSFCell(Workbook book,
Sheet sheet,
short row,
short col,
int type)
Deprecated. As of 22-Jan-2002 use @see org.apache.poi.hssf.usermodel.HSSFRow#createCell(short) and use setCellValue to specify the type lazily. |
Method Summary | |
boolean |
getBooleanCellValue()
get the value of the cell as a boolean. |
short |
getCellNum()
get the cell's number within the row |
HSSFCellStyle |
getCellStyle()
get the style for the cell. |
int |
getCellType()
get the cells type (numeric, formula or string) |
protected CellValueRecordInterface |
getCellValueRecord()
Should only be used by HSSFSheet and friends. |
java.util.Date |
getDateCellValue()
get the value of the cell as a date. |
short |
getEncoding()
used for internationalization, currently 0 for compressed unicode or 1 for 16-bit |
byte |
getErrorCellValue()
get the value of the cell as an error code. |
double |
getNumericCellValue()
get the value of the cell as a number. |
java.lang.String |
getStringCellValue()
get the value of the cell as a string - for numeric cells we throw an exception. |
void |
setCellErrorValue(byte value)
set a error value for the cell |
void |
setCellNum(short num)
set the cell's number within the row (0 based) |
void |
setCellStyle(HSSFCellStyle style)
set the style for the cell. |
void |
setCellType(int cellType)
set the cells type (numeric, formula or string) -- DONT USE FORMULAS IN THIS RELEASE WE'LL THROW YOU A RUNTIME EXCEPTION IF YOU DO |
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)
set a date value for the cell. |
void |
setCellValue(double value)
set a numeric value for the cell |
void |
setCellValue(java.lang.String value)
set a string value for the cell. |
void |
setEncoding(short encoding)
set the encoding to either 8 or 16 bit. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int CELL_TYPE_NUMERIC
setCellType(int)
,
getCellType()
public static final int CELL_TYPE_STRING
setCellType(int)
,
getCellType()
public static final int CELL_TYPE_FORMULA
setCellType(int)
,
getCellType()
public static final int CELL_TYPE_BLANK
setCellType(int)
,
getCellType()
public static final int CELL_TYPE_BOOLEAN
setCellType(int)
,
getCellType()
public static final int CELL_TYPE_ERROR
setCellType(int)
,
getCellType()
public static final short ENCODING_COMPRESSED_UNICODE
public static final short ENCODING_UTF_16
Constructor Detail |
protected HSSFCell(Workbook book, Sheet sheet, short row, short col)
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.
book
- - Workbook record of the workbook containing this cellsheet
- - Sheet record of the sheet containing this cellrow
- - the row of this cellcol
- - the column for this cellHSSFRow.createCell(short)
protected HSSFCell(Workbook book, Sheet sheet, short row, short col, int type)
book
- - Workbook record of the workbook containing this cellsheet
- - Sheet record of the sheet containing this cellrow
- - the row of this cellcol
- - the column for this celltype
- - CELL_TYPE_NUMERIC, CELL_TYPE_STRING, CELL_TYPE_FORMULA, CELL_TYPE_BLANK,
CELL_TYPE_BOOLEAN, CELL_TYPE_ERROR
Type of cellHSSFRow.createCell(short,int)
protected HSSFCell(Workbook book, Sheet sheet, short row, CellValueRecordInterface cval)
book
- - Workbook record of the workbook containing this cellsheet
- - Sheet record of the sheet containing this cellcval
- - the Cell Value Record we wish to representMethod Detail |
public void setCellNum(short num)
num
- short the cell numberpublic short getCellNum()
public void setCellType(int cellType)
CELL_TYPE_NUMERIC
,
CELL_TYPE_STRING
,
CELL_TYPE_FORMULA
,
CELL_TYPE_BLANK
,
CELL_TYPE_BOOLEAN
,
CELL_TYPE_ERROR
public int getCellType()
CELL_TYPE_STRING
,
CELL_TYPE_NUMERIC
,
CELL_TYPE_FORMULA
,
CELL_TYPE_BOOLEAN
,
CELL_TYPE_ERROR
public void setCellValue(double value)
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)
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 other types we
will change the cell to a numeric cell and set its value.public void setCellValue(java.util.Calendar value)
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(java.lang.String value)
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 double getNumericCellValue()
public java.util.Date getDateCellValue()
public java.lang.String getStringCellValue()
public void setCellValue(boolean value)
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)
value
- the error value to set this cell to. For formulas we'll set the
precalculated value ??? IS THIS RIGHT??? , for errors we'll set
its value. For other types we will change the cell to an error
cell and set its value.public boolean getBooleanCellValue()
public byte getErrorCellValue()
public void setCellStyle(HSSFCellStyle style)
style
- reference contained in the workbookHSSFWorkbook.createCellStyle()
,
HSSFWorkbook.getCellStyleAt(short)
public HSSFCellStyle getCellStyle()
HSSFWorkbook.getCellStyleAt(short)
public short getEncoding()
ENCODING_COMPRESSED_UNICODE
,
ENCODING_UTF_16
public void setEncoding(short encoding)
encoding
- either ENCODING_COMPRESSED_UNICODE (0) or ENCODING_UTF_16 (1)ENCODING_COMPRESSED_UNICODE
,
ENCODING_UTF_16
protected CellValueRecordInterface getCellValueRecord()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |