org.ttzero.excel.entity

接口 ICellValueAndStyle

所有已知实现类:

CSVCellValueAndStyle, XMLCellValueAndStyle, XMLZebraLineCellValueAndStyle

public interface ICellValueAndStyle

数据转换并设置样式，将数据写到工作表输出协议之前统一处理数据和样式

作者:

guanquan.wang at 2019-09-25 11:24

方法概要

限定符和类型	方法和说明
default void	conversion(Row row, Cell cell, Object o, Column hc) 动态转换单元格的值
default void	downloadRemoteResource(Row row, Cell cell, String e, Column hc, Class<?> clazz) 下载远程资源 注意：默认情况下仅将单元格类型标记为REMOTE_URL并不会去下载资源。
default int	getStyleIndex(Row row, Column hc, Object o) 获取单元格样式值，先通过Column获取基础样式，如果有动态样式转换则将基础样式做为参数进行二次制作
default boolean	isAllowDirectOutput(Class<?> clazz) 检查数据类型是否可简单导出，简单导出的类型是相对于实体而言，它们一定是Java内置类型且被其它实体组合使用
default void	reset(Row row, Cell cell, Object e, Column hc) 重置单元格的值和样式，Row和Cell都是内存共享的，所以每个单元格均需要重置值和样式
default void	setCellValue(Row row, Cell cell, Object e, Column hc, Class<?> clazz, boolean hasConversion) 设置单元格的值，如果有动态转换器则调用转换器
default void	setNullValue(Row row, Cell cell, Column hc) 写null值到单元格
default <T> void	setStyleDesign(T o, Cell cell, Column hc, StyleProcessor<T> styleProcessor) 行级样式转换器，它的优先级最高
default void	unknownType(Row row, Cell cell, Object e, Column hc, Class<?> clazz) 未知类型转换，可覆写本方法以支持扩展类型
default void	writeAsMedia(Row row, Cell cell, String e, Column hc, Class<?> clazz) 将字符串转为Media类型，仅当以Media类型导出时才会被执行， 支持Base64图片和图片url，

方法详细资料

reset

default void reset(Row row,
                   Cell cell,
                   Object e,
                   Column hc)

重置单元格的值和样式，Row和Cell都是内存共享的，所以每个单元格均需要重置值和样式

参数:

row - 行信息

cell - 单元格

e - 单元格的值

hc - 当前列的表头

getStyleIndex

default int getStyleIndex(Row row,
                          Column hc,
                          Object o)

获取单元格样式值，先通过Column获取基础样式，如果有动态样式转换则将基础样式做为参数进行二次制作

参数:

row - 行信息

hc - 当前列的表头

o - 单元格的值

返回:

样式值

setStyleDesign

default <T> void setStyleDesign(T o,
                                Cell cell,
                                Column hc,
                                StyleProcessor<T> styleProcessor)

行级样式转换器，它的优先级最高

类型参数:

T - the row's class

参数:

o - 行值，可能是Map，Java实体或ResultSet

cell - 单元格

hc - 当前列的表头

styleProcessor - 样式转换器StyleProcessor

setCellValue

default void setCellValue(Row row,
                          Cell cell,
                          Object e,
                          Column hc,
                          Class<?> clazz,
                          boolean hasConversion)

设置单元格的值，如果有动态转换器则调用转换器

参数:

row - 行信息

cell - 单元格

e - 单元格的值

hc - 当前列的表头

clazz - 单元格值的数据类型

hasConversion - 是否有输出转换器

setNullValue

default void setNullValue(Row row,
                          Cell cell,
                          Column hc)

写null值到单元格

参数:

row - 行信息

cell - 单元格

hc - 当前列的表头

conversion

default void conversion(Row row,
                        Cell cell,
                        Object o,
                        Column hc)

动态转换单元格的值

参数:

row - 行信息

cell - 单元格

o - 单元格的值

hc - 当前列的表头

unknownType

default void unknownType(Row row,
                         Cell cell,
                         Object e,
                         Column hc,
                         Class<?> clazz)

未知类型转换，可覆写本方法以支持扩展类型

参数:

row - 行信息

cell - 单元格

e - 单元格的值

hc - 当前列的表头

clazz - 单元格值的数据类型

writeAsMedia

default void writeAsMedia(Row row,
                          Cell cell,
                          String e,
                          Column hc,
                          Class<?> clazz)

将字符串转为Media类型，仅当以Media类型导出时才会被执行， 支持Base64图片和图片url，

参数:

row - 行信息

cell - 单元格

e - 单元格的值

hc - 当前列的表头

clazz - 单元格值的数据类型

downloadRemoteResource

default void downloadRemoteResource(Row row,
                                    Cell cell,
                                    String e,
                                    Column hc,
                                    Class<?> clazz)

下载远程资源

注意：默认情况下仅将单元格类型标记为REMOTE_URL并不会去下载资源。 下载动作延迟在IWorksheetWriter#writeRemoteMedia中进行。 当然，也可以在本方法下载并调用Cell.setInputStream(java.io.InputStream)或Cell.setBinary(byte[]) 将流或二进制结果保存到单元格中

参数:

row - 行信息

cell - 单元格

e - 单元格的值

hc - 当前列的表头

clazz - 单元格值的数据类型

isAllowDirectOutput

default boolean isAllowDirectOutput(Class<?> clazz)

检查数据类型是否可简单导出，简单导出的类型是相对于实体而言，它们一定是Java内置类型且被其它实体组合使用

参数:

clazz - 数据类型

返回:

true如果是简单类型