io.github.xinshepherd.excel.annotation.ExcelBigHead Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of easy-excel Show documentation

Easy Usage of the Apache POI

The newest version!

package io.github.xinshepherd.excel.annotation;

import io.github.xinshepherd.excel.core.DefaultFontStyle;
import io.github.xinshepherd.excel.core.FontStyle;
import org.apache.poi.ss.usermodel.HorizontalAlignment;
import org.apache.poi.ss.usermodel.VerticalAlignment;

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

/**
 * 用于设置大标题
 *
 * @author Fuxin
 * @since 1.1.0
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface ExcelBigHead {

    String value();

    /**
     * 设置头部行的字体样式
     *
     * @see FontStyle
     * @return 头部字体样式
     */
    Class fontStyle() default DefaultFontStyle.class;

    /**
     * 设置单元格垂直对齐方式
     *
     * @return 垂直对齐方式，默认居中
     */
    VerticalAlignment verticalAlignment() default VerticalAlignment.CENTER;

    /**
     * 设置单元格水平对齐方式
     *
     * @return 水平对齐方式，默认居中
     */
    HorizontalAlignment horizontalAlignment() default HorizontalAlignment.CENTER;

    int fromRow() default 0;

    int toRow() default 0;

    int fromColumn() default 0;

    int toColumn() default 1;

    /**
     * 列数是否自动对齐表头
     *
     * @return 是则不会根据 fromColumn 和 toColumn 设置合并的单元格列数
     * @see #fromColumn()
     * @see #toColumn()
     */
    boolean autoMergeColumn() default true;

}