uk.ac.ed.epcc.webapp.forms

Class BaseForm

java.lang.Object

uk.ac.ed.epcc.webapp.forms.BaseForm

All Implemented Interfaces:

java.lang.Iterable<Field>, Contexed, Form

Direct Known Subclasses:

MapForm

public class BaseForm
extends java.lang.Object
implements Form

superclass for all Forms. A Form is functionally an ordered set of Fields. Once built a Form can be used as a Map between field names and values. The methods used to actually edit a form are specific to the form sub-class however this class can be instantiated directly for testing.

A Form may either be used as just a collection of fields with associated validation ie as a component of a larger composite form or may contain a set of FormAction classes to define an action to take on form submission.

Field Summary

Fields

Modifier and Type	Field and Description
protected ConfirmMessage	additional_confirm
protected Logger	log
protected java.util.Set<FormValidator>	validators

Constructor Summary

Constructors

Constructor and Description
BaseForm(AppContext c)

Method Summary

Modifier and Type	Method and Description
void	addAction(java.lang.String name, FormAction action) add an FormAction to this Form
<I> Field	addInput(java.lang.String key, java.lang.String label, Input<I> s) Add and input to the next slot in the form
<I> Field	addInput(java.lang.String key, java.lang.String label, java.lang.String help, Input<I> s) Add and input to the next slot in the form
void	addValidator(FormValidator v) Set a FormValidator to perform overall sanity check on the form.
void	clear()
boolean	containsInput(java.lang.Class<? extends Input> c) Check a form to see if it contains an input of a particular type.
java.lang.String	diff(java.util.Map<java.lang.String,java.lang.Object> m) Compare the values of this forms inputs with the contents of a Map and generate a text summary;
FormResult	doAction(java.lang.String name) perform a named action on this form.
int	fieldCount()
java.lang.Object	get(java.lang.String key) get the value associated with a Form field.
FormAction	getAction(java.lang.String name) get a FormAction by name.
java.util.Set<java.lang.String>	getActionNames() Get an Set of the names of the installed Actions.
java.lang.String	getAutoFocus() get field for auto-focus
java.util.Map<java.lang.String,java.lang.Object>	getContents() get the contents of a form as a Map
AppContext	getContext() get the AppContext associated with this Form
Field	getField(java.lang.String key) get a Field object
java.util.Iterator<java.lang.String>	getFieldIterator() get an iterator over the field names
java.util.Set<java.lang.String>	getFieldNames()
java.lang.String	getFormID() get the form-ids In HTML this is used as a prefix for the input html-ids
Input	getInput(java.lang.String key) get the Input associated with a Field
java.lang.Object	getItem(java.lang.String key) get the Item associated with a Form field.
Logger	getLogger()
java.lang.String	getSingleActionName() get the default action name.
Table<java.lang.String,java.lang.String>	getTable() get the form contents as a Table
java.util.Set<FormValidator>	getValidators() get the current Form validator
boolean	hasActions()
boolean	hasField(java.lang.String key) Does form contain specified field
java.util.Iterator<Field>	iterator()
protected <I> Field<I>	makeField(java.lang.String key, java.lang.String label, Input<I> sel) make a field appropriate for this form, this in principle could be sub-classed if we want custom Fields, but it is usually simpler to implement all customisations in the Form sub-class.
ConfirmMessage	mustConfirm(java.lang.String name) Test if this action should be confirmed before execute
java.lang.Object	put(java.lang.String key, java.lang.Object value) set the value associated with a form field
void	removeAction(java.lang.String name) remove a FormAction.
void	removeField(java.lang.String key) remove a field from the form
void	removeValidator(FormValidator v) Remove a FormValidator
void	setAutoFocus(java.lang.String field) set field for auto-focus
void	setConfirm(java.lang.String name, java.lang.String conf)
void	setContents(java.util.Map<java.lang.String,java.lang.Object> m) set the contents of a Form from a Map
void	setFormID(java.lang.String id) Set a form-id for this form.
java.lang.String	toString()
void	update(java.util.Map<java.lang.String,java.lang.Object> m) modify an existing Map updating the fields represented by the Form.
boolean	validate() validate a form This does not attempt to report details of any problem and will return as soon as any validation condition fails.

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.ed.epcc.webapp.forms.Form

getTargetStage, isComplete, isFixed, poll, setTargetStage, supportsMultiStage

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

validators

protected java.util.Set<FormValidator> validators

log

protected Logger log

additional_confirm

protected ConfirmMessage additional_confirm

Constructor Detail

BaseForm

public BaseForm(AppContext c)

Method Detail

addAction

public void addAction(java.lang.String name,
                      FormAction action)

add an FormAction to this Form

Specified by:

addAction in interface Form

Parameters:

name - String action-name/button-text

action - FormAction

removeAction

public void removeAction(java.lang.String name)

Description copied from interface: Form

remove a FormAction.

Specified by:

removeAction in interface Form

addInput

public <I> Field addInput(java.lang.String key,
                          java.lang.String label,
                          Input<I> s)

Add and input to the next slot in the form

Specified by:

addInput in interface Form

Parameters:

key - key to use to refer to field

label - String to display to user

s - Input to add

Returns:

Field object created

addInput

public <I> Field addInput(java.lang.String key,
                          java.lang.String label,
                          java.lang.String help,
                          Input<I> s)

Add and input to the next slot in the form

Specified by:

addInput in interface Form

Parameters:

key - key to use to refer to field

label - String to display to user

help - tooltip String

s - Input to add

Returns:

Field object created

clear

public void clear()

containsInput

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

Check a form to see if it contains an input of a particular type.

Specified by:

containsInput in interface Form

Parameters:

c - Class for the Input type to be testes

Returns:

bioolean true if input exists

doAction

public FormResult doAction(java.lang.String name)
                    throws FieldException,
                           ActionException

perform a named action on this form. This also checks the form is validated

Specified by:

doAction in interface Form

Parameters:

name - String name of action

Returns:

FormResult returned by action

Throws:

FieldException

ActionException

getAction

public FormAction getAction(java.lang.String name)

Description copied from interface: Form

get a FormAction by name.

Specified by:

getAction in interface Form

Returns:

FormAction

get

public java.lang.Object get(java.lang.String key)

get the value associated with a Form field. Non existent fields always return null.

Specified by:

get in interface Form

Parameters:

key -

Returns:

value

getItem

public java.lang.Object getItem(java.lang.String key)

Description copied from interface: Form

get the Item associated with a Form field.

Specified by:

getItem in interface Form

Returns:

item

getActionNames

public java.util.Set<java.lang.String> getActionNames()

Description copied from interface: Form

Get an Set of the names of the installed Actions.

Specified by:

getActionNames in interface Form

Returns:

Iterator

getSingleActionName

public java.lang.String getSingleActionName()

get the default action name.

Returns:

String

hasActions

public boolean hasActions()

fieldCount

public int fieldCount()

setConfirm

public void setConfirm(java.lang.String name,
                       java.lang.String conf)

Specified by:

setConfirm in interface Form

getContents

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

get the contents of a form as a Map

Specified by:

getContents in interface Form

Returns:

Map

getContext

public AppContext getContext()

get the AppContext associated with this Form

Specified by:

getContext in interface Contexed

Returns:

AppContext

getField

public Field getField(java.lang.String key)

get a Field object

Specified by:

getField in interface Form

Parameters:

key -

Returns:

Field

hasField

public final boolean hasField(java.lang.String key)

Description copied from interface: Form

Does form contain specified field

Specified by:

hasField in interface Form

Returns:

getFieldIterator

public java.util.Iterator<java.lang.String> getFieldIterator()

get an iterator over the field names

Specified by:

getFieldIterator in interface Form

Returns:

Iterator

getFieldNames

public java.util.Set<java.lang.String> getFieldNames()

getInput

public Input getInput(java.lang.String key)

get the Input associated with a Field

Specified by:

getInput in interface Form

Parameters:

key -

Returns:

the Input or null if Input does not exist

getLogger

public Logger getLogger()

getTable

public Table<java.lang.String,java.lang.String> getTable()

get the form contents as a Table

Specified by:

getTable in interface Form

Returns:

TAble

getValidators

public final java.util.Set<FormValidator> getValidators()

get the current Form validator

Specified by:

getValidators in interface Form

Returns:

the FormValidator

makeField

protected <I> Field<I> makeField(java.lang.String key,
                                 java.lang.String label,
                                 Input<I> sel)

make a field appropriate for this form, this in principle could be sub-classed if we want custom Fields, but it is usually simpler to implement all customisations in the Form sub-class.

Parameters:

key -

label -

sel -

Returns:

Field

mustConfirm

public ConfirmMessage mustConfirm(java.lang.String name)
                           throws ActionException

Test if this action should be confirmed before execute

Parameters:

name -

Returns:

String message name or null

Throws:

ActionException

put

public java.lang.Object put(java.lang.String key,
                            java.lang.Object value)

set the value associated with a form field

Specified by:

put in interface Form

Parameters:

key -

value -

Returns:

previous value

removeField

public void removeField(java.lang.String key)

remove a field from the form

Specified by:

removeField in interface Form

Parameters:

key -

setContents

public void setContents(java.util.Map<java.lang.String,java.lang.Object> m)

set the contents of a Form from a Map

Specified by:

setContents in interface Form

Parameters:

m - Map of values

addValidator

public final void addValidator(FormValidator v)

Set a FormValidator to perform overall sanity check on the form.

Specified by:

addValidator in interface Form

Parameters:

v - The FormValidator to set.

removeValidator

public final void removeValidator(FormValidator v)

Description copied from interface: Form

Remove a FormValidator

Specified by:

removeValidator in interface Form

update

public void update(java.util.Map<java.lang.String,java.lang.Object> m)

modify an existing Map updating the fields represented by the Form. Fields that are null are removed from the Map

Specified by:

update in interface Form

Parameters:

m - Map to update

diff

public java.lang.String diff(java.util.Map<java.lang.String,java.lang.Object> m)

Compare the values of this forms inputs with the contents of a Map and generate a text summary;

Specified by:

diff in interface Form

Parameters:

m - Map to compare to

Returns:

String summary or null

validate

public final boolean validate()

validate a form This does not attempt to report details of any problem and will return as soon as any validation condition fails.

Specified by:

validate in interface Form

Returns:

boolean true if valid

Throws:

ValidateException

iterator

public java.util.Iterator<Field> iterator()

Specified by:

iterator in interface java.lang.Iterable<Field>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setFormID

public void setFormID(java.lang.String id)

Description copied from interface: Form

Set a form-id for this form. In HTML this is used as a prefix for the input html-ids

Specified by:

setFormID in interface Form

getFormID

public java.lang.String getFormID()

Description copied from interface: Form

get the form-ids In HTML this is used as a prefix for the input html-ids

Specified by:

getFormID in interface Form

Returns:

setAutoFocus

public void setAutoFocus(java.lang.String field)

Description copied from interface: Form

set field for auto-focus

Specified by:

setAutoFocus in interface Form

getAutoFocus

public java.lang.String getAutoFocus()

Description copied from interface: Form

get field for auto-focus

Specified by:

getAutoFocus in interface Form

Returns: