Package | Description |
---|---|
org.apache.poi.hssf.converter | |
org.apache.poi.hssf.model |
Provides low level API structures for reading, writing, modifying XLS files.
|
org.apache.poi.hssf.record |
Record package contains class representations for XLS binary strutures.
|
org.apache.poi.hssf.record.aggregates |
The record aggregates are not real "records" but collections of records that act as a single record.
|
org.apache.poi.hssf.record.common | |
org.apache.poi.hssf.usermodel |
The usermodel package maps HSSF low level structures to familiar workbook/sheet model
|
org.apache.poi.hssf.util |
The util package contains tools needed for writing HSSF files that are not necesarily "real" HSSF concepts.
|
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.charts | |
org.apache.poi.ss.usermodel.helpers | |
org.apache.poi.ss.util | |
org.apache.poi.ss.util.cellwalk | |
org.apache.poi.xddf.usermodel.chart | |
org.apache.poi.xssf.streaming | |
org.apache.poi.xssf.usermodel |
Modifier and Type | Method and Description |
---|---|
static CellRangeAddress[][] |
ExcelToHtmlUtils.buildMergedRangesMap(Sheet sheet)
Creates a map (i.e.
|
static CellRangeAddress |
AbstractExcelUtils.getMergedRange(CellRangeAddress[][] mergedRanges,
int rowNumber,
int columnNumber) |
Modifier and Type | Method and Description |
---|---|
static CellRangeAddress |
AbstractExcelUtils.getMergedRange(CellRangeAddress[][] mergedRanges,
int rowNumber,
int columnNumber) |
protected int |
ExcelToHtmlConverter.processRow(CellRangeAddress[][] mergedRanges,
HSSFRow row,
org.w3c.dom.Element tableRowElement) |
protected int |
ExcelToFoConverter.processRow(HSSFWorkbook workbook,
CellRangeAddress[][] mergedRanges,
HSSFRow row,
org.w3c.dom.Element tableRowElement) |
Modifier and Type | Method and Description |
---|---|
CellRangeAddress |
InternalSheet.getMergedRegionAt(int index) |
Modifier and Type | Method and Description |
---|---|
CellRangeAddress |
MergeCellsRecord.getAreaAt(int index) |
CellRangeAddress |
CFRule12Record.getAssociatedRange() |
CellRangeAddress |
CFHeader12Record.getAssociatedRange() |
CellRangeAddress[] |
CFHeaderBase.getCellRanges() |
CellRangeAddress[] |
FeatRecord.getCellRefs() |
CellRangeAddress |
CFHeaderBase.getEnclosingCellRange() |
Modifier and Type | Method and Description |
---|---|
void |
CFHeaderBase.setCellRanges(CellRangeAddress[] cellRanges)
Set cell ranges list to a single cell range and
modify the enclosing cell range accordingly.
|
void |
FeatRecord.setCellRefs(CellRangeAddress[] cellRefs) |
void |
CFHeaderBase.setEnclosingCellRange(CellRangeAddress cr) |
Constructor and Description |
---|
CFHeader12Record(CellRangeAddress[] regions,
int nRules) |
CFHeaderBase(CellRangeAddress[] regions,
int nRules) |
CFHeaderRecord(CellRangeAddress[] regions,
int nRules) |
MergeCellsRecord(CellRangeAddress[] regions,
int startIndex,
int numberOfRegions) |
Modifier and Type | Method and Description |
---|---|
CellRangeAddress |
MergedCellsTable.get(int index) |
CellRangeAddress |
FormulaRecordAggregate.getArrayFormulaRange() |
CellRangeAddress |
FormulaRecordAggregate.removeArrayFormula(int rowIndex,
int columnIndex)
Removes an array formula
|
Modifier and Type | Method and Description |
---|---|
void |
FormulaRecordAggregate.setArrayFormula(CellRangeAddress r,
Ptg[] ptgs) |
Constructor and Description |
---|
CFRecordsAggregate(CellRangeAddress[] regions,
CFRuleBase[] rules) |
Modifier and Type | Method and Description |
---|---|
CellRangeAddress |
FutureRecord.getAssociatedRange() |
CellRangeAddress |
FtrHeader.getAssociatedRange() |
Modifier and Type | Method and Description |
---|---|
void |
FtrHeader.setAssociatedRange(CellRangeAddress associatedRange) |
Modifier and Type | Method and Description |
---|---|
CellRangeAddress |
HSSFCell.getArrayFormulaRange() |
CellRangeAddress[] |
HSSFConditionalFormatting.getFormattingRanges() |
CellRangeAddress |
HSSFSheet.getMergedRegion(int index) |
CellRangeAddress |
HSSFSheet.getRepeatingColumns() |
CellRangeAddress |
HSSFSheet.getRepeatingRows() |
Modifier and Type | Method and Description |
---|---|
java.util.List<CellRangeAddress> |
HSSFSheet.getMergedRegions() |
Modifier and Type | Method and Description |
---|---|
int |
HSSFSheetConditionalFormatting.addConditionalFormatting(CellRangeAddress[] regions,
ConditionalFormattingRule rule1) |
int |
HSSFSheetConditionalFormatting.addConditionalFormatting(CellRangeAddress[] regions,
ConditionalFormattingRule[] cfRules) |
int |
HSSFSheetConditionalFormatting.addConditionalFormatting(CellRangeAddress[] regions,
ConditionalFormattingRule rule1,
ConditionalFormattingRule rule2) |
int |
HSSFSheetConditionalFormatting.addConditionalFormatting(CellRangeAddress[] regions,
HSSFConditionalFormattingRule rule1) |
int |
HSSFSheetConditionalFormatting.addConditionalFormatting(CellRangeAddress[] regions,
HSSFConditionalFormattingRule[] cfRules)
Allows to add a new Conditional Formatting set to the sheet.
|
int |
HSSFSheetConditionalFormatting.addConditionalFormatting(CellRangeAddress[] regions,
HSSFConditionalFormattingRule rule1,
HSSFConditionalFormattingRule rule2) |
int |
HSSFSheet.addMergedRegion(CellRangeAddress region)
Adds a merged region of cells on a sheet.
|
int |
HSSFSheet.addMergedRegionUnsafe(CellRangeAddress region)
Adds a merged region of cells (hence those cells form one).
|
CellRange<HSSFCell> |
HSSFSheet.setArrayFormula(java.lang.String formula,
CellRangeAddress range) |
HSSFAutoFilter |
HSSFSheet.setAutoFilter(CellRangeAddress range) |
void |
HSSFConditionalFormatting.setFormattingRanges(CellRangeAddress[] ranges) |
void |
HSSFSheet.setRepeatingColumns(CellRangeAddress columnRangeRef) |
void |
HSSFSheet.setRepeatingRows(CellRangeAddress rowRangeRef) |
Modifier and Type | Method and Description |
---|---|
static void |
HSSFRegionUtil.setBorderBottom(int border,
CellRangeAddress region,
HSSFSheet sheet,
HSSFWorkbook workbook)
Deprecated.
Sets the borderBottom attribute of the HSSFRegionUtil object
|
static void |
HSSFRegionUtil.setBorderLeft(int border,
CellRangeAddress region,
HSSFSheet sheet,
HSSFWorkbook workbook)
Deprecated.
Sets the left border for a region of cells by manipulating the cell style
of the individual cells on the left
|
static void |
HSSFRegionUtil.setBorderRight(int border,
CellRangeAddress region,
HSSFSheet sheet,
HSSFWorkbook workbook)
Deprecated.
Sets the borderRight attribute of the HSSFRegionUtil object
|
static void |
HSSFRegionUtil.setBorderTop(int border,
CellRangeAddress region,
HSSFSheet sheet,
HSSFWorkbook workbook)
Deprecated.
Sets the borderBottom attribute of the HSSFRegionUtil object
|
static void |
HSSFRegionUtil.setBottomBorderColor(int color,
CellRangeAddress region,
HSSFSheet sheet,
HSSFWorkbook workbook)
Deprecated.
Sets the bottomBorderColor attribute of the HSSFRegionUtil object
|
static void |
HSSFRegionUtil.setLeftBorderColor(int color,
CellRangeAddress region,
HSSFSheet sheet,
HSSFWorkbook workbook)
Deprecated.
Sets the leftBorderColor attribute of the HSSFRegionUtil object
|
static void |
HSSFRegionUtil.setRightBorderColor(int color,
CellRangeAddress region,
HSSFSheet sheet,
HSSFWorkbook workbook)
Deprecated.
Sets the rightBorderColor attribute of the HSSFRegionUtil object
|
static void |
HSSFRegionUtil.setTopBorderColor(int color,
CellRangeAddress region,
HSSFSheet sheet,
HSSFWorkbook workbook)
Deprecated.
Sets the topBorderColor attribute of the HSSFRegionUtil object
|
Modifier and Type | Method and Description |
---|---|
CellRangeAddress |
EvaluationCell.getArrayFormulaRange() |
CellRangeAddress[] |
EvaluationConditionalFormatRule.getRegions() |
Constructor and Description |
---|
EvaluationConditionalFormatRule(WorkbookEvaluator workbookEvaluator,
Sheet sheet,
ConditionalFormatting formatting,
int formattingIndex,
ConditionalFormattingRule rule,
int ruleIndex,
CellRangeAddress[] regions) |
Modifier and Type | Method and Description |
---|---|
CellRangeAddress |
Cell.getArrayFormulaRange()
Only valid for array formula cells
|
CellRangeAddress[] |
ConditionalFormatting.getFormattingRanges() |
CellRangeAddress |
Sheet.getMergedRegion(int index)
Returns the merged region at the specified index
|
CellRangeAddress |
Sheet.getRepeatingColumns()
Gets the repeating columns used when printing the sheet, as found in
File->PageSetup->Sheet.
|
CellRangeAddress |
Sheet.getRepeatingRows()
Gets the repeating rows used when printing the sheet, as found in
File->PageSetup->Sheet.
|
Modifier and Type | Method and Description |
---|---|
java.util.List<CellRangeAddress> |
Sheet.getMergedRegions()
Returns the list of merged regions.
|
Modifier and Type | Method and Description |
---|---|
int |
SheetConditionalFormatting.addConditionalFormatting(CellRangeAddress[] regions,
ConditionalFormattingRule rule)
Add a new Conditional Formatting to the sheet.
|
int |
SheetConditionalFormatting.addConditionalFormatting(CellRangeAddress[] regions,
ConditionalFormattingRule[] cfRules)
Add a new Conditional Formatting set to the sheet.
|
int |
SheetConditionalFormatting.addConditionalFormatting(CellRangeAddress[] regions,
ConditionalFormattingRule rule1,
ConditionalFormattingRule rule2)
Add a new Conditional Formatting consisting of two rules.
|
int |
Sheet.addMergedRegion(CellRangeAddress region)
Adds a merged region of cells (hence those cells form one)
|
int |
Sheet.addMergedRegionUnsafe(CellRangeAddress region)
Adds a merged region of cells (hence those cells form one).
|
void |
RangeCopier.copyRange(CellRangeAddress tilePatternRange,
CellRangeAddress tileDestRange)
Uses input pattern to tile destination region, overwriting existing content.
|
CellRange<? extends Cell> |
Sheet.setArrayFormula(java.lang.String formula,
CellRangeAddress range)
Sets array formula to specified region for result.
|
AutoFilter |
Sheet.setAutoFilter(CellRangeAddress range)
Enable filtering for a range of cells
|
void |
ConditionalFormatting.setFormattingRanges(CellRangeAddress[] ranges)
Sets the cell ranges the rule conditional formatting must be applied to.
|
void |
Sheet.setRepeatingColumns(CellRangeAddress columnRangeRef)
Sets the repeating columns used when printing the sheet, as found in
File->PageSetup->Sheet.
|
void |
Sheet.setRepeatingRows(CellRangeAddress rowRangeRef)
Sets the repeating rows used when printing the sheet, as found in
File->PageSetup->Sheet.
|
Modifier and Type | Method and Description |
---|---|
static ChartDataSource<java.lang.Number> |
DataSources.fromNumericCellRange(Sheet sheet,
CellRangeAddress cellRangeAddress)
Deprecated.
|
static ChartDataSource<java.lang.String> |
DataSources.fromStringCellRange(Sheet sheet,
CellRangeAddress cellRangeAddress)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static CellRangeAddress |
BaseRowColShifter.shiftRange(FormulaShifter formulaShifter,
CellRangeAddress cra,
int currentExternSheetIx) |
Modifier and Type | Method and Description |
---|---|
java.util.List<CellRangeAddress> |
RowShifter.shiftMergedRegions(int startRow,
int endRow,
int n)
Shifts, grows, or shrinks the merged regions due to a row shift.
|
java.util.List<CellRangeAddress> |
ColumnShifter.shiftMergedRegions(int startColumn,
int endColumn,
int n)
Shifts, grows, or shrinks the merged regions due to a column shift.
|
abstract java.util.List<CellRangeAddress> |
BaseRowColShifter.shiftMergedRegions(int start,
int end,
int n)
Shifts, grows, or shrinks the merged regions due to a row shift
(
RowShifter ) or column shift (ColumnShifter ). |
Modifier and Type | Method and Description |
---|---|
static CellRangeAddress |
BaseRowColShifter.shiftRange(FormulaShifter formulaShifter,
CellRangeAddress cra,
int currentExternSheetIx) |
Modifier and Type | Field and Description |
---|---|
protected java.util.List<CellRangeAddress> |
CellRangeAddressList._list
List of CellRangeAddresses.
|
Modifier and Type | Method and Description |
---|---|
CellRangeAddress |
CellRangeAddress.copy() |
static CellRangeAddress |
CellRangeUtil.createEnclosingCellRange(CellRangeAddress crA,
CellRangeAddress crB)
Create an enclosing CellRange for the two cell ranges.
|
CellRangeAddress |
CellRangeAddressList.getCellRangeAddress(int index) |
CellRangeAddress[] |
CellRangeAddressList.getCellRangeAddresses() |
static CellRangeAddress[] |
CellRangeUtil.mergeCellRanges(CellRangeAddress[] cellRanges)
Do all possible cell merges between cells of the list so that:
if a cell range is completely inside of another cell range, it gets removed from the list if two cells have a shared border, merge them into one bigger cell range |
CellRangeAddress |
CellRangeAddressList.remove(int rangeIndex) |
static CellRangeAddress |
CellRangeAddress.valueOf(java.lang.String ref)
Creates a CellRangeAddress from a cell range reference string.
|
Modifier and Type | Method and Description |
---|---|
void |
CellRangeAddressList.addCellRangeAddress(CellRangeAddress cra) |
static boolean |
CellRangeUtil.contains(CellRangeAddress crA,
CellRangeAddress crB)
Check if cell range A contains cell range B (B <= A)
TODO: move this into
CellRangeAddressBase |
static CellRangeAddress |
CellRangeUtil.createEnclosingCellRange(CellRangeAddress crA,
CellRangeAddress crB)
Create an enclosing CellRange for the two cell ranges.
|
void |
PropertyTemplate.drawBorderColors(CellRangeAddress range,
short color,
BorderExtent extent)
Sets the color for a group of cell borders for a cell range.
|
void |
PropertyTemplate.drawBorders(CellRangeAddress range,
BorderStyle borderType,
BorderExtent extent)
Draws a group of cell borders for a cell range.
|
void |
PropertyTemplate.drawBorders(CellRangeAddress range,
BorderStyle borderType,
short color,
BorderExtent extent)
Draws a group of cell borders for a cell range.
|
static boolean |
CellRangeUtil.hasExactSharedBorder(CellRangeAddress crA,
CellRangeAddress crB)
Check if the two cell ranges have a shared border.
|
static int |
CellRangeUtil.intersect(CellRangeAddress crA,
CellRangeAddress crB)
Get the type of intersection between two cell ranges
|
static CellRangeAddress[] |
CellRangeUtil.mergeCellRanges(CellRangeAddress[] cellRanges)
Do all possible cell merges between cells of the list so that:
if a cell range is completely inside of another cell range, it gets removed from the list if two cells have a shared border, merge them into one bigger cell range |
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 |
---|---|
java.lang.String |
XDDFChart.formatRange(CellRangeAddress range) |
static XDDFNumericalDataSource<java.lang.Double> |
XDDFDataSourcesFactory.fromNumericCellRange(XSSFSheet sheet,
CellRangeAddress cellRangeAddress) |
static XDDFCategoryDataSource |
XDDFDataSourcesFactory.fromStringCellRange(XSSFSheet sheet,
CellRangeAddress cellRangeAddress) |
Modifier and Type | Method and Description |
---|---|
CellRangeAddress |
SXSSFCell.getArrayFormulaRange()
Only valid for array formula cells
|
CellRangeAddress |
SXSSFSheet.getMergedRegion(int index)
Returns the merged region at the specified index.
|
CellRangeAddress |
SXSSFSheet.getRepeatingColumns() |
CellRangeAddress |
SXSSFSheet.getRepeatingRows() |
Modifier and Type | Method and Description |
---|---|
java.util.List<CellRangeAddress> |
SXSSFSheet.getMergedRegions()
Returns the list of merged regions.
|
Modifier and Type | Method and Description |
---|---|
int |
SXSSFSheet.addMergedRegion(CellRangeAddress region)
Adds a merged region of cells (hence those cells form one)
|
int |
SXSSFSheet.addMergedRegionUnsafe(CellRangeAddress region)
Adds a merged region of cells (hence those cells form one)
|
CellRange<? extends Cell> |
SXSSFSheet.setArrayFormula(java.lang.String formula,
CellRangeAddress range)
Sets array formula to specified region for result.
|
AutoFilter |
SXSSFSheet.setAutoFilter(CellRangeAddress range)
Enable filtering for a range of cells
|
void |
SXSSFSheet.setRepeatingColumns(CellRangeAddress columnRangeRef) |
void |
SXSSFSheet.setRepeatingRows(CellRangeAddress rowRangeRef) |
Modifier and Type | Method and Description |
---|---|
CellRangeAddress |
XSSFCell.getArrayFormulaRange() |
CellRangeAddress[] |
XSSFConditionalFormatting.getFormattingRanges() |
CellRangeAddress |
XSSFSheet.getMergedRegion(int index)
Returns the merged region at the specified index.
|
CellRangeAddress |
XSSFSheet.getRepeatingColumns() |
CellRangeAddress |
XSSFSheet.getRepeatingRows() |
Modifier and Type | Method and Description |
---|---|
java.util.Map<IgnoredErrorType,java.util.Set<CellRangeAddress>> |
XSSFSheet.getIgnoredErrors()
Returns the errors currently being ignored and the ranges
where they are ignored.
|
java.util.List<CellRangeAddress> |
XSSFSheet.getMergedRegions()
Returns the list of merged regions.
|
Modifier and Type | Method and Description |
---|---|
int |
XSSFSheetConditionalFormatting.addConditionalFormatting(CellRangeAddress[] regions,
ConditionalFormattingRule rule1) |
int |
XSSFSheetConditionalFormatting.addConditionalFormatting(CellRangeAddress[] regions,
ConditionalFormattingRule[] cfRules) |
int |
XSSFSheetConditionalFormatting.addConditionalFormatting(CellRangeAddress[] regions,
ConditionalFormattingRule rule1,
ConditionalFormattingRule rule2) |
void |
XSSFSheet.addIgnoredErrors(CellRangeAddress region,
IgnoredErrorType... ignoredErrorTypes)
Ignore errors across a range of cells.
|
int |
XSSFSheet.addMergedRegion(CellRangeAddress region)
Adds a merged region of cells on a sheet.
|
int |
XSSFSheet.addMergedRegionUnsafe(CellRangeAddress region)
Adds a merged region of cells (hence those cells form one).
|
CellRange<XSSFCell> |
XSSFSheet.setArrayFormula(java.lang.String formula,
CellRangeAddress range) |
XSSFAutoFilter |
XSSFSheet.setAutoFilter(CellRangeAddress range) |
void |
XSSFConditionalFormatting.setFormattingRanges(CellRangeAddress[] ranges) |
void |
XSSFSheet.setRepeatingColumns(CellRangeAddress columnRangeRef) |
void |
XSSFSheet.setRepeatingRows(CellRangeAddress rowRangeRef) |
Copyright 2020 The Apache Software Foundation or its licensors, as applicable.