Package | Description |
---|---|
org.apache.poi.hssf.usermodel |
The usermodel package maps HSSF low level structures to familiar workbook/sheet model
|
org.apache.poi.ss.extractor | |
org.apache.poi.ss.formula |
This package contains common internal POI code for manipulating formulas.
|
org.apache.poi.ss.usermodel | |
org.apache.poi.ss.usermodel.helpers | |
org.apache.poi.ss.util | |
org.apache.poi.ss.util.cellwalk | |
org.apache.poi.xssf.model | |
org.apache.poi.xssf.streaming | |
org.apache.poi.xssf.usermodel |
Modifier and Type | Class and Description |
---|---|
class |
HSSFSheet
High level representation of a worksheet.
|
Modifier and Type | Method and Description |
---|---|
java.util.Iterator<Sheet> |
HSSFWorkbook.sheetIterator()
Returns an iterator of the sheets in the workbook
in sheet order.
|
java.util.Spliterator<Sheet> |
HSSFWorkbook.spliterator()
Returns a spliterator of the sheets in the workbook
in sheet order.
|
Modifier and Type | Method and Description |
---|---|
protected void |
HSSFRangeCopier.adjustCellReferencesInsideFormula(Cell cell,
Sheet destSheet,
int deltaX,
int deltaY) |
int |
HSSFWorkbook.getSheetIndex(Sheet sheet)
Returns the index of the given sheet
|
Constructor and Description |
---|
HSSFRangeCopier(Sheet sheet) |
HSSFRangeCopier(Sheet sourceSheet,
Sheet destSheet) |
Modifier and Type | Method and Description |
---|---|
java.util.List<EmbeddedData> |
EmbeddedExtractor.extractAll(Sheet sheet) |
Modifier and Type | Method and Description |
---|---|
Sheet |
EvaluationConditionalFormatRule.getSheet() |
Modifier and Type | Method and Description |
---|---|
java.util.List<EvaluationConditionalFormatRule> |
ConditionalFormattingEvaluator.getFormatRulesForSheet(Sheet sheet)
Retrieve all formatting rules for the given sheet.
|
java.util.List<Cell> |
ConditionalFormattingEvaluator.getMatchingCells(Sheet sheet,
int conditionalFormattingIndex,
int ruleIndex)
Conditional formatting rules can apply only to cells in the sheet to which they are attached.
|
protected java.util.List<EvaluationConditionalFormatRule> |
ConditionalFormattingEvaluator.getRules(Sheet sheet)
lazy load by sheet since reading can be expensive
|
Constructor and Description |
---|
EvaluationConditionalFormatRule(WorkbookEvaluator workbookEvaluator,
Sheet sheet,
ConditionalFormatting formatting,
int formattingIndex,
ConditionalFormattingRule rule,
int ruleIndex,
CellRangeAddress[] regions) |
Modifier and Type | Method and Description |
---|---|
Sheet |
Workbook.cloneSheet(int sheetNum)
Create a Sheet from an existing sheet in the Workbook.
|
Sheet |
Workbook.createSheet()
Create a Sheet for this Workbook, adds it to the sheets and returns
the high level representation.
|
Sheet |
Workbook.createSheet(java.lang.String sheetname)
Create a new sheet for this Workbook and return the high level representation.
|
Sheet |
Cell.getSheet()
Returns the sheet this cell belongs to
|
Sheet |
Row.getSheet()
Returns the Sheet this row belongs to
|
Sheet |
Picture.getSheet() |
Sheet |
Workbook.getSheet(java.lang.String name)
Get sheet with the given name
|
Sheet |
Workbook.getSheetAt(int index)
Get the Sheet object at the given index.
|
Modifier and Type | Method and Description |
---|---|
default java.util.Iterator<Sheet> |
Workbook.iterator()
Alias for
Workbook.sheetIterator() to allow foreach loops |
java.util.Iterator<Sheet> |
Workbook.sheetIterator()
Returns an iterator of the sheets in the workbook
in sheet order.
|
default java.util.Spliterator<Sheet> |
Workbook.spliterator()
Returns a spliterator of the sheets in the workbook
in sheet order.
|
Modifier and Type | Method and Description |
---|---|
protected abstract void |
RangeCopier.adjustCellReferencesInsideFormula(Cell cell,
Sheet destSheet,
int deltaX,
int deltaY) |
int |
Workbook.getSheetIndex(Sheet sheet)
Returns the index of the given sheet
|
Constructor and Description |
---|
RangeCopier(Sheet sheet) |
RangeCopier(Sheet sourceSheet,
Sheet destSheet) |
Modifier and Type | Field and Description |
---|---|
protected Sheet |
ColumnShifter.sheet |
protected Sheet |
RowShifter.sheet |
Constructor and Description |
---|
ColumnShifter(Sheet sh) |
RowShifter(Sheet sh) |
Modifier and Type | Method and Description |
---|---|
Sheet |
SheetBuilder.build()
Builds sheet from parent workbook and 2D array with cell
values.
|
Modifier and Type | Method and Description |
---|---|
void |
PropertyTemplate.applyBorders(Sheet sheet)
Applies the drawn borders to a Sheet.
|
static Cell |
SheetUtil.getCell(Sheet sheet,
int rowIx,
int colIx)
Return the cell, without taking account of merged regions.
|
static Cell |
SheetUtil.getCellWithMerges(Sheet sheet,
int rowIx,
int colIx)
Return the cell, taking account of merged regions.
|
static double |
SheetUtil.getColumnWidth(Sheet sheet,
int column,
boolean useMergedCells)
Compute width of a column and return the result.
|
static double |
SheetUtil.getColumnWidth(Sheet sheet,
int column,
boolean useMergedCells,
int firstRow,
int lastRow)
Compute width of a column based on a subset of the rows and return the result.
|
static Row |
CellUtil.getRow(int rowIndex,
Sheet sheet)
Get a row from the spreadsheet, and create it if it doesn't exist.
|
static double |
ImageUtils.getRowHeightInPixels(Sheet sheet,
int rowNum) |
static void |
RegionUtil.setBorderBottom(BorderStyle border,
CellRangeAddress region,
Sheet sheet)
Sets the bottom border style for a region of cells by manipulating the cell style of the individual
cells on the bottom
|
static void |
RegionUtil.setBorderLeft(BorderStyle border,
CellRangeAddress region,
Sheet sheet)
Sets the left border style for a region of cells by manipulating the cell style of the individual
cells on the left
|
static void |
RegionUtil.setBorderRight(BorderStyle border,
CellRangeAddress region,
Sheet sheet)
Sets the right border style for a region of cells by manipulating the cell style of the individual
cells on the right
|
static void |
RegionUtil.setBorderTop(BorderStyle border,
CellRangeAddress region,
Sheet sheet)
Sets the top border style for a region of cells by manipulating the cell style of the individual
cells on the top
|
static void |
RegionUtil.setBottomBorderColor(int color,
CellRangeAddress region,
Sheet sheet)
Sets the bottom border color for a region of cells by manipulating the cell style of the individual
cells on the bottom
|
static void |
RegionUtil.setLeftBorderColor(int color,
CellRangeAddress region,
Sheet sheet)
Sets the left border color for a region of cells by manipulating the cell style of the individual
cells on the left
|
static void |
RegionUtil.setRightBorderColor(int color,
CellRangeAddress region,
Sheet sheet)
Sets the right border color for a region of cells by manipulating the cell style of the individual
cells on the right
|
static void |
RegionUtil.setTopBorderColor(int color,
CellRangeAddress region,
Sheet sheet)
Sets the top border color for a region of cells by manipulating the cell style of the individual
cells on the top
|
Constructor and Description |
---|
CellWalk(Sheet sheet,
CellRangeAddress range) |
Modifier and Type | Method and Description |
---|---|
void |
CommentsTable.setSheet(Sheet sheet) |
void |
Comments.setSheet(Sheet sheet)
This method is for internal POI use only.
|
Modifier and Type | Class and Description |
---|---|
protected class |
SXSSFWorkbook.SheetIterator<T extends Sheet> |
Modifier and Type | Class and Description |
---|---|
class |
DeferredSXSSFSheet
A variant of SXSSFSheet that uses a
RowGeneratorFunction to lazily create rows. |
class |
SXSSFSheet
Streaming version of XSSFSheet implementing the "BigGridDemo" strategy.
|
Modifier and Type | Method and Description |
---|---|
Sheet |
SXSSFWorkbook.cloneSheet(int sheetNum)
Not implemented for SXSSFWorkbook
Create a Sheet from an existing sheet in the Workbook.
|
Modifier and Type | Method and Description |
---|---|
java.util.Iterator<Sheet> |
SXSSFWorkbook.sheetIterator()
Returns an iterator of the sheets in the workbook
in sheet order.
|
java.util.Iterator<Sheet> |
DeferredSXSSFWorkbook.sheetIterator()
Returns an iterator of the sheets in the workbook in sheet order.
|
java.util.Spliterator<Sheet> |
SXSSFWorkbook.spliterator()
Returns a spliterator of the sheets in the workbook
in sheet order.
|
Modifier and Type | Method and Description |
---|---|
int |
SXSSFWorkbook.getSheetIndex(Sheet sheet)
Returns the index of the given sheet
|
Modifier and Type | Class and Description |
---|---|
class |
XSSFChartSheet
High level representation of Sheet Parts that are of type 'chartsheet'.
|
class |
XSSFDialogsheet |
class |
XSSFSheet
High level representation of a SpreadsheetML worksheet.
|
Modifier and Type | Method and Description |
---|---|
Sheet |
XSSFPivotTable.getDataSheet() |
Sheet |
XSSFPivotTable.getParentSheet() |
Modifier and Type | Method and Description |
---|---|
java.util.Iterator<Sheet> |
XSSFWorkbook.iterator()
Alias for
XSSFWorkbook.sheetIterator() to allow
foreach loops
Note: remove() is not supported on this iterator. |
java.util.Iterator<Sheet> |
XSSFWorkbook.sheetIterator()
Returns an iterator of the sheets in the workbook
in sheet order.
|
java.util.Spliterator<Sheet> |
XSSFWorkbook.spliterator()
Returns a spliterator of the sheets in the workbook
in sheet order.
|
Modifier and Type | Method and Description |
---|---|
protected void |
XSSFRangeCopier.adjustCellReferencesInsideFormula(Cell cell,
Sheet destSheet,
int deltaX,
int deltaY) |
protected void |
XSSFPivotCacheDefinition.createCacheFields(Sheet sheet)
Generates a cache field for each column in the reference area for the pivot table.
|
XSSFPivotTable |
XSSFSheet.createPivotTable(AreaReference source,
CellReference position,
Sheet sourceSheet)
Create a pivot table using the AreaReference range on sourceSheet, at the given position.
|
XSSFPivotTable |
XSSFSheet.createPivotTable(Name source,
CellReference position,
Sheet sourceSheet)
Create a pivot table using the Name range reference on sourceSheet, at the given position.
|
protected void |
XSSFPivotTable.createSourceReferences(CellReference position,
Sheet sourceSheet,
XSSFPivotTable.PivotTableReferenceConfigurator refConfig)
Creates cacheSource and workSheetSource for pivot table and sets the source reference as well assets the location of the pivot table
|
int |
XSSFWorkbook.getSheetIndex(Sheet sheet)
Returns the index of the given sheet
|
Constructor and Description |
---|
XSSFRangeCopier(Sheet sheet) |
XSSFRangeCopier(Sheet sourceSheet,
Sheet destSheet) |
Copyright 2022 The Apache Software Foundation or its licensors, as applicable.