com.ebasetech.xi.api
Interface CustomList

All Superinterfaces:

FieldList

public interface CustomList
extends FieldList

The CustomList interface represents a programmatic list that can be attached to a field. The list is then displayed to the user, usually as a dropdown. See WebFormFieldOrColumn.createCustomList() for an example.

Since:

V4.4

Method Summary

void	add(java.lang.String displayValue) Adds a list entry to the custom list.
void	add(java.lang.String displayValue, java.lang.String returnValue) Adds a list entry to the custom list.
void	clear() Removes all existing entries from the custom list.
void	remove(java.lang.String displayValue) Removes the list entry with a display value of displayValue from the custom list.

Methods inherited from interface com.ebasetech.xi.api.FieldList

getDisplayValue, getDisplayValues, getReturnValue

Method Detail

add

void add(java.lang.String displayValue)

Adds a list entry to the custom list. displayValue is used to set both the list entry display value and the list entry return value.

Each entry within a list contains a display value (the value displayed to the user) and a return value (the value returned to the server when a selection is made - this becomes the field value).

Parameters:

displayValue - list entry display value

Since:

V4.4

See Also:

add(String, String)

add

void add(java.lang.String displayValue,
         java.lang.String returnValue)

Adds a list entry to the custom list. displayValue is used to set the list entry display value and returnValue is used to set the list entry return value.

Each entry within a list contains a display value (the value displayed to the user) and a return value (the value returned to the server when a selection is made - this becomes the field value).

Parameters:

displayValue - list entry display value

returnValue - list entry return value

Since:

V4.4

See Also:

add(String)

clear

void clear()

Removes all existing entries from the custom list.

Since:

V4.4

remove

void remove(java.lang.String displayValue)

Removes the list entry with a display value of displayValue from the custom list.

Each entry within a list contains a display value (the value displayed to the user) and a return value (the value returned to the server when a selection is made - this becomes the field value).

Parameters:

displayValue - list entry display value

Since:

V4.4