org.ttzero.excel.annotation

注释类型 ExcelColumn

@Target(value={FIELD,METHOD})
 @Retention(value=RUNTIME)
 @Inherited
 @Documented
 @Repeatable(value=ExcelColumns.class)
public @interface ExcelColumn

Specify export information

作者:

guanquan.wang at 2019-06-21 09:53

可选元素概要

可选元素

限定符和类型	可选元素和说明
int	colIndex Specify the column index(zero base), Range from 0 to 16383 include 16383 The column set by colIndex is an absolute position.
HeaderComment	comment Specify a comment in header column If this annotation appears with @HeaderComment at the same time, the independent @HeaderComment annotation takes precedence NOTE: This attribute only affects the header line
String	format Specify the cell format.
boolean	hide Hidden current column Only set the column to hide, the data will still be written, you can right-click to "un-hide" to display in file
double	maxWidth If Sheet.autoSize() is true, The column width take the minimum of `width` and `maxWidth`, if `autoWidth` is false, The column width use `maxWidth` directly as the column width
boolean	share Share body string
String	value Title of column
boolean	wrapText Wrap text in a cell Microsoft Excel can wrap text so it appears on multiple lines in a cell.

元素详细资料

value

public abstract String value

Title of column

返回:

the title of column

默认值:

""

share

public abstract boolean share

Share body string

返回:

true if shared

默认值:

false

comment

public abstract HeaderComment comment

Specify a comment in header column

If this annotation appears with @HeaderComment at the same time, the independent @HeaderComment annotation takes precedence

NOTE: This attribute only affects the header line

返回:

a header HeaderComment

默认值:

@org.ttzero.excel.annotation.HeaderComment

format

public abstract String format

Specify the cell format.

It only supports the format specified by Office excel, please refer to NumFmt.

If you are not sure whether the format is correct, please open Office excel> Format cell> Custom to debug the custom format here.

Note: It only used on Number or Date(include Timestamp, Time and java.time.*) field.

返回:

the data format string

默认值:

""

wrapText

public abstract boolean wrapText

Wrap text in a cell

Microsoft Excel can wrap text so it appears on multiple lines in a cell. You can format the cell so the text wraps automatically, or enter a manual line break.

返回:

true if

默认值:

false

colIndex

public abstract int colIndex

Specify the column index(zero base), Range from 0 to 16383 include 16383

The column set by colIndex is an absolute position. For example, if colIndex=100, this column must be placed at the "CV" position

返回:

-1 means unset

默认值:

-1

maxWidth

public abstract double maxWidth

If Sheet.autoSize() is true, The column width take the minimum of `width` and `maxWidth`, if `autoWidth` is false, The column width use `maxWidth` directly as the column width

返回:

max cell width, less than or equal to 0 means unset

默认值:

0.0

hide

public abstract boolean hide

Hidden current column

Only set the column to hide, the data will still be written, you can right-click to "un-hide" to display in file

返回:

true: hidden otherwise show

默认值:

false