com.alibaba.excel.annotation.write.style

Annotation Type HeadStyle

@Target(value={FIELD,TYPE})
 @Retention(value=RUNTIME)
 @Inherited
public @interface HeadStyle

Custom header styles

Author:

Jiaju Zhuang

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
BorderStyleEnum	borderBottom Set the type of border to use for the bottom border of the cell
BorderStyleEnum	borderLeft Set the type of border to use for the left border of the cell
BorderStyleEnum	borderRight Set the type of border to use for the right border of the cell
BorderStyleEnum	borderTop Set the type of border to use for the top border of the cell
short	bottomBorderColor Set the color to use for the bottom border
short	dataFormat Set the data format (must be a valid format).
short	fillBackgroundColor Set the background fill color.
short	fillForegroundColor Set the foreground fill color Note: Ensure Foreground color is set prior to background color.
FillPatternTypeEnum	fillPatternType Setting to one fills the cell with the foreground color...
BooleanEnum	hidden Set the cell's using this style to be hidden
HorizontalAlignmentEnum	horizontalAlignment Set the type of horizontal alignment for the cell
short	indent Set the number of spaces to indent the text in the cell
short	leftBorderColor Set the color to use for the left border
BooleanEnum	locked Set the cell's using this style to be locked
BooleanEnum	quotePrefix Turn on or off "Quote Prefix" or "123 Prefix" for the style, which is used to tell Excel that the thing which looks like a number or a formula shouldn't be treated as on.
short	rightBorderColor Set the color to use for the right border
short	rotation Set the degree of rotation for the text in the cell.
BooleanEnum	shrinkToFit Controls if the Cell should be auto-sized to shrink to fit if the text is too long
short	topBorderColor Set the color to use for the top border
VerticalAlignmentEnum	verticalAlignment Set the type of vertical alignment for the cell
BooleanEnum	wrapped Set whether the text should be wrapped.

Element Detail

dataFormat

public abstract short dataFormat

Set the data format (must be a valid format). Built in formats are defined at BuiltinFormats.

Default:

-1

hidden

public abstract BooleanEnum hidden

Set the cell's using this style to be hidden

Default:

com.alibaba.excel.enums.BooleanEnum.DEFAULT

locked

public abstract BooleanEnum locked

Set the cell's using this style to be locked

Default:

com.alibaba.excel.enums.BooleanEnum.DEFAULT

quotePrefix

public abstract BooleanEnum quotePrefix

Turn on or off "Quote Prefix" or "123 Prefix" for the style, which is used to tell Excel that the thing which looks like a number or a formula shouldn't be treated as on. Turning this on is somewhat (but not completely, see IgnoredErrorType) like prefixing the cell value with a ' in Excel

Default:

com.alibaba.excel.enums.BooleanEnum.DEFAULT

horizontalAlignment

public abstract HorizontalAlignmentEnum horizontalAlignment

Set the type of horizontal alignment for the cell

Default:

com.alibaba.excel.enums.poi.HorizontalAlignmentEnum.DEFAULT

wrapped

public abstract BooleanEnum wrapped

Set whether the text should be wrapped. Setting this flag to true make all content visible within a cell by displaying it on multiple lines

Default:

com.alibaba.excel.enums.BooleanEnum.DEFAULT

verticalAlignment

public abstract VerticalAlignmentEnum verticalAlignment

Set the type of vertical alignment for the cell

Default:

com.alibaba.excel.enums.poi.VerticalAlignmentEnum.DEFAULT

rotation

public abstract short rotation

Set the degree of rotation for the text in the cell. Note: HSSF uses values from -90 to 90 degrees, whereas XSSF uses values from 0 to 180 degrees. The implementations of this method will map between these two value-ranges accordingly, however the corresponding getter is returning values in the range mandated by the current type of Excel file-format that this CellStyle is applied to.

Default:

-1

indent

public abstract short indent

Set the number of spaces to indent the text in the cell

Default:

-1

borderLeft

public abstract BorderStyleEnum borderLeft

Set the type of border to use for the left border of the cell

Default:

com.alibaba.excel.enums.poi.BorderStyleEnum.DEFAULT

borderRight

public abstract BorderStyleEnum borderRight

Set the type of border to use for the right border of the cell

Default:

com.alibaba.excel.enums.poi.BorderStyleEnum.DEFAULT

borderTop

public abstract BorderStyleEnum borderTop

Set the type of border to use for the top border of the cell

Default:

com.alibaba.excel.enums.poi.BorderStyleEnum.DEFAULT

borderBottom

public abstract BorderStyleEnum borderBottom

Set the type of border to use for the bottom border of the cell

Default:

com.alibaba.excel.enums.poi.BorderStyleEnum.DEFAULT

leftBorderColor

public abstract short leftBorderColor

Set the color to use for the left border

See Also:

IndexedColors

Default:

-1

rightBorderColor

public abstract short rightBorderColor

Set the color to use for the right border

See Also:

IndexedColors

Default:

-1

topBorderColor

public abstract short topBorderColor

Set the color to use for the top border

See Also:

IndexedColors

Default:

-1

bottomBorderColor

public abstract short bottomBorderColor

Set the color to use for the bottom border

See Also:

IndexedColors

Default:

-1

fillPatternType

public abstract FillPatternTypeEnum fillPatternType

Setting to one fills the cell with the foreground color... No idea about other values

See Also:

FillPatternType.SOLID_FOREGROUND

Default:

com.alibaba.excel.enums.poi.FillPatternTypeEnum.DEFAULT

fillBackgroundColor

public abstract short fillBackgroundColor

Set the background fill color.

See Also:

IndexedColors

Default:

-1

fillForegroundColor

public abstract short fillForegroundColor

Set the foreground fill color Note: Ensure Foreground color is set prior to background color.

See Also:

IndexedColors

Default:

-1

shrinkToFit

public abstract BooleanEnum shrinkToFit

Controls if the Cell should be auto-sized to shrink to fit if the text is too long

Default:

com.alibaba.excel.enums.BooleanEnum.DEFAULT