jexx.poi

接口 SheetWriter

所有超级接口:

SheetCellWriter, SheetRowWriter

所有已知子接口:

SheetBigWriter

所有已知实现类:

SheetBigWriterImpl, SheetWriterImpl

public interface SheetWriter
extends SheetRowWriter, SheetCellWriter

sheet写入器抽象接口

从以下版本开始:

2019/10/2

方法概要

限定符和类型	方法和说明
void	autoSizeColumn(Headers headers) 指定 header 对应的列 自动扩展 列宽
void	autoSizeColumn(int... columnNums) 指定某几列自动扩展列宽
void	autoSizeColumnWithMaxColumnNum(int maxColumnNum) 小于等于指定列号的列 自动扩展列宽
void	fill(int fillStartRowNum, int fillEndRowNum, java.util.List<?> rows, Headers headers) 指定起始行到结束行填充多行数据
int	getCurrentRowNum() 获取当前行号,从1开始
void	jumpToRowNum(int rowNum) 直接跳至某一行
void	passCurrentRow() 跳过当前行
void	setColumnWidth(int columnNum, int width) 设置指定列指定宽度
void	skipRows(int skipRowNum) 跳过指定几行
void	validData(int rowCount, Headers headers) 下一行开始构建指定行数的单元格约束
void	validData(int startRowNum, int rowCount, Headers headers) 指定行开始构建指定行数的单元格约束
void	writeHeader(Headers headers) 下一行写入header
void	writeHeader(Headers headers, CellStyleMapper cellStyleMapper) 下一行写入header
void	writeHeader(int rowNum, Headers headers) 指定行写入headers
void	writeHeader(int rowNum, Headers headers, CellStyleMapper cellStyleMapper) 指定行写入headers
RowContext	writeListRow(int startRowNum, int columnNum, java.util.List<?> rowData, CellStyleMapper cellStyleMapper) 指定行指定列 开始写入一行数据
RowContext	writeListRow(int columnNum, java.util.List<?> rowData, CellStyleMapper cellStyleMapper) 下一行 指定列 开始写入一行数据
RowContext	writeListRow(java.util.List<?> rowData) 下一行 第一列 开始写入一行数据
RowContext	writeListRow(java.util.List<?> rowData, CellStyleMapper cellStyleMapper) 下一行 第一列 开始写入一行数据
RowContext	writeMapRow(int rowNum, java.util.Map<java.lang.String,java.lang.Object> map, Headers headers) 指定行写入map
RowContext	writeMapRow(int rowNum, java.util.Map<java.lang.String,java.lang.Object> map, Headers headers, CellStyleMapper cellStyleMapper) 指定行写入map
RowContext	writeMapRow(java.util.Map<java.lang.String,java.lang.Object> rowData, Headers headers) 下一行写入map
RowContext	writeMapRow(java.util.Map<java.lang.String,java.lang.Object> rowData, Headers headers, CellStyleMapper cellStyleMapper) 下一行写入map
int	writeMapRows(int startRowNum, java.util.List<java.util.Map<java.lang.String,java.lang.Object>> rows, Headers headers) 指定行指定header写入多行数据
int	writeMapRows(int startRowNum, java.util.List<java.util.Map<java.lang.String,java.lang.Object>> rows, Headers headers, CellStyleMapper cellStyleMapper) 指定行指定header写入多行数据
int	writeMapRows(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> rows, Headers headers) 下一行行指定header写入多行数据
int	writeMapRows(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> rows, Headers headers, CellStyleMapper cellStyleMapper) 下一行行指定header写入多行数据
RowContext	writeRow(int startRowNum, java.lang.Object rowData, Headers headers) 指定行指定header写入一个对象
RowContext	writeRow(int startRowNum, java.lang.Object rowData, Headers headers, CellStyleMapper cellStyleMapper) 指定行指定header写入一个对象
RowContext	writeRow(java.lang.Object rowData, Headers headers) 下一行指定header写入一个对象
RowContext	writeRow(java.lang.Object rowData, Headers headers, CellStyleMapper cellStyleMapper) 下一行指定header写入一个对象
int	writeRows(int startRowNum, int columnNum, java.util.List<?> rows) 指定行指定列开始写入多行数据
int	writeRows(int startRowNum, int columnNum, java.util.List<?> rows, CellStyleMapper cellStyleMapper) 指定行指定列开始写入多行数据
int	writeRows(int columnNum, java.util.List<?> rows) 下一行指定列开始写入多行数据
int	writeRows(int columnNum, java.util.List<?> rows, CellStyleMapper cellStyleMapper) 下一行指定列开始写入多行数据
default <T> int	writeRows(int startRowNum, java.util.List<T> rows, Headers headers) 指定行指定header写入多行数据
<T> int	writeRows(int startRowNum, java.util.List<T> rows, Headers headers, java.util.function.BiConsumer<IMergedCell,T> consumer) 指定行指定header写入多行数据
default <T> int	writeRows(int startRowNum, java.util.List<T> rows, Headers headers, CellStyleMapper cellStyleMapper) 指定行指定header写入多行数据
int	writeRows(java.util.List<?> rows) 下一行第一列开始写入多行数据
int	writeRows(java.util.List<?> rows, CellStyleMapper cellStyleMapper) 下一行第一列开始写入多行数据
default <T> int	writeRows(java.util.List<T> rows, Headers headers) 下一行行指定header写入多行数据
<T> int	writeRows(java.util.List<T> rows, Headers headers, java.util.function.BiConsumer<IMergedCell,T> consumer) 下一行指定header写入多行数据
default <T> int	writeRows(java.util.List<T> rows, Headers headers, CellStyleMapper cellStyleMapper) 下一行指定header写入多行数据

从接口继承的方法 jexx.poi.writer.SheetRowWriter

writeRow, writeRow, writeRow

从接口继承的方法 jexx.poi.writer.SheetCellWriter

flush, setSupportValid, writeCell, writeCell, writeCell, writeCell

方法详细资料

getCurrentRowNum

int getCurrentRowNum()

获取当前行号,从1开始

返回:

当前行号

passCurrentRow

void passCurrentRow()

跳过当前行

skipRows

void skipRows(int skipRowNum)

跳过指定几行

参数:

skipRowNum - 指定几行

jumpToRowNum

void jumpToRowNum(int rowNum)

直接跳至某一行

参数:

rowNum - 指定行号

writeHeader

void writeHeader(int rowNum,
                 Headers headers,
                 CellStyleMapper cellStyleMapper)

指定行写入headers

参数:

rowNum - 指定行

headers - Headers

cellStyleMapper - CellStyleMapper

writeHeader

void writeHeader(int rowNum,
                 Headers headers)

指定行写入headers

参数:

rowNum - 指定行

headers - Headers

writeHeader

void writeHeader(Headers headers,
                 CellStyleMapper cellStyleMapper)

下一行写入header

参数:

headers - Headers

cellStyleMapper - CellStyleMapper

writeHeader

void writeHeader(Headers headers)

下一行写入header

参数:

headers - Headers

writeRows

int writeRows(int startRowNum,
              int columnNum,
              java.util.List<?> rows,
              CellStyleMapper cellStyleMapper)

指定行指定列开始写入多行数据

参数:

startRowNum - 开始行

columnNum - 指定列

rows - 多行数据

cellStyleMapper - CellStyleMapper

返回:

结束行, 未写入数据返回-1

writeRows

int writeRows(int startRowNum,
              int columnNum,
              java.util.List<?> rows)

指定行指定列开始写入多行数据

参数:

startRowNum - 开始行

columnNum - 指定列

rows - 多行数据

返回:

结束行, 未写入数据返回-1

writeRows

int writeRows(int columnNum,
              java.util.List<?> rows,
              CellStyleMapper cellStyleMapper)

下一行指定列开始写入多行数据

参数:

columnNum - 指定列

rows - 多行数据

cellStyleMapper - CellStyleMapper

返回:

结束行, 未写入数据返回-1

writeRows

int writeRows(int columnNum,
              java.util.List<?> rows)

下一行指定列开始写入多行数据

参数:

columnNum - 指定列

rows - 多行数据

返回:

结束行, 未写入数据返回-1

writeRows

int writeRows(java.util.List<?> rows,
              CellStyleMapper cellStyleMapper)

下一行第一列开始写入多行数据

参数:

rows - 多行数据

cellStyleMapper - CellStyleMapper

返回:

结束行, 未写入数据返回-1

writeRows

int writeRows(java.util.List<?> rows)

下一行第一列开始写入多行数据

参数:

rows - 多行数据

返回:

结束行, 未写入数据返回-1

writeRows

<T> int writeRows(int startRowNum,
                  java.util.List<T> rows,
                  Headers headers,
                  java.util.function.BiConsumer<IMergedCell,T> consumer)

指定行指定header写入多行数据

参数:

startRowNum - 开始行

rows - 多行数据

headers - Headers

consumer - 加工cell

返回:

结束行, 未写入数据返回-1

writeRows

default <T> int writeRows(int startRowNum,
                          java.util.List<T> rows,
                          Headers headers,
                          CellStyleMapper cellStyleMapper)

指定行指定header写入多行数据

参数:

startRowNum - 开始行

rows - 多行数据

headers - Headers

cellStyleMapper - CellStyleMapper

返回:

结束行, 未写入数据返回-1

writeRows

default <T> int writeRows(int startRowNum,
                          java.util.List<T> rows,
                          Headers headers)

指定行指定header写入多行数据

参数:

startRowNum - 开始行

rows - 多行数据

headers - Headers

返回:

结束行, 未写入数据返回-1

writeRows

<T> int writeRows(java.util.List<T> rows,
                  Headers headers,
                  java.util.function.BiConsumer<IMergedCell,T> consumer)

下一行指定header写入多行数据

参数:

rows - 多行数据

headers - Headers

consumer - 加工cell

返回:

结束行, 未写入数据返回-1

writeRows

default <T> int writeRows(java.util.List<T> rows,
                          Headers headers,
                          CellStyleMapper cellStyleMapper)

下一行指定header写入多行数据

参数:

rows - 多行数据

headers - Headers

cellStyleMapper - CellStyleMapper

返回:

结束行, 未写入数据返回-1

writeRows

default <T> int writeRows(java.util.List<T> rows,
                          Headers headers)

下一行行指定header写入多行数据

参数:

rows - 多行数据

headers - Headers

返回:

结束行, 未写入数据返回-1

writeMapRows

int writeMapRows(int startRowNum,
                 java.util.List<java.util.Map<java.lang.String,java.lang.Object>> rows,
                 Headers headers,
                 CellStyleMapper cellStyleMapper)

指定行指定header写入多行数据

参数:

startRowNum - 开始行

rows - 多行数据

headers - Headers

cellStyleMapper - CellStyleMapper

返回:

结束行, 未写入数据返回-1

writeMapRows

int writeMapRows(int startRowNum,
                 java.util.List<java.util.Map<java.lang.String,java.lang.Object>> rows,
                 Headers headers)

指定行指定header写入多行数据

参数:

startRowNum - 开始行

rows - 多行数据

headers - Headers

返回:

结束行, 未写入数据返回-1

writeMapRows

int writeMapRows(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> rows,
                 Headers headers,
                 CellStyleMapper cellStyleMapper)

下一行行指定header写入多行数据

参数:

rows - 多行数据

headers - Headers

cellStyleMapper - CellStyleMapper

返回:

结束行, 未写入数据返回-1

writeMapRows

int writeMapRows(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> rows,
                 Headers headers)

下一行行指定header写入多行数据

参数:

rows - 多行数据

headers - Headers

返回:

结束行, 未写入数据返回-1

fill

void fill(int fillStartRowNum,
          int fillEndRowNum,
          java.util.List<?> rows,
          Headers headers)

指定起始行到结束行填充多行数据

参数:

fillStartRowNum - 起始行

fillEndRowNum - 结束行

rows - 多行数据

headers - Headers

writeRow

RowContext writeRow(int startRowNum,
                    java.lang.Object rowData,
                    Headers headers,
                    CellStyleMapper cellStyleMapper)

指定行指定header写入一个对象

参数:

startRowNum - 开始行

rowData - 对象

headers - Headers

cellStyleMapper - CellStyleMapper

返回:

RowContext

writeRow

RowContext writeRow(int startRowNum,
                    java.lang.Object rowData,
                    Headers headers)

指定行指定header写入一个对象

参数:

startRowNum - 开始行

rowData - 对象

headers - Headers

返回:

RowContext

writeRow

RowContext writeRow(java.lang.Object rowData,
                    Headers headers,
                    CellStyleMapper cellStyleMapper)

下一行指定header写入一个对象

参数:

rowData - 对象

headers - Headers

cellStyleMapper - CellStyleMapper

返回:

RowContext

writeRow

RowContext writeRow(java.lang.Object rowData,
                    Headers headers)

下一行指定header写入一个对象

参数:

rowData - 对象

headers - Headers

返回:

RowContext

writeListRow

RowContext writeListRow(int startRowNum,
                        int columnNum,
                        java.util.List<?> rowData,
                        CellStyleMapper cellStyleMapper)

指定行指定列 开始写入一行数据

参数:

startRowNum - 开始写入行

columnNum - 列号

rowData - 一行数据

cellStyleMapper - CellStyleMapper

返回:

RowContext

writeListRow

RowContext writeListRow(int columnNum,
                        java.util.List<?> rowData,
                        CellStyleMapper cellStyleMapper)

下一行 指定列 开始写入一行数据

参数:

columnNum - 列号

rowData - 一行数据

cellStyleMapper - CellStyleMapper

返回:

RowContext

writeListRow

RowContext writeListRow(java.util.List<?> rowData,
                        CellStyleMapper cellStyleMapper)

下一行 第一列 开始写入一行数据

参数:

rowData - 一行数据

cellStyleMapper - CellStyleMapper

返回:

RowContext

writeListRow

RowContext writeListRow(java.util.List<?> rowData)

下一行 第一列 开始写入一行数据

参数:

rowData - 一行数据

返回:

RowContext

writeMapRow

RowContext writeMapRow(int rowNum,
                       java.util.Map<java.lang.String,java.lang.Object> map,
                       Headers headers,
                       CellStyleMapper cellStyleMapper)

指定行写入map

参数:

rowNum - 指定行

map - map

headers - Headers

cellStyleMapper - CellStyleMapper

返回:

RowContext

writeMapRow

RowContext writeMapRow(int rowNum,
                       java.util.Map<java.lang.String,java.lang.Object> map,
                       Headers headers)

指定行写入map

参数:

rowNum - 指定行

map - map数据

headers - Headers

返回:

RowContext

writeMapRow

RowContext writeMapRow(java.util.Map<java.lang.String,java.lang.Object> rowData,
                       Headers headers,
                       CellStyleMapper cellStyleMapper)

下一行写入map

参数:

rowData - map数据

headers - Headers

cellStyleMapper - CellStyleMapper

返回:

RowContext

writeMapRow

RowContext writeMapRow(java.util.Map<java.lang.String,java.lang.Object> rowData,
                       Headers headers)

下一行写入map

参数:

rowData - map数据

headers - Headers

返回:

RowContext

validData

void validData(int startRowNum,
               int rowCount,
               Headers headers)

指定行开始构建指定行数的单元格约束

参数:

startRowNum - 指定开始行

rowCount - 约束行数

headers - Headers

validData

void validData(int rowCount,
               Headers headers)

下一行开始构建指定行数的单元格约束

参数:

rowCount - 约束行数

headers - Headers

autoSizeColumn

void autoSizeColumn(int... columnNums)

指定某几列自动扩展列宽

参数:

columnNums - 指定列号

autoSizeColumn

void autoSizeColumn(Headers headers)

指定 header 对应的列 自动扩展 列宽

参数:

headers - Headers

autoSizeColumnWithMaxColumnNum

void autoSizeColumnWithMaxColumnNum(int maxColumnNum)

小于等于指定列号的列 自动扩展列宽

参数:

maxColumnNum - 指定列号

setColumnWidth

void setColumnWidth(int columnNum,
                    int width)

设置指定列指定宽度

参数:

columnNum - 指定列

width - 列宽