package com.vci.starter.poi.annotation;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * excel里的列
 * @author weidy
 * @date 2020/5/9
 */
@Target({ java.lang.annotation.ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface ExcelColumn {

    /**
     * 对应excel里的列
     * @return excel中的列名
     */
    String value() ;

    /**
     * 值是否可以为空
     * @return true
     */
    boolean nullable() default true;

    /**
     * 所属枚举的编号
     * @return 枚举编号
     */
    String enumId() default "";

    /**
     * 校验的正则表达式
     * @return 有正则表达式的时候，会直接校验是否正确
     */
    String regExg() default "";

    /**
     * 不满足正则表达式的时候的提示值，可以是多语言编号
     * @return 默认为空
     */
    String regExgTitle() default "";

    /**
     * 属性分组，常用于扩展属性的方式
     * @return 分组信息
     */
    String group() default "";

    /**
     * 是否为行号的列
     * @return true表示会将内容加到行号上
     */
    boolean rowIndexColumn() default false;

    /**
     * 只读-导出的时候使用
     * @return true表示只读
     */
    boolean readOnly() default false;

    /**
     * 单元格宽度,单位是厘米，差不多是html上表格的宽度除以10
     * @return 宽度
     */
    int width() default 0;

}