Package com.github.javaxcel.annotation

Annotation Type ExcelModel

@Documented
@Target(TYPE)
@Retention(RUNTIME)
public @interface ExcelModel

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
Class<? extends com.github.javaxcel.styler.ExcelStyleConfig>	bodyStyle	Configuration of common body style.
String	defaultValue	Replacement of the value when only writes the value that is null or empty string.
boolean	enumDropdown	Policy that determines whether this will set constraint to Enum field or not.
boolean	explicit	Policy that determines whether this will select explicitly designated fields or not.
Class<? extends com.github.javaxcel.styler.ExcelStyleConfig>	headerStyle	Configuration of common header style.
boolean	includeSuper	Policy that determines whether this will select super classes' fields or own fields.

Element Details

includeSuper

boolean includeSuper

Policy that determines whether this will select super classes' fields or own fields.

If this is true, this will select declared own fields including the inherited. Otherwise, this will select only declared own fields except the inherited.

Returns:

policy that determines whether this will select super classes' fields or not

Default:

false

explicit

boolean explicit

Policy that determines whether this will select explicitly designated fields or not.

If this is true, this will select the fields that annotated with ExcelColumn. Otherwise, this will select all the fields whether it is annotated with ExcelColumn or not.

Returns:

policy that determines whether this will select explicitly designated fields or not.

Default:

false

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(), ExcelColumn.enumDropdown(), ExcelColumn.dropdownItems()

Default:

false

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), ExcelColumn.defaultValue()

Default:

""

headerStyle

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

Configuration of common header style.

This configuration is applied to all header cells.

Returns:

configuration of common header style

See Also:

ExcelColumn.headerStyle()

Default:

com.github.javaxcel.styler.NoStyleConfig.class

bodyStyle

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

Configuration of common body style.

This configuration is applied to all body cells.

Returns:

configuration of common body style

See Also:

ExcelColumn.bodyStyle()

Default:

com.github.javaxcel.styler.NoStyleConfig.class