CustomList

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 WebFormField#createCustomList() for an example.

CustomList Functions

add CustomList.add( displayValue [, returnValue ] ) Adds a list entry to the custom list.
clear CustomList.clear( ) Removes all existing entries from the custom list.
remove CustomList.remove( displayValue ) Removes the list entry with a display value of displayValue from the custom list.

FieldList Functions

getDisplayValue CustomList.getDisplayValue( returnValue , formatted ) Returns the display value from the list that corresponds to the return value represented by returnValue, optionally formatted for the user's locale.
getDisplayValues CustomList.getDisplayValues( formatted ) Returns an array of display values for the list, optionally formatted for the user's locale.
getReturnValue CustomList.getReturnValue( displayValue ) Returns the return value from the list that corresponds to the display value represented by displayValue.
getItems CustomList.getItems( ) Returns an iterator that can be used to traverse all list items