类的使用
org.ttzero.excel.entity.Column

使用Column的程序包

程序包	说明
org.ttzero.excel.entity
org.ttzero.excel.entity.csv
org.ttzero.excel.entity.e7

org.ttzero.excel.entity中Column的使用

org.ttzero.excel.entity中Column的子类

限定符和类型	类和说明
static class	ListSheet.EntryColumn ListSheet独有的列对象，除了Column包含的信息外，它还保存当列对应的字段和方法， 后续会通过这两个属性进行反射获取对象中的值，优先通过get方法获取，如果找不到get方法则直接 使用Field获取值
static class	ResultSetSheet.SQLColumn ResultSetSheet独有的列对象，除了Column包含的信息外，它还保存当列对应的SQL类型和 ResultSet下标，有了下标后续列取值可直接根据ri直接取值

声明为Column的org.ttzero.excel.entity中的字段

限定符和类型	字段和说明
protected Column[]	Sheet.columns 表头
Column	Column.next 多行表头中指向后一个Column
Column	Column.prev 多行表头中指向前一个Column
Column	Column.tail 多行表头中指向最后一个Column
protected static Column	SimpleSheet.UNALLOCATED_COLUMN 未实例化的列，可用于在写超出预知范围外的列
static Column	Column.UNALLOCATED_COLUMN 未实例化的列，可用于在写超出预知范围外的列

返回Column的org.ttzero.excel.entity中的方法

限定符和类型	方法和说明
Column	Column.addSubColumn(Column column) 在尾部添加表头
Column	Column.autoSize() 标记“自适应”列宽，导出时根据单元格内容动态计算列宽
protected Column	ListMapSheet.createColumn(Map.Entry<String,T> entry) 从Map.Entry提取信息创建表头，除忽略null作为key以外的其它所有key均默认导出
Column	Column.fixedSize(double width) 设置固定列宽
Column	Column.from(Column other) 复制列信息
Column[]	Sheet.getAndSortHeaderColumns() 获取表头，Worksheet工作表输出协议调用此方法来获取表头信息 此方法先调用内部Sheet.getHeaderColumns()获取基础信息，然后对其进行排序，列反转， 合并等深加工处理
Column[]	TemplateSheet.getAndSortHeaderColumns()
Column[]	Sheet.getColumns() 获取表头，对于非外部传入的表头，只有要执行导出的时候通过行数据进行反射或读取Meta元数据获取， 在此之前该接口将返回null
protected Column[]	Sheet.getHeaderColumns() 获取表头，子类覆写此方法创建表头
protected Column[]	ListMapSheet.getHeaderColumns() 获取表头信息，未指定Columns时默认以第1个非null的Map值做为参考，将该map中所有key做为表头
protected Column[]	CSVSheet.getHeaderColumns()
Column[]	SimpleSheet.getHeaderColumns() 获取表头信息，未实例化表头时会执行初始化方法实例化表头 对于简单类型来说表头信息并无任何有效信息，
protected Column[]	ListSheet.getHeaderColumns() 获取表头信息，未实例化表头时会执行初始化方法实例化表头
protected Column[]	ResultSetSheet.getHeaderColumns() 获取表头，未指定表头时从ResultSetMetaData源数据中获取， 优先使用别名做为表头，列顺序与query字段一致
Column	Column.getTail() 获取尾列，Excel从上到下记为首-尾列，尾列为最接近表格体Body的列
Column	Column.hide() 隐藏当前列
Column	Column.ignoreValue() 忽略Body的数据只输出表头
Column	Column.setBorder(Border border) 设置当前列统一“边框”样式
Column	Column.setCellStyle(int cellStyle) 设置单元格样式值，样式值由背景，边框，字体等进行“或”运算而来
Column	Column.setClazz(Class<?> clazz) 设置列数据类型，数据影响单元格对齐，默认字符串左对齐、数字右对齐、日期居中
Column	Column.setColIndex(int colIndex) 设置列下标，下标从0开始对应Excel的A列，这里设置的下标是绝对位置， 如果表头下标不连续那么导出的时候列也是不连续的
Column	Column.setConverter(Converter<?> converter) 设置转换器，导出的时候将状态值或枚举值转为文本，导入的时候将文本转为状态或枚举值
Column	Column.setEffect(Effect effect) 设置当前列全局图片效果，只有当columnType为Media时生效
Column	Column.setFill(Fill fill) 设置当前列统一“填充”样式
Column	Column.setFont(Font font) 设置当前列统一“字体”样式
Column	Column.setHeaderComment(Comment headerComment) 设置表头批注
Column	Column.setHeaderHeight(double headerHeight) 设置行高，最终的行高取所有列最大值，当行高设置为0时效果与隐藏相同
Column	Column.setHeaderStyle(int headerStyle) 设置表头单元格样式值，样式值由背景，边框，字体等进行“或”运算而来
Column	Column.setHorizontal(int horizontal) 设置当前列统一“水平对齐”样式
Column	Column.setName(String name) 设置表头列名
Column	Column.setNumFmt(NumFmt numFmt) 设置当前列统一“格式化”样式
Column	Column.setNumFmt(String code) 设置当前列统一“格式化”样式
Column	Column.setProcessor(ConversionProcessor processor) 设置输出转换器，通常用于动态转换状态值或枚举值为文本
Column	Column.setShare(boolean share) 设置共享字符串标记，当此标记为true时单元格的字符串将独立保存在共享区
Column	Column.setStyleProcessor(StyleProcessor styleProcessor) 设置动态样式转换器，通常用于高亮显示单元格起提醒作用
Column	Column.setVertical(int vertical) 设置当前列统一“垂直对齐”样式
Column	Column.setWidth(double width) 设置列宽，当该列同时标记为“自适应列宽”时最终的列宽取两者中的较小值，当列宽设置为0时效果与隐藏相同
Column	Column.setWrapText(boolean wrapText) 设置“自动折行” 折行触发条件：一是当长度超过列宽时折行，二是包含回车符时折行
Column	Column.show() 标记当前列可见（默认可见）
Column[]	Column.toArray() 多表头时将链表转为数组
Column	Column.writeAsDefault() 指定当前列以“值”类型导出
Column	Column.writeAsHyperlink() 指定当前列以“超链接”类型导出
Column	Column.writeAsMedia() 指定当前列以“媒体”类型导出

返回变量类型为Column的类型的org.ttzero.excel.entity中的方法

限定符和类型	方法和说明
protected List<Column>	ListSheet.attachOtherColumn(Map<String,Method> existsMethodMapper, Class<?> clazz) 收集可导出的Method并创建Column对象

参数类型为Column的org.ttzero.excel.entity中的方法

限定符和类型	方法和说明
Column	Column.addSubColumn(Column column) 在尾部添加表头
protected void	ListSheet.buildHeaderComment(AccessibleObject main, AccessibleObject sub, Column column) 构建“批注”，默认解析HeaderComment注解，支持自定义注解 优选从方法上获取注解，如果没有则从field中获取
protected void	ListSheet.buildHeaderStyle(AccessibleObject main, AccessibleObject sub, Column column) 构建样式，默认解析HeaderStyle注解 优选从方法上获取注解，如果没有则从field中获取
default void	ICellValueAndStyle.conversion(Row row, Cell cell, Object o, Column hc) 动态转换单元格的值
default void	ICellValueAndStyle.downloadRemoteResource(Row row, Cell cell, String e, Column hc, Class<?> clazz) 下载远程资源 注意：默认情况下仅将单元格类型标记为REMOTE_URL并不会去下载资源。
protected void	TemplateSheet.fillValue(Row row, Cell cell, TemplateSheet.PreCell pn, Column emptyColumn)
Column	Column.from(Column other) 复制列信息
default int	ICellValueAndStyle.getStyleIndex(Row row, Column hc, Object o) 获取单元格样式值，先通过Column获取基础样式，如果有动态样式转换则将基础样式做为参数进行二次制作
protected void	Sheet.insert(Column[] columns, int n, int k)
static ResultSetSheet.SQLColumn	ResultSetSheet.SQLColumn.of(Column other)
default void	ICellValueAndStyle.reset(Row row, Cell cell, Object e, Column hc) 重置单元格的值和样式，Row和Cell都是内存共享的，所以每个单元格均需要重置值和样式
protected void	Sheet.resetCommonProperties(Column[] columns)
protected int	Sheet.search(Column[] columns, int n, int k)
default void	ICellValueAndStyle.setCellValue(Row row, Cell cell, Object e, Column hc, Class<?> clazz, boolean hasConversion) 设置单元格的值，如果有动态转换器则调用转换器
Sheet	Sheet.setColumns(Column... columns) 设置表头，无数据时依然会导出该表头
default void	ICellValueAndStyle.setNullValue(Row row, Cell cell, Column hc) 写null值到单元格
default <T> void	ICellValueAndStyle.setStyleDesign(T o, Cell cell, Column hc, StyleProcessor<T> styleProcessor) 行级样式转换器，它的优先级最高
protected void	Sheet.sortColumns(Column[] columns) 列排序，首先会根据用户指定的colIndex进行一次排序，未指定colIndex的列排在最后， 然后将尾部没有colIndex的列插入到数组前方不连续的空白位，如果有重复的colIndex则按 列在当前数组中的顺序依次排序 示例：现有A:1,B,C:4,D,E五列，其中A的colIndex=1，C的colIndex=4 第一轮按colIndex排序后结果为 => A:1,C:4,B,D,E 第二轮将尾部没有colIndex的BDE列插入到前方空白位，A在第1列它前方可以插入B， A:1和C:4之间有2,3两个空白位，将DE分别插入到2，3位，现在结果为 => B:0,A:1,D:2,E:3,C:4
default void	ICellValueAndStyle.unknownType(Row row, Cell cell, Object e, Column hc, Class<?> clazz) 未知类型转换，可覆写本方法以支持扩展类型
default void	ICellValueAndStyle.writeAsMedia(Row row, Cell cell, String e, Column hc, Class<?> clazz) 将字符串转为Media类型，仅当以Media类型导出时才会被执行， 支持Base64图片和图片url，

类型变量类型为Column的org.ttzero.excel.entity中的方法参数

限定符和类型	方法和说明
Sheet	Sheet.setColumns(List<Column> columns) 设置表头，无数据时依然会导出该表头

参数类型为Column的org.ttzero.excel.entity中的构造器

构造器和说明
Column(Column other) 通过已有列实例化列信息
EmptySheet(Column... columns) 实例化工作表并指定表头信息
EmptySheet(String name, Column... columns) 实例化工作表并指定工作表名称和表头信息
EmptySheet(String name, WaterMark waterMark, Column... columns) 实例化工作表并指定工作表名称，水印和表头信息
EntryColumn(Column other)
ListMapSheet(Column... columns) 实例化工作表并指定表头信息
ListMapSheet(List<Map<String,T>> data, Column... columns) 实例化工作表并添加导出数据和表头信息
ListMapSheet(List<Map<String,T>> data, WaterMark waterMark, Column... columns) 实例化工作表并添加导出数据和表头信息
ListMapSheet(String name, Column... columns) 实例化工作表并指定工作表名称和表头信息
ListMapSheet(String name, List<Map<String,T>> data, Column... columns) 实例化指定名称工作表并添加导出数据和表头信息
ListMapSheet(String name, List<Map<String,T>> data, WaterMark waterMark, Column... columns) 实例化指定名称工作表并添加导出数据和表头信息
ListMapSheet(String name, WaterMark waterMark, Column... columns) 实例化工作表并指定工作表名称，水印和表头信息
ListSheet(Column... columns) 实例化工作表并指定表头信息
ListSheet(List<T> data, Column... columns) 实例化工作表并指定初始数据和表头
ListSheet(List<T> data, WaterMark waterMark, Column... columns) 实例化工作表并指定初始数据、水印和表头
ListSheet(String name, Column... columns) 实例化工作表并指定工作表名称和表头信息
ListSheet(String name, List<T> data, Column... columns) 实例化工作表并指定工作表名称、初始数据和表头
ListSheet(String name, List<T> data, WaterMark waterMark, Column... columns) 实例化工作表并指定工作表名称、初始数据、水印和表头
ListSheet(String name, WaterMark waterMark, Column... columns) 实例化工作表并指定工作表名称，水印和表头信息
ResultSetSheet(Column... columns) 实例化工作表并指定表头信息
ResultSetSheet(ResultSet rs, Column... columns) 实例化工作表并指定数据源ResultSet和表头信息
ResultSetSheet(ResultSet rs, WaterMark waterMark, Column... columns) 实例化工作表并指定数据源ResultSet、水印和表头信息
ResultSetSheet(String name, Column... columns) 实例化工作表并指定工作表名称和表头信息
ResultSetSheet(String name, ResultSet rs, Column... columns) 实例化工作表并指定工作表名、数据源ResultSet和表头信息
ResultSetSheet(String name, ResultSet rs, WaterMark waterMark, Column... columns) 实例化工作表并指定工作表名、数据源ResultSet、水印和表头信息
ResultSetSheet(String name, WaterMark waterMark, Column... columns) 实例化工作表并指定工作表名称，水印和表头信息
Sheet(Column... columns) 实例化工作表并指定表头信息
Sheet(String name, Column... columns) 实例化工作表并指定工作表名称和表头信息
Sheet(String name, WaterMark waterMark, Column... columns) 实例化工作表并指定工作表名称，水印和表头信息
SimpleSheet(Column... columns) 实例化工作表并指定表头信息
SimpleSheet(List<T> data, Column... columns) 实例化工作表并指定初始数据和表头
SimpleSheet(List<T> data, WaterMark waterMark, Column... columns) 实例化工作表并指定初始数据、水印和表头
SimpleSheet(String name, Column... columns) 实例化工作表并指定工作表名称和表头信息
SimpleSheet(String name, List<T> data, Column... columns) 实例化工作表并指定工作表名称、初始数据和表头
SimpleSheet(String name, List<T> data, WaterMark waterMark, Column... columns) 实例化工作表并指定工作表名称、初始数据、水印和表头
SimpleSheet(String name, WaterMark waterMark, Column... columns) 实例化工作表并指定工作表名称，水印和表头信息
SQLColumn(Column other)
StatementSheet(Column... columns) 实例化工作表并指定表头信息
StatementSheet(Connection con, String sql, Column... columns) 实例化工作表并指定工作表名
StatementSheet(Connection con, String sql, ParamProcessor pp, Column... columns) 实例化工作表并指定工作表名
StatementSheet(String name, Column... columns) 实例化工作表并指定工作表名称和表头信息
StatementSheet(String name, Connection con, String sql, Column... columns) 实例化工作表并指定工作表名
StatementSheet(String name, Connection con, String sql, ParamProcessor pp, Column... columns) 实例化工作表并指定工作表名
StatementSheet(String name, WaterMark waterMark, Column... columns) 实例化工作表并指定工作表名称，水印和表头信息

org.ttzero.excel.entity.csv中Column的使用

参数类型为Column的org.ttzero.excel.entity.csv中的方法

限定符和类型	方法和说明
int	CSVCellValueAndStyle.getStyleIndex(Row row, Column hc, Object o) Returns the cell style index
void	CSVCellValueAndStyle.setCellValue(Row row, Cell cell, Object e, Column hc, Class<?> clazz, boolean hasConversion) Setting cell value
<T> void	CSVCellValueAndStyle.setStyleDesign(T o, Cell cell, Column hc, StyleProcessor<T> styleProcessor) Setting all cell style of the specified row

org.ttzero.excel.entity.e7中Column的使用

声明为Column的org.ttzero.excel.entity.e7中的字段

限定符和类型	字段和说明
protected Column[]	XMLWorksheetWriter.columns

返回Column的org.ttzero.excel.entity.e7中的方法

限定符和类型	方法和说明
protected Column	XMLWorksheetWriter.getColumn(int index) 获取列属性

参数类型为Column的org.ttzero.excel.entity.e7中的方法

限定符和类型	方法和说明
double	XMLWorksheetWriter.getHeaderHeight(Column[][] columnsArray, int row) Returns the maximum cell height
int	XMLZebraLineCellValueAndStyle.getStyleIndex(Row row, Column hc, Object o) 获取单元格样式值，先通过Column获取基础样式并在偶数行添加斑马线填充， 如果有动态样式转换则将基础样式做为参数进行二次制作