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 |
record aggregates are not real "records" but collections of records that act as a single record.
|
org.apache.poi.hssf.record.cf | |
org.apache.poi.hssf.usermodel |
usermodel package maps HSSF low level strutures to familiar workbook/sheet model
|
org.apache.poi.hssf.util |
util package contains tools needed for writing HSSF files that are not necesarily "real"
HSSF concepts.
|
org.apache.poi.ss.usermodel | |
org.apache.poi.ss.usermodel.charts | |
org.apache.poi.ss.util | |
org.apache.poi.ss.util.cellwalk | |
org.apache.poi.xssf.streaming | |
org.apache.poi.xssf.usermodel | |
org.apache.poi.xssf.usermodel.helpers |
Modifier and Type | Method | Description |
---|---|---|
static CellRangeAddress[][] |
ExcelToHtmlUtils.buildMergedRangesMap(HSSFSheet sheet) |
Creates a map (i.e.
|
static CellRangeAddress |
AbstractExcelUtils.getMergedRange(CellRangeAddress[][] mergedRanges,
int rowNumber,
int columnNumber) |
Modifier and Type | Method | Description |
---|---|---|
static CellRangeAddress |
AbstractExcelUtils.getMergedRange(CellRangeAddress[][] mergedRanges,
int rowNumber,
int columnNumber) |
|
protected int |
ExcelToFoConverter.processRow(HSSFWorkbook workbook,
CellRangeAddress[][] mergedRanges,
HSSFRow row,
org.w3c.dom.Element tableRowElement) |
|
protected int |
ExcelToHtmlConverter.processRow(CellRangeAddress[][] mergedRanges,
HSSFRow row,
org.w3c.dom.Element tableRowElement) |
Modifier and Type | Method | Description |
---|---|---|
CellRangeAddress |
InternalSheet.getMergedRegionAt(int index) |
Modifier and Type | Method | Description |
---|---|---|
CellRangeAddress |
MergeCellsRecord.getAreaAt(int index) |
|
CellRangeAddress[] |
CFHeaderRecord.getCellRanges() |
|
CellRangeAddress[] |
FeatRecord.getCellRefs() |
|
CellRangeAddress |
CFHeaderRecord.getEnclosingCellRange() |
Modifier and Type | Method | Description |
---|---|---|
void |
CFHeaderRecord.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 |
CFHeaderRecord.setEnclosingCellRange(CellRangeAddress cr) |
Constructor | Description |
---|---|
CFHeaderRecord(CellRangeAddress[] regions,
int nRules) |
|
MergeCellsRecord(CellRangeAddress[] regions,
int startIndex,
int numberOfRegions) |
Modifier and Type | Method | Description |
---|---|---|
CellRangeAddress |
MergedCellsTable.get(int index) |
|
CellRangeAddress |
FormulaRecordAggregate.getArrayFormulaRange() |
|
CellRangeAddress |
FormulaRecordAggregate.removeArrayFormula(int rowIndex,
int columnIndex) |
Removes an array formula
|
Modifier and Type | Method | Description |
---|---|---|
void |
FormulaRecordAggregate.setArrayFormula(CellRangeAddress r,
Ptg[] ptgs) |
Constructor | Description |
---|---|
CFRecordsAggregate(CellRangeAddress[] regions,
CFRuleRecord[] rules) |
Modifier and Type | Method | Description |
---|---|---|
static CellRangeAddress |
CellRangeUtil.createEnclosingCellRange(CellRangeAddress crA,
CellRangeAddress crB) |
Create an enclosing CellRange for the 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 |
Modifier and Type | Method | Description |
---|---|---|
static boolean |
CellRangeUtil.contains(CellRangeAddress crA,
CellRangeAddress crB) |
Check if the specified range is located inside of this cell range.
|
static CellRangeAddress |
CellRangeUtil.createEnclosingCellRange(CellRangeAddress crA,
CellRangeAddress crB) |
Create an enclosing CellRange for the two cell ranges.
|
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) |
Intersect this range with the specified range.
|
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 |
Modifier and Type | Method | Description |
---|---|---|
CellRangeAddress |
HSSFCell.getArrayFormulaRange() |
|
CellRangeAddress[] |
HSSFConditionalFormatting.getFormattingRanges() |
|
CellRangeAddress |
HSSFSheet.getMergedRegion(int index) |
|
CellRangeAddress |
HSSFSheet.getRepeatingColumns() |
|
CellRangeAddress |
HSSFSheet.getRepeatingRows() |
Modifier and Type | Method | Description |
---|---|---|
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 |
HSSFSheetConditionalFormatting.addConditionalFormatting(CellRangeAddress[] regions,
ConditionalFormattingRule rule1) |
|
int |
HSSFSheetConditionalFormatting.addConditionalFormatting(CellRangeAddress[] regions,
ConditionalFormattingRule[] cfRules) |
|
int |
HSSFSheetConditionalFormatting.addConditionalFormatting(CellRangeAddress[] regions,
ConditionalFormattingRule rule1,
ConditionalFormattingRule rule2) |
|
int |
HSSFSheet.addMergedRegion(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 |
HSSFSheet.setRepeatingColumns(CellRangeAddress columnRangeRef) |
|
void |
HSSFSheet.setRepeatingRows(CellRangeAddress rowRangeRef) |
Modifier and Type | Class | Description |
---|---|---|
class |
CellRangeAddress |
Deprecated.
use
CellRangeAddress |
Modifier and Type | Method | Description |
---|---|---|
static void |
HSSFRegionUtil.setBorderBottom(int border,
CellRangeAddress region,
HSSFSheet sheet,
HSSFWorkbook workbook) |
Sets the borderBottom attribute of the HSSFRegionUtil object
|
static void |
HSSFRegionUtil.setBorderLeft(int border,
CellRangeAddress region,
HSSFSheet sheet,
HSSFWorkbook workbook) |
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) |
Sets the borderRight attribute of the HSSFRegionUtil object
|
static void |
HSSFRegionUtil.setBorderTop(int border,
CellRangeAddress region,
HSSFSheet sheet,
HSSFWorkbook workbook) |
Sets the borderBottom attribute of the HSSFRegionUtil object
|
static void |
HSSFRegionUtil.setBottomBorderColor(int color,
CellRangeAddress region,
HSSFSheet sheet,
HSSFWorkbook workbook) |
Sets the bottomBorderColor attribute of the HSSFRegionUtil object
|
static void |
HSSFRegionUtil.setLeftBorderColor(int color,
CellRangeAddress region,
HSSFSheet sheet,
HSSFWorkbook workbook) |
Sets the leftBorderColor attribute of the HSSFRegionUtil object
|
static void |
HSSFRegionUtil.setRightBorderColor(int color,
CellRangeAddress region,
HSSFSheet sheet,
HSSFWorkbook workbook) |
Sets the rightBorderColor attribute of the HSSFRegionUtil object
|
static void |
HSSFRegionUtil.setTopBorderColor(int color,
CellRangeAddress region,
HSSFSheet sheet,
HSSFWorkbook workbook) |
Sets the topBorderColor attribute of the HSSFRegionUtil object
|
Modifier and Type | Method | 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 | 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)
|
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 |
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 | Description |
---|---|---|
static ChartDataSource<java.lang.Number> |
DataSources.fromNumericCellRange(Sheet sheet,
CellRangeAddress cellRangeAddress) |
|
static ChartDataSource<java.lang.String> |
DataSources.fromStringCellRange(Sheet sheet,
CellRangeAddress cellRangeAddress) |
Modifier and Type | Field | Description |
---|---|---|
protected java.util.List<CellRangeAddress> |
CellRangeAddressList._list |
List of CellRangeAddresses.
|
Modifier and Type | Method | Description |
---|---|---|
static CellRangeAddress[] |
Region.convertRegionsToCellRanges(Region[] regions) |
Deprecated.
|
static CellRangeAddress |
Region.convertToCellRangeAddress(Region r) |
Deprecated.
|
CellRangeAddress |
CellRangeAddress.copy() |
|
CellRangeAddress |
CellRangeAddressList.getCellRangeAddress(int index) |
|
CellRangeAddress[] |
CellRangeAddressList.getCellRangeAddresses() |
|
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 | Description |
---|---|---|
void |
CellRangeAddressList.addCellRangeAddress(CellRangeAddress cra) |
|
static boolean |
SheetUtil.containsCell(CellRangeAddress cr,
int rowIx,
int colIx) |
|
static Region[] |
Region.convertCellRangesToRegions(CellRangeAddress[] cellRanges) |
Deprecated.
Convert a List of CellRange objects to an array of regions
|
static void |
RegionUtil.setBorderBottom(int border,
CellRangeAddress region,
Sheet sheet,
Workbook workbook) |
Sets the borderBottom attribute of the RegionUtil object
|
static void |
RegionUtil.setBorderLeft(int border,
CellRangeAddress region,
Sheet sheet,
Workbook workbook) |
Sets the left border for a region of cells by manipulating the cell style of the individual
cells on the left
|
static void |
RegionUtil.setBorderRight(int border,
CellRangeAddress region,
Sheet sheet,
Workbook workbook) |
Sets the borderRight attribute of the RegionUtil object
|
static void |
RegionUtil.setBorderTop(int border,
CellRangeAddress region,
Sheet sheet,
Workbook workbook) |
Sets the borderBottom attribute of the RegionUtil object
|
static void |
RegionUtil.setBottomBorderColor(int color,
CellRangeAddress region,
Sheet sheet,
Workbook workbook) |
Sets the bottomBorderColor attribute of the RegionUtil object
|
static void |
RegionUtil.setLeftBorderColor(int color,
CellRangeAddress region,
Sheet sheet,
Workbook workbook) |
Sets the leftBorderColor attribute of the RegionUtil object
|
static void |
RegionUtil.setRightBorderColor(int color,
CellRangeAddress region,
Sheet sheet,
Workbook workbook) |
Sets the rightBorderColor attribute of the RegionUtil object
|
static void |
RegionUtil.setTopBorderColor(int color,
CellRangeAddress region,
Sheet sheet,
Workbook workbook) |
Sets the topBorderColor attribute of the RegionUtil object
|
Constructor | Description |
---|---|
CellWalk(Sheet sheet,
CellRangeAddress range) |
Modifier and Type | Method | 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 | Description |
---|---|---|
int |
SXSSFSheet.addMergedRegion(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 | Description |
---|---|---|
CellRangeAddress |
XSSFCell.getArrayFormulaRange() |
|
CellRangeAddress[] |
XSSFConditionalFormatting.getFormattingRanges() |
|
CellRangeAddress |
XSSFSheet.getMergedRegion(int index) |
|
CellRangeAddress |
XSSFSheet.getRepeatingColumns() |
|
CellRangeAddress |
XSSFSheet.getRepeatingRows() |
Modifier and Type | Method | Description |
---|---|---|
int |
XSSFSheetConditionalFormatting.addConditionalFormatting(CellRangeAddress[] regions,
ConditionalFormattingRule rule1) |
|
int |
XSSFSheetConditionalFormatting.addConditionalFormatting(CellRangeAddress[] regions,
ConditionalFormattingRule[] cfRules) |
|
int |
XSSFSheetConditionalFormatting.addConditionalFormatting(CellRangeAddress[] regions,
ConditionalFormattingRule rule1,
ConditionalFormattingRule rule2) |
|
int |
XSSFSheet.addMergedRegion(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 |
XSSFSheet.setRepeatingColumns(CellRangeAddress columnRangeRef) |
|
void |
XSSFSheet.setRepeatingRows(CellRangeAddress rowRangeRef) |
Modifier and Type | Method | Description |
---|---|---|
java.util.List<CellRangeAddress> |
XSSFRowShifter.shiftMerged(int startRow,
int endRow,
int n) |
Shift merged regions
|
Copyright 2018 The Apache Software Foundation or its licensors, as applicable.