cn.allbs.excel.handle

类 AbstractSheetWriteHandler

java.lang.Object

cn.allbs.excel.handle.AbstractSheetWriteHandler

所有已实现的接口:

SheetWriteHandler, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

直接已知子类:

ManySheetWriteHandler, SingleSheetWriteHandler

public abstract class AbstractSheetWriteHandler
extends java.lang.Object
implements SheetWriteHandler, org.springframework.context.ApplicationContextAware

功能:

从以下版本开始:

2021/3/29

版本:

1.0

作者:

ChenQi

字段概要

字段

限定符和类型	字段和说明
private org.springframework.context.ApplicationContext	applicationContext
private ExcelConfigProperties	configProperties
private org.springframework.beans.factory.ObjectProvider<java.util.List<com.alibaba.excel.converters.Converter<?>>>	converterProvider
private WriterBuilderEnhancer	excelWriterBuilderEnhance
private I18nHeaderCellWriteHandler	i18nHeaderCellWriteHandler

构造器概要

构造器

构造器和说明
AbstractSheetWriteHandler()

方法概要

限定符和类型	方法和说明
void	check(ExportExcel responseExcel) 校验
void	export(java.lang.Object o, javax.servlet.http.HttpServletResponse response, ExportExcel responseExcel) 返回的对象
private void	fillCustomHeadInfo(java.lang.Class<?> dataClass, java.lang.Class<? extends HeadGenerator> headEnhancerClass, com.alibaba.excel.write.builder.ExcelWriterSheetBuilder writerSheetBuilder)
com.alibaba.excel.ExcelWriter	getExcelWriter(javax.servlet.http.HttpServletResponse response, ExportExcel responseExcel) 通用的获取ExcelWriter方法
private boolean	isNotInterface(java.lang.Class<? extends HeadGenerator> headGeneratorClass) 是否为Null Head Generator
void	registerCustomConverter(com.alibaba.excel.write.builder.ExcelWriterBuilder builder) 自定义注入转换器 如果有需要，子类自己重写
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
com.alibaba.excel.write.metadata.WriteSheet	sheet(Sheet sheet, java.lang.Class<?> dataClass, java.lang.String template, java.lang.Class<? extends HeadGenerator> bookHeadEnhancerClass) 获取 WriteSheet 对象

从类继承的方法 java.lang.Object

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

从接口继承的方法 cn.allbs.excel.handle.SheetWriteHandler

support, write

字段详细资料

configProperties

private final ExcelConfigProperties configProperties

converterProvider

private final org.springframework.beans.factory.ObjectProvider<java.util.List<com.alibaba.excel.converters.Converter<?>>> converterProvider

excelWriterBuilderEnhance

private final WriterBuilderEnhancer excelWriterBuilderEnhance

applicationContext

private org.springframework.context.ApplicationContext applicationContext

i18nHeaderCellWriteHandler

@Autowired(required=false)
private I18nHeaderCellWriteHandler i18nHeaderCellWriteHandler

构造器详细资料

AbstractSheetWriteHandler

public AbstractSheetWriteHandler()

方法详细资料

check

public void check(ExportExcel responseExcel)

从接口复制的说明: SheetWriteHandler

校验

指定者:

check 在接口中 SheetWriteHandler

参数:

responseExcel - 注解

export

public void export(java.lang.Object o,
                   javax.servlet.http.HttpServletResponse response,
                   ExportExcel responseExcel)

从接口复制的说明: SheetWriteHandler

返回的对象

指定者:

export 在接口中 SheetWriteHandler

参数:

o - obj

response - 输出对象

responseExcel - 注解

getExcelWriter

public com.alibaba.excel.ExcelWriter getExcelWriter(javax.servlet.http.HttpServletResponse response,
                                                    ExportExcel responseExcel)

通用的获取ExcelWriter方法

参数:

response - HttpServletResponse

responseExcel - ResponseExcel注解

返回:

ExcelWriter

registerCustomConverter

public void registerCustomConverter(com.alibaba.excel.write.builder.ExcelWriterBuilder builder)

自定义注入转换器 如果有需要，子类自己重写

参数:

builder - ExcelWriterBuilder

sheet

public com.alibaba.excel.write.metadata.WriteSheet sheet(Sheet sheet,
                                                         java.lang.Class<?> dataClass,
                                                         java.lang.String template,
                                                         java.lang.Class<? extends HeadGenerator> bookHeadEnhancerClass)

获取 WriteSheet 对象

参数:

sheet - sheet annotation info

dataClass - 数据类型

template - 模板

bookHeadEnhancerClass - 自定义头处理器

返回:

WriteSheet

fillCustomHeadInfo

private void fillCustomHeadInfo(java.lang.Class<?> dataClass,
                                java.lang.Class<? extends HeadGenerator> headEnhancerClass,
                                com.alibaba.excel.write.builder.ExcelWriterSheetBuilder writerSheetBuilder)

isNotInterface

private boolean isNotInterface(java.lang.Class<? extends HeadGenerator> headGeneratorClass)

是否为Null Head Generator

参数:

headGeneratorClass - 头生成器类型

返回:

true 已指定 false 未指定(默认值)

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

指定者:

setApplicationContext 在接口中 org.springframework.context.ApplicationContextAware

抛出:

org.springframework.beans.BeansException