ExcelSheet (sql2java excel helper 5.3.10-patch1 API)

@Retention(value=RUNTIME)
 @Target(value={METHOD,TYPE})
 @Repeatable(value=ExcelSheets.class)
public @interface ExcelSheet

定义导出Excel 表数据的全局配置注解

作者:: guyadong

可选元素概要

可选元素
限定符和类型	可选元素和说明
`java.lang.Class<?>`	`beanClass` Spring Controller 服务方法中定义导出记录列表的原始记录对象类型
`java.lang.Class<? extends CustomBeanParser>`	`customImporterClass` 自定义导入数据转换实现类，定义此字段将忽略所有ExcelColumn注解和beanClass()定义
`java.lang.String`	`dateFormat` (`Date`)日期格式, 如: yyyy-MM-dd
`java.lang.String`	`dateTimeFormat` (`Date`)日期时间格式, 如: yyyy-MM-dd HH:mm:ss
`java.lang.String[]`	`defaultIncludeColumns` 默认的字段输出白名单,此字段用于给前端提供默认的输出字段及顺序
`java.lang.String`	`defaultValue` 当值为空时,字段的默认值
`java.lang.String[]`	`dynamicExcelNames` 动态输出Excel中的字段名列表,此字段用于服务方法中保存的动态输出EXCEL字段名
`java.lang.String[]`	`excludeColumns` 字段输出黑名单,在此名单中的字段不会被输出,同时指定白名单和黑名单时以白名单为准
`java.lang.String`	`exportFileNameArgName` Spring Controller 服务方法中定义导出文件名的参数名, 不需要注入SheetConfig
`java.lang.String`	`fileNamePrefix` 导出的文件名前缀
`java.lang.String`	`fillColor` 默认单元背景填充颜色,参见 `IndexedColors`
`boolean`	`firstBold` 字体设置:标题行字体加粗
`java.lang.String`	`fontColor` 默认字体颜色,参见 `IndexedColors`
`short`	`fontHeight` 默认字体高度
`java.lang.String`	`fontName` 默认字体名
`java.lang.String`	`getParameterArgName` Spring Controller 服务方法中获取excel导出参数的开关参数名, 不需要注入SheetConfig
`java.lang.String`	`headerFillColor` 首行(字段名)单元背景填充颜色,参见 `IndexedColors`
`java.lang.String`	`headerFontColor` 首行(字段名)字体颜色,参见 `IndexedColors`
`short`	`headerFontHeight` 首行(字段名)字体高度
`java.lang.String`	`headerFontName` 首行(字段名)字体名
`java.lang.String`	`headerHorizontalAlign` 首行(字段名)水平对齐方式
`java.lang.String[]`	`hideColumns` 隐藏字段名单,指定任何情况下都不输出的字段列表在此名单中的字段,不论`includeColumns()excludeColumns()`如何设置都不会被输出
`java.lang.String`	`horizontalAlign` 默认导出字段水平对齐方式
`java.lang.String[]`	`includeColumns` 字段输出白名单,在此名单中的字段会被输出,同时指定白名单和黑名单时以白名单为准
`java.lang.String`	`integralFormat` 默认整数(Integer,Long,Short)格式
`int`	`maxHeight` 导出时在excel中每个列的最大高度, 单位为字符
`int`	`maxWidth` 导出时在excel中每个列的最大宽度, 单位为字符
`int`	`roundingMode` BigDecimal 舍入规则默认:BigDecimal.ROUND_HALF_EVEN
`int`	`scale` BigDecimal 精度默认:-1(默认不开启BigDecimal格式化)
`java.lang.String`	`sheetName` excel Sheet名字
`java.lang.String`	`timeFormat` (`Time`)时间格式, 如: HH:mm:ss
`java.lang.String`	`timestampFormat` (`Timestamp`)时间戳格式, 如: yyyy-MM-dd HH:mm:ss
`java.lang.String`	`title` excel Sheet 标题
`java.lang.String`	`titleFillColor` 标题单元背景填充颜色,参见 `IndexedColors`
`java.lang.String`	`titleFontColor` 标题字体颜色,参见 `IndexedColors`
`short`	`titleFontHeight` 标题字体高度
`java.lang.String`	`titleFontName` 标题字体名
`java.lang.String`	`titleHorizontalAlign` 标题对齐水平方式

- 元素详细资料
  - sheetName
```
public abstract java.lang.String sheetName
```
    excel Sheet名字
    
    默认值:
    
    "exportedExcel"
- - fileNamePrefix
```
public abstract java.lang.String fileNamePrefix
```
    导出的文件名前缀
    
    默认值:
    
    ""
- - title
```
public abstract java.lang.String title
```
    excel Sheet 标题
    
    默认值:
    
    ""
- - titleFontName
```
public abstract java.lang.String titleFontName
```
    标题字体名
    
    默认值:
    
    "Calibri"
- - titleFontHeight
```
public abstract short titleFontHeight
```
    标题字体高度
    
    默认值:
    
    32
- - titleFontColor
```
public abstract java.lang.String titleFontColor
```
    标题字体颜色,参见 IndexedColors
    
    默认值:
    
    "BLACK"
- - titleFillColor
```
public abstract java.lang.String titleFillColor
```
    标题单元背景填充颜色,参见 IndexedColors
    
    默认值:
    
    "WHITE"
- - titleHorizontalAlign
```
public abstract java.lang.String titleHorizontalAlign
```
    标题对齐水平方式
    
    默认值:
    
    "CENTER"
- - headerFontName
```
public abstract java.lang.String headerFontName
```
    首行(字段名)字体名
    
    默认值:
    
    "Calibri"
- - headerFontHeight
```
public abstract short headerFontHeight
```
    首行(字段名)字体高度
    
    默认值:
    
    16
- - headerFontColor
```
public abstract java.lang.String headerFontColor
```
    首行(字段名)字体颜色,参见 IndexedColors
    
    默认值:
    
    "BLACK"
- - headerFillColor
```
public abstract java.lang.String headerFillColor
```
    首行(字段名)单元背景填充颜色,参见 IndexedColors
    
    默认值:
    
    "GREY_25_PERCENT"
- - headerHorizontalAlign
```
public abstract java.lang.String headerHorizontalAlign
```
    首行(字段名)水平对齐方式
    
    默认值:
    
    "CENTER"
- - firstBold
```
public abstract boolean firstBold
```
    字体设置:标题行字体加粗
    
    默认值:
    
    true
- - fontHeight
```
public abstract short fontHeight
```
    默认字体高度
    
    默认值:
    
    16
- - fontName
```
public abstract java.lang.String fontName
```
    默认字体名
    
    默认值:
    
    "Calibri"
- - fontColor
```
public abstract java.lang.String fontColor
```
    默认字体颜色,参见 IndexedColors
    
    默认值:
    
    "BLACK"
- - fillColor
```
public abstract java.lang.String fillColor
```
    默认单元背景填充颜色,参见 IndexedColors
    
    默认值:
    
    "WHITE"
- - horizontalAlign
```
public abstract java.lang.String horizontalAlign
```
    默认导出字段水平对齐方式
    
    默认值:
    
    "CENTER"
- - integralFormat
```
public abstract java.lang.String integralFormat
```
    默认整数(Integer,Long,Short)格式
    
    默认值:
    
    "0"
- - dateTimeFormat
```
public abstract java.lang.String dateTimeFormat
```
    (Date)日期时间格式, 如: yyyy-MM-dd HH:mm:ss
    
    默认值:
    
    "yyyy-MM-dd HH:mm:ss"
- - dateFormat
```
public abstract java.lang.String dateFormat
```
    (Date)日期格式, 如: yyyy-MM-dd
    
    默认值:
    
    "yyyy-MM-dd"
- - timeFormat
```
public abstract java.lang.String timeFormat
```
    (Time)时间格式, 如: HH:mm:ss
    
    默认值:
    
    "HH:mm:ss"
- - timestampFormat
```
public abstract java.lang.String timestampFormat
```
    (Timestamp)时间戳格式, 如: yyyy-MM-dd HH:mm:ss
    
    默认值:
    
    "yyyy-MM-dd\'T\'HH:mm:ss.SSSZ"
- - scale
```
public abstract int scale
```
    BigDecimal 精度默认:-1(默认不开启BigDecimal格式化)
    
    默认值:
    
    -1
- - roundingMode
```
public abstract int roundingMode
```
    BigDecimal 舍入规则默认:BigDecimal.ROUND_HALF_EVEN
    
    默认值:
    
    6
- - maxHeight
```
public abstract int maxHeight
```
    导出时在excel中每个列的最大高度, 单位为字符
    
    默认值:
    
    0
- - maxWidth
```
public abstract int maxWidth
```
    导出时在excel中每个列的最大宽度, 单位为字符
    
    默认值:
    
    32
- - defaultValue
```
public abstract java.lang.String defaultValue
```
    当值为空时,字段的默认值
    
    默认值:
    
    ""
- - includeColumns
```
public abstract java.lang.String[] includeColumns
```
    字段输出白名单,在此名单中的字段会被输出,同时指定白名单和黑名单时以白名单为准
    
    默认值:
    
    {}
- - excludeColumns
```
public abstract java.lang.String[] excludeColumns
```
    字段输出黑名单,在此名单中的字段不会被输出,同时指定白名单和黑名单时以白名单为准
    
    默认值:
    
    {}
- - hideColumns
```
public abstract java.lang.String[] hideColumns
```
    隐藏字段名单,指定任何情况下都不输出的字段列表在此名单中的字段,不论includeColumns()excludeColumns()如何设置都不会被输出
    
    默认值:
    
    {}
- - defaultIncludeColumns
```
public abstract java.lang.String[] defaultIncludeColumns
```
    默认的字段输出白名单,此字段用于给前端提供默认的输出字段及顺序
    
    默认值:
    
    {}
- - dynamicExcelNames
```
public abstract java.lang.String[] dynamicExcelNames
```
    动态输出Excel中的字段名列表,此字段用于服务方法中保存的动态输出EXCEL字段名
    
    从以下版本开始:
    
    3.26.0
    
    默认值:
    
    {}
- - getParameterArgName
```
public abstract java.lang.String getParameterArgName
```
    Spring Controller 服务方法中获取excel导出参数的开关参数名, 不需要注入SheetConfig
    
    默认值:
    
    "getParameter"
- - exportFileNameArgName
```
public abstract java.lang.String exportFileNameArgName
```
    Spring Controller 服务方法中定义导出文件名的参数名, 不需要注入SheetConfig
    
    默认值:
    
    "exportFileName"
- - beanClass
```
public abstract java.lang.Class<?> beanClass
```
    Spring Controller 服务方法中定义导出记录列表的原始记录对象类型
    
    默认值:
    
    java.lang.Object.class
- - customImporterClass
```
public abstract java.lang.Class<? extends CustomBeanParser> customImporterClass
```
    自定义导入数据转换实现类，定义此字段将忽略所有ExcelColumn注解和beanClass()定义
    
    从以下版本开始:
    
    3.29.0
    
    默认值:
    
    gu.sql2java.excel.CustomBeanParser.class

注释类型 ExcelSheet

可选元素概要

元素详细资料

sheetName

fileNamePrefix

title

titleFontName

titleFontHeight

titleFontColor

titleFillColor

titleHorizontalAlign

headerFontName

headerFontHeight

headerFontColor

headerFillColor

headerHorizontalAlign

firstBold

fontHeight

fontName

fontColor

fillColor

horizontalAlign

integralFormat

dateTimeFormat

dateFormat

timeFormat

timestampFormat

scale

roundingMode

maxHeight

maxWidth

defaultValue

includeColumns

excludeColumns

hideColumns

defaultIncludeColumns

dynamicExcelNames

getParameterArgName

exportFileNameArgName

beanClass

customImporterClass