SPT Core API

com.sptci.echo.annotation
Annotation Type Columns.Field


@Documented
@Inherited
@Retention(value=RUNTIME)
@Target(value=ANNOTATION_TYPE)
public static @interface Columns.Field

Annotation to denote the name of a Field that is to be displayed in the Table, and the order in which the fields are to be displayed in the table.


Required Element Summary
 int columnIndex
          The column index for the Field.
 String name
          The name of the Field that is to be displayed in the table.
 
Optional Element Summary
 boolean csv
          Flag to indicate that the entries in a collection are to be displayed as a line of comma separated values.
 String field
          The name of the field that is to be displayed in the table.
 

Element Detail

name

public abstract String name
The name of the Field that is to be displayed in the table.

Returns:
The name of the field to be displayed.

columnIndex

public abstract int columnIndex
The column index for the Field. Following normal column indexing rules, indexing starts from 0.

Returns:
The index at which the column is to be displayed in the table.

field

public abstract String field
The name of the field that is to be displayed in the table. This optional property may be specified for displaying a single value from a complex object in a particular column.

Returns:
The name of the field to be displayed for the class.
Default:
""

csv

public abstract boolean csv
Flag to indicate that the entries in a collection are to be displayed as a line of comma separated values. The default processing logic is to show only the first item in the collection.

Note: If this flag is set, then field() must be initialised.

Returns:
The indicator as to display all values or only the first.
Default:
false

SPT Core API