com.sptci.echo.annotation

Annotation Type Table

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

Annotation type used to indicate the type of table component to instantiate.

© Copyright 2008 Sans Pareil Technologies, Inc.

Version:

$Id: Table.java 4953 2010-03-11 17:45:58Z rakesh $

Author:

Rakesh Vidyadharan 2008-04-17

Field Summary

Fields

Modifier and Type	Fields and Description
static String	NULL A constant to represent null value as default.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	className The fully qualified name of the table class to use to initialise the annotated field.
String	model The fully qualified name of the model class used to back the table model.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Columns	columns Optional columns declaration that may be used if the model() class cannot be annotated.
String	field The field in a view that represents the table.
String	filterField The name of the filter field in model() that is used to filter the data in the model.
boolean	multipleSelection A flag used to indicate whether the table should support multiple selection or not.
String	selectionListener The SelectionListener to associated with the table.
String	tableModel The fully qualified name of the table model class to use.

Field Detail

NULL

public static final String NULL

A constant to represent null value as default.

Element Detail

className

public abstract String className

The fully qualified name of the table class to use to initialise the annotated field.

Returns:

The table component class name.

model

public abstract String model

The fully qualified name of the model class used to back the table model.

Returns:

The class name of the model object used in the table.

tableModel

public abstract String tableModel

The fully qualified name of the table model class to use. If not specified, processors may use default logic to arrive at the table model class to use. Defaults to NULL.

Returns:

The class name of the table model used with the table.

Default:

""

field

public abstract String field

The field in a view that represents the table. This is required only when annotating a class as opposed to a field. Defaults to NULL.

Returns:

The name of the field in the view that is being annotated.

Default:

""

multipleSelection

public abstract boolean multipleSelection

A flag used to indicate whether the table should support multiple selection or not. Defaults to false or single selection.

Returns:

The value indicating the selection model.

Default:

false

selectionListener

public abstract String selectionListener

The SelectionListener to associated with the table. Defaults to NULL.

Returns:

The fully qualified class name of the selection listener.

Default:

""

columns

public abstract Columns columns

Optional columns declaration that may be used if the model() class cannot be annotated. The view class itself could hold the Columns annotation, however that would restrict the view to containing only one table. This option is more flexible by annotating the table field.

Returns:

The columns in the model() that are to be displayed.

Default:

@com.sptci.echo.annotation.Columns(fields={})

filterField

public abstract String filterField

The name of the filter field in model() that is used to filter the data in the model. This is used usually with instances of JDOFilterTableModel.

Returns:

The name of the field in model() used as a filter.

Default:

""