org.dromara.hutool.poi.excel

Class SheetUtil

java.lang.Object

org.dromara.hutool.poi.excel.SheetUtil

public class SheetUtil
extends Object

Sheet相关工具类

Since:

6.0.0

Author:

Looly

Constructor Summary

Constructors

Constructor and Description
SheetUtil()

Method Summary

Modifier and Type	Method and Description
static void	addIgnoredErrors(org.apache.poi.ss.usermodel.Sheet sheet, org.apache.poi.ss.util.CellRangeAddress cellRangeAddress, org.apache.poi.ss.usermodel.IgnoredErrorType... ignoredErrorTypes) 设置忽略错误，即Excel中的绿色警告小标，只支持XSSFSheet和SXSSFSheet 见：https://stackoverflow.com/questions/23488221/how-to-remove-warning-in-excel-using-apache-poi-in-java
static org.apache.poi.ss.util.CellRangeAddress	getMergedRegion(org.apache.poi.ss.usermodel.Sheet sheet, int x, int y) 获取指定坐标点对应的合并单元格范围
static org.apache.poi.ss.usermodel.Sheet	getOrCreateSheet(org.apache.poi.ss.usermodel.Workbook book, int sheetIndex) 获取或者创建sheet表 自定义需要读取或写出的Sheet，如果给定的sheet不存在，创建之（命名为默认） 在读取中，此方法用于切换读取的sheet，在写出时，此方法用于新建或者切换sheet
static org.apache.poi.ss.usermodel.Sheet	getOrCreateSheet(org.apache.poi.ss.usermodel.Workbook book, String sheetName) 获取或者创建sheet表 如果sheet表在Workbook中已经存在，则获取之，否则创建之
static boolean	isEmpty(org.apache.poi.ss.usermodel.Sheet sheet) sheet是否为空
static void	walk(org.apache.poi.ss.usermodel.Sheet sheet, org.apache.poi.ss.util.cellwalk.CellHandler cellHandler) 遍历Sheet中的所有单元格
static void	walk(org.apache.poi.ss.usermodel.Sheet sheet, org.apache.poi.ss.util.CellRangeAddress range, org.apache.poi.ss.util.cellwalk.CellHandler cellHandler) 遍历Sheet中的指定区域单元格

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SheetUtil

public SheetUtil()

Method Detail

getOrCreateSheet

public static org.apache.poi.ss.usermodel.Sheet getOrCreateSheet(org.apache.poi.ss.usermodel.Workbook book,
                                                                 String sheetName)

获取或者创建sheet表
如果sheet表在Workbook中已经存在，则获取之，否则创建之

Parameters:

book - 工作簿Workbook

sheetName - 工作表名，null表示默认

Returns:

工作表Sheet

Since:

4.0.2

getOrCreateSheet

public static org.apache.poi.ss.usermodel.Sheet getOrCreateSheet(org.apache.poi.ss.usermodel.Workbook book,
                                                                 int sheetIndex)

获取或者创建sheet表
自定义需要读取或写出的Sheet，如果给定的sheet不存在，创建之（命名为默认）
在读取中，此方法用于切换读取的sheet，在写出时，此方法用于新建或者切换sheet

Parameters:

book - 工作簿Workbook

sheetIndex - 工作表序号

Returns:

工作表Sheet

Since:

5.2.1

isEmpty

public static boolean isEmpty(org.apache.poi.ss.usermodel.Sheet sheet)

sheet是否为空

Parameters:

sheet - Sheet

Returns:

sheet是否为空

Since:

4.0.1

walk

public static void walk(org.apache.poi.ss.usermodel.Sheet sheet,
                        org.apache.poi.ss.util.cellwalk.CellHandler cellHandler)

遍历Sheet中的所有单元格

Parameters:

sheet - Sheet

cellHandler - 单元格处理器

walk

public static void walk(org.apache.poi.ss.usermodel.Sheet sheet,
                        org.apache.poi.ss.util.CellRangeAddress range,
                        org.apache.poi.ss.util.cellwalk.CellHandler cellHandler)

遍历Sheet中的指定区域单元格

Parameters:

sheet - Sheet

range - 区域

cellHandler - 单元格处理器

addIgnoredErrors

public static void addIgnoredErrors(org.apache.poi.ss.usermodel.Sheet sheet,
                                    org.apache.poi.ss.util.CellRangeAddress cellRangeAddress,
                                    org.apache.poi.ss.usermodel.IgnoredErrorType... ignoredErrorTypes)
                             throws UnsupportedOperationException

设置忽略错误，即Excel中的绿色警告小标，只支持XSSFSheet和SXSSFSheet
见：https://stackoverflow.com/questions/23488221/how-to-remove-warning-in-excel-using-apache-poi-in-java

Parameters:

sheet - Sheet

cellRangeAddress - 指定单元格范围

ignoredErrorTypes - 忽略的错误类型列表

Throws:

UnsupportedOperationException - 如果sheet不是XSSFSheet

Since:

5.8.28

getMergedRegion

public static org.apache.poi.ss.util.CellRangeAddress getMergedRegion(org.apache.poi.ss.usermodel.Sheet sheet,
                                                                      int x,
                                                                      int y)

获取指定坐标点对应的合并单元格范围

Parameters:

sheet - Sheet

x - x坐标，即列号

y - 行号

Returns:

CellRangeAddress or null