Package com.github.javaxcel.annotation

Annotation Type ExcelColumn

@Documented
@Target(FIELD)
@Retention(RUNTIME)
public @interface ExcelColumn

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
Class<? extends com.github.javaxcel.styler.ExcelStyleConfig>	bodyStyle	Configuration of body style.
String	defaultValue	Replacement of the value when only writes the value that is null or empty string.
String[]	dropdownItems	Dropdown items for the constraint.
boolean	enumDropdown	Policy that determines whether this will set constraint to Enum field or not.
Class<? extends com.github.javaxcel.styler.ExcelStyleConfig>	headerStyle	Configuration of header style.
String	name	Header name.

Element Details

name

String name

Header name.

Returns:

header name

Default:

""

enumDropdown

boolean enumDropdown

Policy that determines whether this will set constraint to Enum field or not.

If this is true, this will make the column of Enum field dropdown.

Returns:

whether this column will be dropdown or not.

See Also:

ModelWriter.enumDropdown(), ExcelModel.enumDropdown(), dropdownItems()

Default:

false

dropdownItems

String[] dropdownItems

Dropdown items for the constraint.

If this is empty, dropdown items are Enum.name().

Returns:

dropdown items

See Also:

ModelWriter.enumDropdown(), ExcelModel.enumDropdown(), enumDropdown()

Default:

{}

defaultValue

String defaultValue

Replacement of the value when only writes the value that is null or empty string.

This is ineffective to primitive type.

Returns:

replacement of the value when the value is null or empty string

See Also:

AbstractExcelWriter.defaultValue(String), ExcelModel.defaultValue()

Default:

""

headerStyle

Class<? extends com.github.javaxcel.styler.ExcelStyleConfig> headerStyle

Configuration of header style.

This takes precedence over ExcelModel.headerStyle().

Returns:

configuration of header style

See Also:

ExcelModel.headerStyle()

Default:

com.github.javaxcel.styler.NoStyleConfig.class

bodyStyle

Class<? extends com.github.javaxcel.styler.ExcelStyleConfig> bodyStyle

Configuration of body style.

This takes precedence over ExcelModel.bodyStyle().

Returns:

configuration of body style

See Also:

ExcelModel.bodyStyle()

Default:

com.github.javaxcel.styler.NoStyleConfig.class