SPT Core API

com.sptci.echo2.annotation
Annotation Type List


@Documented
@Inherited
@Retention(value=RUNTIME)
@Target(value=FIELD)
public @interface List

Annotation type used to indicate the type of ListModel to use with the list component. Note that processors will work only if the list model is a sub-class of JDOListModel.

© Copyright 2008 Sans Pareil Technologies, Inc.

Version:
$Id: List.java 4120 2008-05-25 20:49:48Z rakesh $
Author:
Rakesh Vidyadharan 2008-04-21

Required Element Summary
 String field
          The name of the field in the model object stored in the listModel() that is to be displayed in the list component.
 String listModel
          The fully qualified list model class to use to back this list component.
 String model
          The fully qualfied class name of the model object backing the list model.
 
Optional Element Summary
 ActionListener listener
          The action listener to associate with the list.
 boolean multipleSelection
          A flag used to indicate multiple selection for the list component.
 

Element Detail

listModel

public abstract String listModel
The fully qualified list model class to use to back this list component.

Returns:
The fully qualified model name.

model

public abstract String model
The fully qualfied class name of the model object backing the list model.

Returns:
The fully qualified class name of the model object.

field

public abstract String field
The name of the field in the model object stored in the listModel() that is to be displayed in the list component.

Returns:
The name of the field to be displayed.

listener

public abstract ActionListener listener
The action listener to associate with the list. This is a short-cut to declaring the action listener at the field level. Defaults to no action listener.

Returns:
The action listener class name.
Default:
@com.sptci.echo2.annotation.ActionListener("null")

multipleSelection

public abstract boolean multipleSelection
A flag used to indicate multiple selection for the list component. This value will be processed only for ListBox components. Default to false.

Returns:
Whether multiple section is enabled or not.
Default:
false

SPT Core API