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

Class OptionalListInputWrapper<V,T>

java.lang.Object

uk.ac.ed.epcc.webapp.forms.inputs.WrappingInput<V>

uk.ac.ed.epcc.webapp.forms.inputs.ListInputWrapper<V,T>

uk.ac.ed.epcc.webapp.forms.inputs.OptionalListInputWrapper<V,T>

Type Parameters:

V - value type

T - item type

All Implemented Interfaces:

Input<V>, ItemInput<V,T>, ListInput<V,T>, OptionalListInput<V,T>, SuggestedItemInput<V,T>

public class OptionalListInputWrapper<V,T>
extends ListInputWrapper<V,T>
implements OptionalListInput<V,T>

Adapter to convert a ListInput into a OptionalListInput returning null on not selected. This also allows the un-selected text to be customised.

Constructor Summary

Constructors

Constructor and Description
OptionalListInputWrapper(ListInput<V,T> inner)
OptionalListInputWrapper(ListInput<V,T> inner, java.lang.String text)

Method Summary

Modifier and Type	Method and Description
V	convert(java.lang.Object v) Perform any supported type conversions to to generate a value of the target type
java.lang.String	getText(T item) get the user presented text from the domain object may return null if not selected
java.lang.String	getUnselectedText()
void	setUnselectedText(java.lang.String text)

Methods inherited from class uk.ac.ed.epcc.webapp.forms.inputs.ListInputWrapper

accept, getCount, getInner, getItem, getItembyValue, getItems, getTagByItem, getTagByValue, isValid, setItem

Methods inherited from class uk.ac.ed.epcc.webapp.forms.inputs.WrappingInput

addValidator, getKey, getNested, getPrettyString, getString, getValue, removeValidator, setKey, setValue, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getTagByItem, getTagByValue, isValid

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

getCount, getItems

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, getKey, getPrettyString, getString, getValue, isEmpty, removeValidator, setKey, setValue, validate

Constructor Detail

OptionalListInputWrapper

public OptionalListInputWrapper(ListInput<V,T> inner)

OptionalListInputWrapper

public OptionalListInputWrapper(ListInput<V,T> inner,
                                java.lang.String text)

Method Detail

getText

public java.lang.String getText(T item)

Description copied from interface: ListInput

get the user presented text from the domain object may return null if not selected

Specified by:

getText in interface ListInput<V,T>

Returns:

String user text

convert

public V convert(java.lang.Object v)
          throws TypeError

Description copied from interface: Input

Perform any supported type conversions to to generate a value of the target type

Specified by:

convert in interface Input<V>

Overrides:

convert in class ListInputWrapper<V,T>

Parameters:

v - Object input

Returns:

target type

Throws:

TypeError

getUnselectedText

public java.lang.String getUnselectedText()

Specified by:

getUnselectedText in interface OptionalListInput<V,T>

setUnselectedText

public void setUnselectedText(java.lang.String text)

Specified by:

setUnselectedText in interface OptionalListInput<V,T>