uk.ac.ed.epcc.webapp.forms.html

Class HTMLForm

java.lang.Object

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

uk.ac.ed.epcc.webapp.forms.MapForm

uk.ac.ed.epcc.webapp.forms.html.BaseHTMLForm

uk.ac.ed.epcc.webapp.forms.html.HTMLForm

All Implemented Interfaces:

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

public class HTMLForm
extends BaseHTMLForm

HTMLForm is a class representing a form in HTML This type of form is for the MVC pattern where the form page is seperate from the processing Servlet. If an error occurs then the info is stored in the request and the posting page is invoked.

Nested Class Summary

Nested classes/interfaces inherited from class uk.ac.ed.epcc.webapp.forms.MapForm

MapForm.ParseVisitor

Field Summary

Fields inherited from class uk.ac.ed.epcc.webapp.forms.html.BaseHTMLForm

FORM_STAGE_INPUT, FORM_STATE_ATTR, MULTI_STAGE_FORMS, self, stage, target_stage

Fields inherited from class uk.ac.ed.epcc.webapp.forms.MapForm

action_name, GENERAL_ERROR

Fields inherited from class uk.ac.ed.epcc.webapp.forms.BaseForm

additional_confirm, log, validators

Constructor Summary

Constructors

Constructor and Description
HTMLForm(AppContext c)
HTMLForm(AppContext c, FormResult self)

Method Summary

Modifier and Type	Method and Description
static void	addFieldError(java.lang.String field, java.lang.String text, HttpServletRequest request)
static void	addGeneralError(java.lang.String text, HttpServletRequest request)
static void	clearErrors(HttpServletRequest request)
static void	doFormError(AppContext ctx, HttpServletRequest req, HttpServletResponse res) redirect to the submitting form if errors occur in the form We expect the URL of the submitting form to be avaliable as a "form_url" parameter.from the form.
static java.util.Map<java.lang.String,java.lang.String>	getErrors(HttpServletRequest request)
static java.lang.String	getGeneralError(HttpServletRequest request)
java.lang.String	getHtmlFieldTable() emit a HTML edit form based on the current internal state of the form any internal inconsistencies of the state are shown as errors.
java.lang.String	getHtmlFieldTable(HttpServletRequest req) emit the HTML edit form based on the current request if there are no current errors then the internal form state is shown but unvalidated (assume these are the default values of a creation form).
<X extends XMLContentBuilder> X	getHtmlFieldTable(X result) emit a HTML edit form based on the current internal state of the form any internal inconsistencies of the state are shown as errors.
<X extends HtmlBuilder> X	getHtmlFieldTable(X result, HttpServletRequest req) emit the HTML edit form based on the current request if there are no current errors then the internal form state is shown but unvalidated (assume these are the default values of a creation form).
java.lang.String	getHtmlFieldTableFromRequest(HttpServletRequest req, boolean use_required)
static java.util.Collection<java.lang.String>	getMissing(HttpServletRequest request)
static boolean	hasError(HttpServletRequest request)
ConfirmMessage	mustConfirm(java.util.Map params) Checks the requested action.
boolean	parsePost(HttpServletRequest req) parse and validate a post request.
static void	setFormUrl(HttpServletRequest req, java.lang.String url) Record the form url that should be forwarded to if the form contains errors.

Methods inherited from class uk.ac.ed.epcc.webapp.forms.html.BaseHTMLForm

emitHiddenParam, emitHiddenParam, getActionButtons, getActionButtons, getHiddenForm, getHiddenForm, getHiddenParam, getHtmlFieldTable, getHtmlFieldTable, getTargetStage, isComplete, poll, setTargetStage, supportsMultiStage

Methods inherited from class uk.ac.ed.epcc.webapp.forms.MapForm

addStringMap, doAction, getActionName, getShortcutAction, locateAction, parsePost, setActionName, validate

Methods inherited from class uk.ac.ed.epcc.webapp.forms.BaseForm

addAction, addInput, addInput, addValidator, clear, containsInput, diff, doAction, fieldCount, get, getAction, getActionNames, getAutoFocus, getContents, getContext, getField, getFieldIterator, getFieldNames, getFormID, getInput, getItem, getLogger, getSingleActionName, getTable, getValidators, hasActions, hasField, iterator, makeField, mustConfirm, put, removeAction, removeField, removeValidator, setAutoFocus, setConfirm, setContents, setFormID, toString, update, validate

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

isFixed

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

HTMLForm

public HTMLForm(AppContext c)

HTMLForm

public HTMLForm(AppContext c,
                FormResult self)

Method Detail

getHtmlFieldTable

public java.lang.String getHtmlFieldTable()

emit a HTML edit form based on the current internal state of the form any internal inconsistencies of the state are shown as errors. used for initial show of an update form

Returns:

String HTML form fragment

getHtmlFieldTable

public <X extends XMLContentBuilder> X getHtmlFieldTable(X result)

emit a HTML edit form based on the current internal state of the form any internal inconsistencies of the state are shown as errors. used for initial show of an update form

Parameters:

result - to modify

Returns:

HtmlPrinter form fragment

getHtmlFieldTable

public java.lang.String getHtmlFieldTable(HttpServletRequest req)

emit the HTML edit form based on the current request if there are no current errors then the internal form state is shown but unvalidated (assume these are the default values of a creation form). For an update form where the initial state should be validated use #getHtmlFieldTable(HtmlPrinter) if there are no errors in the request

Parameters:

req - HttpServletRequest

Returns:

String HTML fragment contain the HTML form

getHtmlFieldTableFromRequest

public java.lang.String getHtmlFieldTableFromRequest(HttpServletRequest req,
                                                     boolean use_required)

getHtmlFieldTable

public <X extends HtmlBuilder> X getHtmlFieldTable(X result,
                                                   HttpServletRequest req)

emit the HTML edit form based on the current request if there are no current errors then the internal form state is shown but unvalidated (assume these are the default values of a creation form). For an update form where the initial state should be validated use #getHtmlFieldTable(HtmlPrinter) if there are no errors in the request

Parameters:

req - HttpServletRequest

Returns:

HtmlPrinter

mustConfirm

public ConfirmMessage mustConfirm(java.util.Map params)
                           throws ActionException

Checks the requested action. IF it needs to be confirmed then return the action string otherwise return null

Parameters:

params - Map of the form parameters

Returns:

String, the action string or null if confirmation not needed

Throws:

ActionException

parsePost

public boolean parsePost(HttpServletRequest req)

parse and validate a post request.

Parameters:

req -

Returns:

boolean true if all ok

addGeneralError

public static void addGeneralError(java.lang.String text,
                                   HttpServletRequest request)

addFieldError

public static void addFieldError(java.lang.String field,
                                 java.lang.String text,
                                 HttpServletRequest request)

clearErrors

public static void clearErrors(HttpServletRequest request)

doFormError

public static void doFormError(AppContext ctx,
                               HttpServletRequest req,
                               HttpServletResponse res)

redirect to the submitting form if errors occur in the form We expect the URL of the submitting form to be avaliable as a "form_url" parameter.from the form. This avoid the Servlets needing to know which form submitted to them and keeps presentation and logic seperate. The actuall error information is cached in the request object by the Form Code

Parameters:

ctx - AppContext

req - Request

res - Response

setFormUrl

public static void setFormUrl(HttpServletRequest req,
                              java.lang.String url)

Record the form url that should be forwarded to if the form contains errors. This should be set by the servlet (which presumably knows where its form lives) early on in the processing so it can be retreived by the lower level error handling

Parameters:

req - HttpServletRequest request

url - URL of form script

getErrors

public static java.util.Map<java.lang.String,java.lang.String> getErrors(HttpServletRequest request)

getGeneralError

public static java.lang.String getGeneralError(HttpServletRequest request)

getMissing

public static java.util.Collection<java.lang.String> getMissing(HttpServletRequest request)

hasError

public static boolean hasError(HttpServletRequest request)