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

Class InfoInput

java.lang.Object

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

All Implemented Interfaces:

Input<java.lang.String>, UnmodifiableInput

public class InfoInput
extends java.lang.Object
implements Input<java.lang.String>, UnmodifiableInput

Represents an UnmodifiableInput that takes no part in the form validation it just displays informational text. Similar to ConstantInput but cannot cache a value and always validates.

Constructor Summary

Constructors

Constructor and Description
InfoInput(java.lang.String text)

Method Summary

Modifier and Type	Method and Description
<R> R	accept(InputVisitor<R> vis)
void	addValidator(FieldValidator<java.lang.String> val) Add a FieldValidator to this input
java.lang.String	convert(java.lang.Object v) Perform any supported type conversions to to generate a value of the target type
java.lang.String	getKey() get the unique key for this selector
java.lang.String	getLabel() generate the text to be presented to the user
java.lang.String	getPrettyString(java.lang.String value) Convert a value into a user friendly string.
java.lang.String	getString(java.lang.String value) convert a value of the correct type for this input into a String.
java.lang.String	getValue() get the current value of the Object created by this selector.
void	removeValidator(FieldValidator<java.lang.String> val) Remove a FieldValidator from this input
void	setKey(java.lang.String key) Set the key used by this Selector
java.lang.String	setValue(java.lang.String v) set the value of this selector.
void	validate() Check the validity of the current state of the Object.

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

isEmpty

Constructor Detail

InfoInput

public InfoInput(java.lang.String text)

Method Detail

convert

public java.lang.String 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<java.lang.String>

Parameters:

v - Object input

Returns:

target type

Throws:

TypeError

getKey

public java.lang.String getKey()

Description copied from interface: Input

get the unique key for this selector

Specified by:

getKey in interface Input<java.lang.String>

Returns:

Object key for this Selector

getPrettyString

public java.lang.String getPrettyString(java.lang.String value)

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<java.lang.String>

Returns:

String

See Also:

ListInput

getString

public java.lang.String getString(java.lang.String value)

Description copied from interface: Input

convert a value of the correct type for this input into a String. If this input is a parseInput this must be compatible with the way the input is parsed. To make testing easier equivalent values should convert to the same canonical form.

Specified by:

getString in interface Input<java.lang.String>

Returns:

String or null if value is null

See Also:

ParseInput

getValue

public java.lang.String getValue()

Description copied from interface: Input

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

Specified by:

getValue in interface Input<java.lang.String>

Returns:

Object value of this selector

setKey

public void setKey(java.lang.String key)

Description copied from interface: Input

Set the key used by this Selector

Specified by:

setKey in interface Input<java.lang.String>

setValue

public java.lang.String setValue(java.lang.String 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<java.lang.String>

Returns:

previous value Object

Throws:

TypeError

validate

public void validate()
              throws FieldException

Description copied from interface: Input

Check the validity of the current state of the Object.

Specified by:

validate in interface Input<java.lang.String>

Throws:

FieldException

getLabel

public java.lang.String getLabel()

Description copied from interface: UnmodifiableInput

generate the text to be presented to the user

Specified by:

getLabel in interface UnmodifiableInput

Returns:

String

accept

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

Specified by:

accept in interface Input<java.lang.String>

Throws:

java.lang.Exception

addValidator

public void addValidator(FieldValidator<java.lang.String> val)

Description copied from interface: Input

Add a FieldValidator to this input

Specified by:

addValidator in interface Input<java.lang.String>

removeValidator

public void removeValidator(FieldValidator<java.lang.String> val)

Description copied from interface: Input

Remove a FieldValidator from this input

Specified by:

removeValidator in interface Input<java.lang.String>