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

Class MultiInput<V,I extends Input>

java.lang.Object

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

uk.ac.ed.epcc.webapp.forms.inputs.MultiInput<V,I>

Type Parameters:

V - type of input we are constructing

I - Type of sub inputs

All Implemented Interfaces:

Input<V>

Direct Known Subclasses:

AbstractCalendarMultiInput, CalendarFieldPeriodInput, CompositeInput, MultiIntegerHandler.MultiIntegerInput, ParseMultiInput, RegularPeriodInput, SimplePeriodInput

public abstract class MultiInput<V,I extends Input>
extends BaseInput<V>
implements Input<V>

A multi input consists of a combination of sub inputs Optionally each input can have an associated text label

Field Summary

Fields inherited from class uk.ac.ed.epcc.webapp.forms.inputs.BaseInput

validators

Constructor Summary

Constructors

Constructor and Description
MultiInput()

Method Summary

Modifier and Type	Method and Description
<R> R	accept(InputVisitor<R> vis)
void	addInput(java.lang.String sub_key, I i)
protected void	addInput(java.lang.String sub_key, java.lang.String label, I i)
boolean	containsInput(java.lang.Class<? extends Input> c)
I	getInput(java.lang.String sub_key)
java.util.Iterator<I>	getInputs() get all of the sub-selectors
java.lang.String	getPrettyString(V val) Convert a value into a user friendly string.
java.lang.String	getString(V val) get a String representation of an Object that is compatible with the way the input is parsed
java.util.Set<java.lang.String>	getSubKeys()
java.lang.String	getSubLabel(java.lang.String sub_key)
abstract V	getValue() get the current value of the Object created by this selector.
boolean	hasLineBreaks()
boolean	hasSubLabels()
boolean	isEmpty() Is the input empty.
void	removeInput(java.lang.String sub_key)
boolean	requireAll() Are all inputs required
void	setKey(java.lang.String key) Set the key used by this Selector
void	setLineBreaks(boolean line_breaks)
abstract V	setValue(V v) set the value of this selector.
void	validateInner() Extension point to add validation to sub-class specific inner-state

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

addValidator, convert, getKey, getString, removeValidator, 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.Input

addValidator, convert, getKey, removeValidator, validate

Constructor Detail

MultiInput

public MultiInput()

Method Detail

addInput

public final void addInput(java.lang.String sub_key,
                           I i)

addInput

protected void addInput(java.lang.String sub_key,
                        java.lang.String label,
                        I i)

containsInput

public boolean containsInput(java.lang.Class<? extends Input> c)

getInputs

public final java.util.Iterator<I> getInputs()

get all of the sub-selectors

Returns:

Iterator over sub-selectors

getSubKeys

public final java.util.Set<java.lang.String> getSubKeys()

getInput

public final I getInput(java.lang.String sub_key)

getSubLabel

public final java.lang.String getSubLabel(java.lang.String sub_key)

getValue

public abstract V getValue()

Description copied from interface: Input

get the current value of the Object created by this selector.

Specified by:

getValue in interface Input<V>

Returns:

Object value of this selector

removeInput

public final void removeInput(java.lang.String sub_key)

getString

public java.lang.String getString(V val)

Description copied from class: BaseInput

get a String representation of an Object that is compatible with the way the input is parsed

Specified by:

getString in interface Input<V>

Overrides:

getString in class BaseInput<V>

Returns:

String or null if val is null

See Also:

ParseInput

getPrettyString

public java.lang.String getPrettyString(V val)

Description copied from interface: Input

Convert a value into a user friendly string. This usually defaults to the same as getString but can be overridden to produce nicer output

Specified by:

getPrettyString in interface Input<V>

Overrides:

getPrettyString in class BaseInput<V>

Returns:

String

See Also:

ListInput

setKey

public final void setKey(java.lang.String key)

Description copied from interface: Input

Set the key used by this Selector

Specified by:

setKey in interface Input<V>

Overrides:

setKey in class BaseInput<V>

setValue

public abstract V setValue(V v)
                    throws TypeError

Description copied from interface: Input

set the value of this selector. This is either called by the Form to specify a default value or by the edit methods in the sub-class implementation.

Specified by:

setValue in interface Input<V>

Returns:

previous value Object

Throws:

TypeError

accept

public <R> R accept(InputVisitor<R> vis)
             throws java.lang.Exception

Specified by:

accept in interface Input<V>

Throws:

java.lang.Exception

requireAll

public boolean requireAll()

Are all inputs required

Returns:

validateInner

public void validateInner()
                   throws FieldException

Description copied from class: BaseInput

Extension point to add validation to sub-class specific inner-state

Overrides:

validateInner in class BaseInput<V>

Throws:

FieldException

isEmpty

public boolean isEmpty()

Description copied from interface: Input

Is the input empty. empty inputs are reported as errors for non-optional fields. Additional validation is not performed if the input is empty.

Specified by:

isEmpty in interface Input<V>

Returns:

hasLineBreaks

public boolean hasLineBreaks()

hasSubLabels

public boolean hasSubLabels()

setLineBreaks

public void setLineBreaks(boolean line_breaks)