Package | Description |
---|---|
org.apache.poi.hssf.usermodel |
usermodel package maps HSSF low level strutures to familiar workbook/sheet model
|
org.apache.poi.ss.format |
This package contains classes that implement cell formatting
|
org.apache.poi.ss.formula |
This package contains common internal POI code for manipulating formulas.
|
org.apache.poi.ss.usermodel | |
org.apache.poi.ss.util | |
org.apache.poi.ss.util.cellwalk | |
org.apache.poi.xssf.streaming | |
org.apache.poi.xssf.usermodel |
Modifier and Type | Class and Description |
---|---|
class |
HSSFCell
High level representation of a cell in a row of a spreadsheet.
|
Modifier and Type | Method and Description |
---|---|
java.util.Iterator<Cell> |
HSSFRow.cellIterator() |
java.util.Iterator<Cell> |
HSSFRow.iterator()
Alias for
HSSFRow.cellIterator() to allow
foreach loops |
Modifier and Type | Method and Description |
---|---|
protected CellValue |
HSSFFormulaEvaluator.evaluateFormulaCellValue(Cell cell)
Returns a CellValue wrapper around the supplied ValueEval instance.
|
HSSFCell |
HSSFFormulaEvaluator.evaluateInCell(Cell cell) |
void |
HSSFFormulaEvaluator.notifyDeleteCell(Cell cell) |
void |
HSSFFormulaEvaluator.notifySetFormula(Cell cell)
Should be called to tell the cell value cache that the specified (value or formula) cell
has changed.
|
void |
HSSFFormulaEvaluator.notifyUpdateCell(Cell cell) |
CellRange<HSSFCell> |
HSSFSheet.removeArrayFormula(Cell cell) |
void |
HSSFRow.removeCell(Cell cell)
remove the HSSFCell from this row.
|
Modifier and Type | Method and Description |
---|---|
CellFormatResult |
CellFormat.apply(Cell c)
Fetches the appropriate value from the cell, and returns the result of
applying it to the appropriate format.
|
CellFormatResult |
CellFormat.apply(javax.swing.JLabel label,
Cell c)
Fetches the appropriate value from the cell, and uses the result, setting
the text and color of a label before returning the result.
|
static int |
CellFormat.ultimateType(Cell cell)
Deprecated.
POI 3.15. This will return a CellType enum in the future
|
static CellType |
CellFormat.ultimateTypeEnum(Cell cell)
Deprecated.
POI 3.15 beta 3
Will be deleted when we make the CellType enum transition. See bug 59791.
|
Modifier and Type | Method and Description |
---|---|
Cell |
BaseFormulaEvaluator.evaluateInCell(Cell cell)
If cell contains formula, it evaluates the formula, and
puts the formula result back into the cell, in place
of the old formula.
|
Modifier and Type | Method and Description |
---|---|
CellValue |
BaseFormulaEvaluator.evaluate(Cell cell)
If cell contains a formula, the formula is evaluated and returned,
else the CellValue simply copies the appropriate cell value from
the cell and also its cell type.
|
int |
BaseFormulaEvaluator.evaluateFormulaCell(Cell cell)
Deprecated.
3.15. Will return a
CellType enum in the future. |
CellType |
BaseFormulaEvaluator.evaluateFormulaCellEnum(Cell cell)
Deprecated.
POI 3.15 beta 3. Will be deleted when we make the CellType enum transition. See bug 59791.
|
protected abstract CellValue |
BaseFormulaEvaluator.evaluateFormulaCellValue(Cell cell) |
Cell |
BaseFormulaEvaluator.evaluateInCell(Cell cell)
If cell contains formula, it evaluates the formula, and
puts the formula result back into the cell, in place
of the old formula.
|
protected static void |
BaseFormulaEvaluator.setCellType(Cell cell,
CellValue cv) |
protected void |
BaseFormulaEvaluator.setCellValue(Cell cell,
CellValue cv) |
Modifier and Type | Interface and Description |
---|---|
interface |
CellRange<C extends Cell>
Represents a rectangular region of a
Sheet |
Modifier and Type | Method and Description |
---|---|
Cell |
Row.createCell(int column)
Use this to create new cells within the row and return it.
|
Cell |
Row.createCell(int column,
CellType type)
Use this to create new cells within the row and return it.
|
Cell |
Row.createCell(int column,
int type)
Deprecated.
POI 3.15 beta 3. Use
Row.createCell(int, CellType) instead. |
Cell |
FormulaEvaluator.evaluateInCell(Cell cell)
If cell contains formula, it evaluates the formula, and
puts the formula result back into the cell, in place
of the old formula.
|
Cell |
Row.getCell(int cellnum)
Get the cell representing a given column (logical cell) 0-based.
|
Cell |
Row.getCell(int cellnum,
Row.MissingCellPolicy policy)
Returns the cell at the given (0 based) index, with the specified
Row.MissingCellPolicy |
C[][] |
CellRange.getCells() |
C[] |
CellRange.getFlattenedCells() |
Modifier and Type | Method and Description |
---|---|
java.util.Iterator<Cell> |
Row.cellIterator() |
CellRange<? extends Cell> |
Sheet.removeArrayFormula(Cell cell)
Remove a Array Formula from this sheet.
|
CellRange<? extends Cell> |
Sheet.setArrayFormula(java.lang.String formula,
CellRangeAddress range)
Sets array formula to specified region for result.
|
Modifier and Type | Method and Description |
---|---|
java.text.Format |
DataFormatter.createFormat(Cell cell)
Create and return a Format based on the format string from a cell's
style.
|
CellValue |
FormulaEvaluator.evaluate(Cell cell)
If cell contains a formula, the formula is evaluated and returned,
else the CellValue simply copies the appropriate cell value from
the cell and also its cell type.
|
int |
FormulaEvaluator.evaluateFormulaCell(Cell cell)
Deprecated.
3.15. Will return a
CellType enum in the future |
CellType |
FormulaEvaluator.evaluateFormulaCellEnum(Cell cell)
Deprecated.
POI 3.15 beta 3. Will be deleted when we make the CellType enum transition. See bug 59791.
|
Cell |
FormulaEvaluator.evaluateInCell(Cell cell)
If cell contains formula, it evaluates the formula, and
puts the formula result back into the cell, in place
of the old formula.
|
java.lang.String |
DataFormatter.formatCellValue(Cell cell)
Returns the formatted value of a cell as a String regardless
of the cell type.
|
java.lang.String |
DataFormatter.formatCellValue(Cell cell,
FormulaEvaluator evaluator)
Returns the formatted value of a cell as a String regardless
of the cell type.
|
java.text.Format |
DataFormatter.getDefaultFormat(Cell cell)
Returns a default format for a cell.
|
static boolean |
DateUtil.isCellDateFormatted(Cell cell)
Check if a cell contains a date
Since dates are stored internally in Excel as double values
we infer it is a date if it is formatted as such.
|
static boolean |
DateUtil.isCellInternalDateFormatted(Cell cell)
Check if a cell contains a date, checking only for internal
excel date formats.
|
void |
FormulaEvaluator.notifyDeleteCell(Cell cell)
Should be called to tell the cell value cache that the specified cell has just become a
formula cell, or the formula text has changed
|
void |
FormulaEvaluator.notifySetFormula(Cell cell)
Should be called to tell the cell value cache that the specified (value or formula) cell
has changed.
|
void |
FormulaEvaluator.notifyUpdateCell(Cell cell)
Should be called to tell the cell value cache that the specified (value or formula) cell
has changed.
|
CellRange<? extends Cell> |
Sheet.removeArrayFormula(Cell cell)
Remove a Array Formula from this sheet.
|
void |
Row.removeCell(Cell cell)
Remove the Cell from this row.
|
Modifier and Type | Class and Description |
---|---|
class |
SSCellRange<K extends Cell>
For POI internal use only
|
Modifier and Type | Method and Description |
---|---|
static <B extends Cell> |
SSCellRange.create(int firstRow,
int firstColumn,
int height,
int width,
java.util.List<B> flattenedList,
java.lang.Class<B> cellClass) |
Modifier and Type | Method and Description |
---|---|
static Cell |
CellUtil.createCell(Row row,
int column,
java.lang.String value)
Create a cell, and give it a value.
|
static Cell |
CellUtil.createCell(Row row,
int column,
java.lang.String value,
CellStyle style)
Creates a cell, gives it a value, and applies a style if provided
|
static Cell |
CellUtil.getCell(Row row,
int columnIndex)
Get a specific cell from a row.
|
K[][] |
SSCellRange.getCells() |
static Cell |
SheetUtil.getCellWithMerges(Sheet sheet,
int rowIx,
int colIx)
Return the cell, taking account of merged regions.
|
K[] |
SSCellRange.getFlattenedCells() |
static Cell |
CellUtil.translateUnicodeValues(Cell cell)
Looks for text in the cell that should be unicode, like α and provides the
unicode version of it.
|
Modifier and Type | Method and Description |
---|---|
static double |
SheetUtil.getCellWidth(Cell cell,
int defaultCharWidth,
DataFormatter formatter,
boolean useMergedCells)
Compute width of a single cell
|
static void |
CellUtil.setAlignment(Cell cell,
HorizontalAlignment align)
Take a cell, and align it.
|
static void |
CellUtil.setAlignment(Cell cell,
Workbook workbook,
short align)
Deprecated.
3.15-beta2. Use
CellUtil.setAlignment(Cell, HorizontalAlignment) instead. |
static void |
CellUtil.setCellStyleProperties(Cell cell,
java.util.Map<java.lang.String,java.lang.Object> properties)
This method attempts to find an existing CellStyle that matches the
cell 's
current style plus styles properties in properties . |
static void |
CellUtil.setCellStyleProperty(Cell cell,
java.lang.String propertyName,
java.lang.Object propertyValue)
This method attempts to find an existing CellStyle that matches the
cell 's
current style plus a single style property propertyName with value
propertyValue . |
static void |
CellUtil.setCellStyleProperty(Cell cell,
Workbook workbook,
java.lang.String propertyName,
java.lang.Object propertyValue)
Deprecated.
3.15-beta2. Use
CellUtil.setCellStyleProperty(Cell, String, Object) instead. |
static void |
CellUtil.setFont(Cell cell,
Font font)
Take a cell, and apply a font to it
|
static void |
CellUtil.setFont(Cell cell,
Workbook workbook,
Font font)
Deprecated.
3.15-beta2. Use
CellUtil.setFont(Cell, Font) instead. |
static void |
CellUtil.setVerticalAlignment(Cell cell,
VerticalAlignment align)
Take a cell, and vertically align it.
|
static Cell |
CellUtil.translateUnicodeValues(Cell cell)
Looks for text in the cell that should be unicode, like α and provides the
unicode version of it.
|
Constructor and Description |
---|
CellAddress(Cell cell)
Create a new CellAddress object.
|
CellReference(Cell cell) |
Modifier and Type | Method and Description |
---|---|
void |
CellHandler.onCell(Cell cell,
CellWalkContext ctx) |
Modifier and Type | Class and Description |
---|---|
class |
SXSSFCell
Streaming version of XSSFRow implementing the "BigGridDemo" strategy.
|
Modifier and Type | Method and Description |
---|---|
Cell |
SXSSFRow.FilledCellIterator.next() |
Cell |
SXSSFRow.CellIterator.next() |
Modifier and Type | Method and Description |
---|---|
java.util.Iterator<Cell> |
SXSSFRow.allCellsIterator() |
java.util.Iterator<Cell> |
SXSSFRow.cellIterator() |
java.util.Iterator<Cell> |
SXSSFRow.iterator() |
CellRange<? extends Cell> |
SXSSFSheet.removeArrayFormula(Cell cell)
Remove a Array Formula from this sheet.
|
CellRange<? extends Cell> |
SXSSFSheet.setArrayFormula(java.lang.String formula,
CellRangeAddress range)
Sets array formula to specified region for result.
|
Modifier and Type | Method and Description |
---|---|
SXSSFCell |
SXSSFFormulaEvaluator.evaluateInCell(Cell cell) |
CellRange<? extends Cell> |
SXSSFSheet.removeArrayFormula(Cell cell)
Remove a Array Formula from this sheet.
|
void |
SXSSFRow.removeCell(Cell cell)
Remove the Cell from this row.
|
protected EvaluationCell |
SXSSFFormulaEvaluator.toEvaluationCell(Cell cell)
Turns a SXSSFCell into a SXSSFEvaluationCell
|
void |
SheetDataWriter.writeCell(int columnIndex,
Cell cell) |
Modifier and Type | Class and Description |
---|---|
class |
XSSFCell
High level representation of a cell in a row of a spreadsheet.
|
Modifier and Type | Method and Description |
---|---|
java.util.Iterator<Cell> |
XSSFRow.cellIterator()
Cell iterator over the physically defined cells:
|
java.util.Iterator<Cell> |
XSSFRow.iterator()
Alias for
XSSFRow.cellIterator() to allow foreach loops:
|
Modifier and Type | Method and Description |
---|---|
void |
XSSFCell.copyCellFrom(Cell srcCell,
CellCopyPolicy policy)
Copy cell value, formula and style, from srcCell per cell copy policy
If srcCell is null, clears the cell value and cell style per cell copy policy
This does not shift references in formulas.
|
protected CellValue |
BaseXSSFFormulaEvaluator.evaluateFormulaCellValue(Cell cell)
Returns a CellValue wrapper around the supplied ValueEval instance.
|
XSSFCell |
XSSFFormulaEvaluator.evaluateInCell(Cell cell) |
void |
BaseXSSFFormulaEvaluator.notifyDeleteCell(Cell cell) |
void |
BaseXSSFFormulaEvaluator.notifySetFormula(Cell cell) |
void |
BaseXSSFFormulaEvaluator.notifyUpdateCell(Cell cell) |
CellRange<XSSFCell> |
XSSFSheet.removeArrayFormula(Cell cell) |
void |
XSSFRow.removeCell(Cell cell)
Remove the Cell from this row.
|
protected EvaluationCell |
XSSFFormulaEvaluator.toEvaluationCell(Cell cell)
Turns a XSSFCell into a XSSFEvaluationCell
|
protected abstract EvaluationCell |
BaseXSSFFormulaEvaluator.toEvaluationCell(Cell cell)
Turns a XSSFCell / SXSSFCell into a XSSFEvaluationCell
|
Copyright 2017 The Apache Software Foundation or its licensors, as applicable.