类的使用
gu.sql2java.excel.config.SheetConfig

使用SheetConfig的程序包

程序包	说明
gu.sql2java.excel
gu.sql2java.excel.aspect.spring
gu.sql2java.excel.config

gu.sql2java.excel中SheetConfig的使用

声明为SheetConfig的gu.sql2java.excel中的字段

修饰符和类型	字段	说明
protected SheetConfig	BaseExcelReader.sheetConfig

返回SheetConfig的gu.sql2java.excel中的方法

修饰符和类型	方法	说明
SheetConfig	BaseExcelReader.getSheetConfig()
SheetConfig	ExcelGenerator.getSheetConfig()	返回第一个SheetGenerator 的输出配置(SheetConfig)实例,可以通过此实例修改输出配置, 实例不存在则返回null
SheetConfig	ExcelGenerator.getSheetConfig(int index)	返回索引指定SheetGenerator 的输出配置(SheetConfig)实例,可以通过此实例修改输出配置, 索引越界则返回null
SheetConfig	ExcelReader.getSheetConfig()
SheetConfig	IExcelReader.getSheetConfig()
SheetConfig	SheetGenerator.getSheetConfig()	返回Excel表输出配置(SheetConfig)实例,可以通过此实例修改输出配置

参数类型为SheetConfig的gu.sql2java.excel中的方法

修饰符和类型	方法	说明
ExcelReader	ExcelReader.configSheet(SheetConfig sheetConfig, int index)	为指定索引设置工作薄解析配置
ExcelReader	ExcelReader.configSheet(SheetConfig sheetConfig, Consumer<?> beanConsumer, int index)	为指定索引设置工作薄解析配置
ExcelReader	ExcelReader.configSheet(SheetConfig sheetConfig, List<?> rows, Consumer<?> beanConsumer, int index)	为指定索引设置工作薄解析配置
void	BaseExcelReader.setSheetConfig(SheetConfig sheetConfig)
ExcelGenerator	ExcelGenerator.setSheetConfig(int index, SheetConfig sheetConfig)	设置索引指定SheetGenerator 的输出配置(SheetConfig)实例,索引越界则忽略
ExcelGenerator	ExcelGenerator.setSheetConfig(SheetConfig sheetConfig)	设置第一个SheetGenerator 的输出配置(SheetConfig)实例, 实例不存在则忽略
void	ExcelReader.setSheetConfig(SheetConfig sheetConfig)
void	IExcelReader.setSheetConfig(SheetConfig sheetConfig)
SheetGenerator<B>	SheetGenerator.setSheetConfig(SheetConfig sheetConfig)

参数类型为SheetConfig的gu.sql2java.excel中的构造器

限定符	构造器	说明
	BaseExcelReader(SheetConfig sheetConfig)
	BaseExcelReader(SheetConfig sheetConfig, Consumer<?> beanConsumer)
	BaseExcelReader(SheetConfig sheetConfig, List<?> rows, Consumer<?> beanConsumer)
	CSVReader(SheetConfig sheetConfig)
	CSVReader(SheetConfig sheetConfig, Consumer<?> beanConsumer)
	CSVReader(SheetConfig sheetConfig, List<?> rows, Consumer<?> beanConsumer)
	ExcelReader(SheetConfig sheetConfig)
	ExcelReader(SheetConfig sheetConfig, Consumer<?> beanConsumer)	构造方法 创建第一个工作薄配置
	ExcelReader(SheetConfig sheetConfig, List<?> rows, Consumer<?> beanConsumer)	构造方法 创建第一个工作薄配置
	SheetReader(SheetConfig sheetConfig)
	SheetReader(SheetConfig sheetConfig, Consumer<?> beanConsumer)
	SheetReader(SheetConfig sheetConfig, List<?> rows, Consumer<?> beanConsumer)

gu.sql2java.excel.aspect.spring中SheetConfig的使用

返回SheetConfig的gu.sql2java.excel.aspect.spring中的方法

修饰符和类型	方法	说明
static SheetConfig	ExcelHelperAround.getSheetconfig()	返回为Spring AOP处理当前Excel导出的Excel配置对象

参数类型为SheetConfig的gu.sql2java.excel.aspect.spring中的方法

修饰符和类型	方法	说明
static void	ExcelHelperAround.setSheetconfig(SheetConfig sheetConfig)	(非强制)为Spring AOP处理当前Excel导出指定的Excel配置对象
static void	ExcelHelperAround.setSheetconfig(SheetConfig sheetConfig, boolean force)	为Spring AOP处理当前Excel导出指定的Excel配置对象

gu.sql2java.excel.config中SheetConfig的使用

返回SheetConfig的gu.sql2java.excel.config中的方法

修饰符和类型	方法	说明
SheetConfig	SheetConfig.addColumns(PropertyConfig... elements)
SheetConfig	SheetConfig.addColumns(Iterable<PropertyConfig> elements)
SheetConfig	SheetConfig.addNestedColumn(String nestedName, String descName)
SheetConfig	SheetConfig.addNestedColumns(Iterable<String> elements)
SheetConfig	SheetConfig.addNestedColumns(String... elements)
SheetConfig	SheetConfig.merge(SheetConfig other)	将输入的Excel表配置与当前对象的合并 将other中有定义的Excel Sheet配置字段复制到当前对象的对应字段 将other定义的Excel Column配置对象(PropertyConfig)合并到当前的Column配置对象中,如果存在相同的对象,则以other的为准, 如果other.beanClass不为null则复制到当前对象的同名字段
SheetConfig	SheetConfig.setColumnConfigs(Iterable<PropertyConfig> columnConfigs)
SheetConfig	SheetConfig.setDateFormat(String dateFormat)
SheetConfig	SheetConfig.setDateTimeFormat(String dateTimeFormat)
SheetConfig	SheetConfig.setDefaultIncludeColumns(Set<String> defaultIncludeColumns)
SheetConfig	SheetConfig.setDefaultValue(String defaultValue)
SheetConfig	SheetConfig.setExcludeColumns(Iterable<String> excludeColumns)	指定输出时要排序的字段(黑名单),在此名单中的字段不被输出
SheetConfig	SheetConfig.setExcludeColumns(String... excludeColumns)
SheetConfig	SheetConfig.setExcludeColumns(Set<String> excludeColumns)
SheetConfig	SheetConfig.setFileNamePrefix(String fileNamePrefix)
SheetConfig	SheetConfig.setFillColor(String fillColor)
SheetConfig	SheetConfig.setFillColor(org.apache.poi.ss.usermodel.IndexedColors fillColor)
SheetConfig	SheetConfig.setFirstBold(boolean firstBold)
SheetConfig	SheetConfig.setFirstBold(Boolean firstBold)
SheetConfig	SheetConfig.setFontColor(String fontColor)
SheetConfig	SheetConfig.setFontColor(org.apache.poi.ss.usermodel.IndexedColors fontColor)
SheetConfig	SheetConfig.setFontHeight(short fontHeight)
SheetConfig	SheetConfig.setFontHeight(Integer fontHeight)
SheetConfig	SheetConfig.setFontName(String fontName)
SheetConfig	SheetConfig.setHeaderFillColor(String headerFillColor)
SheetConfig	SheetConfig.setHeaderFillColor(org.apache.poi.ss.usermodel.IndexedColors headerFillColor)
SheetConfig	SheetConfig.setHeaderFontColor(String headerFontColor)
SheetConfig	SheetConfig.setHeaderFontColor(org.apache.poi.ss.usermodel.IndexedColors headerFontColor)
SheetConfig	SheetConfig.setHeaderFontHeight(short headerFontHeight)
SheetConfig	SheetConfig.setHeaderFontHeight(Integer headerFontHeight)
SheetConfig	SheetConfig.setHeaderFontName(String headerFontName)
SheetConfig	SheetConfig.setHeaderHorizontalAlign(String headerHorizontalAlign)
SheetConfig	SheetConfig.setHeaderHorizontalAlign(org.apache.poi.ss.usermodel.HorizontalAlignment headerHorizontalAlign)
SheetConfig	SheetConfig.setHideColumns(Iterable<String> hideColumns)
SheetConfig	SheetConfig.setHideColumns(String... hideColumns)
SheetConfig	SheetConfig.setHideColumns(Set<String> hideColumns)
SheetConfig	SheetConfig.setHorizontalAlign(String horizontalAlign)
SheetConfig	SheetConfig.setHorizontalAlign(org.apache.poi.ss.usermodel.HorizontalAlignment horizontalAlign)
SheetConfig	SheetConfig.setIncludeColumns(Iterable<String> includeColumns)	指定要输出的字段(白名单),在此名单中的字段才会被输出, 此方法也定义了字段输出顺序,
SheetConfig	SheetConfig.setIncludeColumns(String... includeColumns)
SheetConfig	SheetConfig.setIncludeColumns(Set<String> includeColumns)
SheetConfig	SheetConfig.setIncludeColumnsOrDefault(Iterable<String> includeColumns)	指定要输出的字段(白名单),如果输入参数为null或空,则使用getDefaultExportColumnNames()的返回值
SheetConfig	SheetConfig.setIntegralFormat(String integralFormat)
SheetConfig	SheetConfig.setMaxHeight(int maxHeight)
SheetConfig	SheetConfig.setMaxHeight(Integer maxHeight)
SheetConfig	SheetConfig.setMaxWidth(int maxWidth)
SheetConfig	SheetConfig.setMaxWidth(Integer maxWidth)
SheetConfig	SheetConfig.setRoundingMode(int roundingMode)
SheetConfig	SheetConfig.setScale(int scale)
SheetConfig	SheetConfig.setSheetName(String sheetName)
SheetConfig	SheetConfig.setTimeFormat(String timeFormat)
SheetConfig	SheetConfig.setTimestampFormat(String timestampFormat)
SheetConfig	SheetConfig.setTitle(String title)
SheetConfig	SheetConfig.setTitleFillColor(String titleFillColor)
SheetConfig	SheetConfig.setTitleFillColor(org.apache.poi.ss.usermodel.IndexedColors titleFillColor)
SheetConfig	SheetConfig.setTitleFontColor(String titleFontColor)
SheetConfig	SheetConfig.setTitleFontColor(org.apache.poi.ss.usermodel.IndexedColors titleFontColor)
SheetConfig	SheetConfig.setTitleFontHeight(short titleFontHeight)
SheetConfig	SheetConfig.setTitleFontHeight(Integer titleFontHeight)
SheetConfig	SheetConfig.setTitleFontName(String titleFontName)
SheetConfig	SheetConfig.setTitleHorizontalAlign(String titleHorizontalAlign)
SheetConfig	SheetConfig.setTitleHorizontalAlign(org.apache.poi.ss.usermodel.HorizontalAlignment titleHorizontalAlign)

参数类型为SheetConfig的gu.sql2java.excel.config中的方法

修饰符和类型	方法	说明
SheetConfig	SheetConfig.merge(SheetConfig other)	将输入的Excel表配置与当前对象的合并 将other中有定义的Excel Sheet配置字段复制到当前对象的对应字段 将other定义的Excel Column配置对象(PropertyConfig)合并到当前的Column配置对象中,如果存在相同的对象,则以other的为准, 如果other.beanClass不为null则复制到当前对象的同名字段
void	ExcelPropertyConfig.setParent(SheetConfig parentConfig)
void	PropertyConfig.setParent(SheetConfig parentConfig)	设置所属的Excel表输出全局配置