uk.ac.ed.epcc.webapp.forms.inputs

Interface AutoComplete<T,V>

Type Parameters:

T - item type

V - input type

All Superinterfaces:

Input<V>, ItemInput<V,T>, ParseInput<V>, SuggestedItemInput<V,T>

All Known Implementing Classes:

AppUserFactory.AppUserNameInput, AutocompleteTextInput, NameFinderInput, RoleNameInput

public interface AutoComplete<T,V>
extends SuggestedItemInput<V,T>, ParseInput<V>

Interface for inputs that provide auto-complete text.

Method Summary

Modifier and Type	Method and Description
default int	getCount() get the number of suggested items.
default java.util.Iterator<T>	getItems() get a list of domain objects that are being selected
java.util.Set<T>	getSuggestions() Get the set of Items corresponding to a suggested values
java.lang.String	getSuggestionText(T item) get the suggestion text.
java.lang.String	getValue(T item) Map an item to the corresponding value (compatible with the parse method).

Methods inherited from interface uk.ac.ed.epcc.webapp.forms.inputs.ItemInput

getItem, getItembyValue, setItem

Methods inherited from interface uk.ac.ed.epcc.webapp.forms.inputs.Input

accept, addValidator, convert, getKey, getPrettyString, getString, getValue, isEmpty, removeValidator, setKey, setValue, validate

Methods inherited from interface uk.ac.ed.epcc.webapp.forms.inputs.ParseInput

getString, parse, parseValue

Method Detail

getSuggestions

java.util.Set<T> getSuggestions()

Get the set of Items corresponding to a suggested values

Returns:

getValue

java.lang.String getValue(T item)

Map an item to the corresponding value (compatible with the parse method).

Parameters:

item -

Returns:

String value

getSuggestionText

java.lang.String getSuggestionText(T item)

get the suggestion text. This can be an expanded form of the value

Parameters:

item -

Returns:

getItems

default java.util.Iterator<T> getItems()

Description copied from interface: SuggestedItemInput

get a list of domain objects that are being selected

Specified by:

getItems in interface SuggestedItemInput<V,T>

Returns:

Iterator

getCount

default int getCount()

Description copied from interface: SuggestedItemInput

get the number of suggested items. null selections don't count.

Specified by:

getCount in interface SuggestedItemInput<V,T>

Returns:

int