uk.ac.ed.epcc.webapp.forms

Class Field<I>

java.lang.Object

uk.ac.ed.epcc.webapp.forms.Field<I>

Type Parameters:

I - Type of field value

public final class Field<I>
extends java.lang.Object

Field represents a single field in the form consisting of a label and and Input.

Constructor Summary

Constructors

Constructor and Description
Field(Form form, java.lang.String key, java.lang.String label, Input<I> sel)

Method Summary

Modifier and Type	Method and Description
void	addValidator(FieldValidator<I> v) Set an external validator for the field that augments the validation performed by the input.
boolean	containsInput(java.lang.Class<? extends Input> c) Does this field use a particular type of input
java.util.Map<java.lang.String,java.lang.String>	getAttributes()
Form	getForm()
Input<I>	getInput() get the Input to be used with this Field
java.lang.String	getKey() get the key associated with this field
java.lang.String	getLabel() get the label to be displayed with this field
java.lang.String	getTooltip()
I	getValue() get the current value associated with this Field
boolean	isFixed() If the current field value forced to particular value The value of the field is updated to that value if it is forced.
boolean	isLocked()
boolean	isOptional()
void	lock() Convert the Input to an UnmodifiedInput by wrapping it in a LockedInput
void	removeValidator(FieldValidator<I> v)
void	setDataAttr(java.lang.String key, java.lang.String value) Add a custom attribute to the input this is mapped to a data-key on the input in html and can be used for custom JS validatipm
void	setInput(Input<I> i)
void	setLabel(java.lang.String label) set the label associated with this field
void	setOptional(boolean optional)
void	setTooltip(java.lang.String tooltip)
I	setValue(java.lang.Object o) set the value associated with this field
java.lang.String	toString()
void	validate() validate the contents of this field

Methods inherited from class java.lang.Object

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

Constructor Detail

Field

public Field(Form form,
             java.lang.String key,
             java.lang.String label,
             Input<I> sel)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setDataAttr

public void setDataAttr(java.lang.String key,
                        java.lang.String value)

Add a custom attribute to the input this is mapped to a data-key on the input in html and can be used for custom JS validatipm

Parameters:

key -

value -

getAttributes

public java.util.Map<java.lang.String,java.lang.String> getAttributes()

lock

public void lock()

Convert the Input to an UnmodifiedInput by wrapping it in a LockedInput

isLocked

public boolean isLocked()

isFixed

public boolean isFixed()

If the current field value forced to particular value The value of the field is updated to that value if it is forced.

Returns:

boolean

containsInput

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

Does this field use a particular type of input

Parameters:

c - Class of Input to be tested

Returns:

boolean true if matches

getInput

public Input<I> getInput()

get the Input to be used with this Field

Returns:

Input

setInput

public void setInput(Input<I> i)

getKey

public java.lang.String getKey()

get the key associated with this field

Returns:

Object

getLabel

public java.lang.String getLabel()

get the label to be displayed with this field

Returns:

String label

getValue

public I getValue()

get the current value associated with this Field

Returns:

value

addValidator

public void addValidator(FieldValidator<I> v)

Set an external validator for the field that augments the validation performed by the input. In most cases it is preferable to extend the Input to perform additional validation. However this can be useful for avoiding code duplication as a FieldValidator is added by composition and is preferable to a FormValidator if the validation only involves a single field because the errors will be associated wih that field.

Parameters:

v - FieldValidator to set

removeValidator

public void removeValidator(FieldValidator<I> v)

setValue

public I setValue(java.lang.Object o)

set the value associated with this field

Parameters:

o - Value to set

Returns:

previous value

setLabel

public void setLabel(java.lang.String label)

set the label associated with this field

Parameters:

label - Label to set

validate

public void validate()
              throws FieldException

validate the contents of this field

Throws:

FieldException

getTooltip

public java.lang.String getTooltip()

setTooltip

public void setTooltip(java.lang.String tooltip)

getForm

public Form getForm()

isOptional

public boolean isOptional()

setOptional

public void setOptional(boolean optional)