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

Class BaseHTMLForm

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

All Implemented Interfaces:

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

Direct Known Subclasses:

HTMLForm, PageHTMLForm

public abstract class BaseHTMLForm
extends MapForm

Common Base class for different types of HTML Form This class supports stateful/multi-state forms but only if the self FormResult is set when creating the form as multi-stage forms have

Nested Class Summary

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

MapForm.ParseVisitor

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FORM_STAGE_INPUT
static java.lang.String	FORM_STATE_ATTR
static Feature	MULTI_STAGE_FORMS
FormResult	self A FormResult to return to this form.
protected int	stage
protected int	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
BaseHTMLForm(AppContext c)
BaseHTMLForm(AppContext c, FormResult self)

Method Summary

Modifier and Type	Method and Description
static void	emitHiddenParam(ExtendedXMLBuilder hb, Input i)
static void	emitHiddenParam(ExtendedXMLBuilder hb, java.lang.String key, java.lang.String value)
java.lang.String	getActionButtons() emit the action buttons (if any) registered for this form.
XMLContentBuilder	getActionButtons(XMLContentBuilder result)
java.lang.String	getHiddenForm() get the current contents of the form as a set of hidden parameters
<X extends HtmlPrinter> X	getHiddenForm(X result)
static void	getHiddenParam(ExtendedXMLBuilder hb, Input i)
protected java.lang.String	getHtmlFieldTable(java.util.Collection<java.lang.String> missing_fields, java.util.Map<java.lang.String,java.lang.String> errors, java.util.Map<java.lang.String,java.lang.Object> post_params) emit an HTML form with error markup specified if post_params or errors are null show errors from the Form state
protected <X extends XMLContentBuilder> X	getHtmlFieldTable(X result, java.util.Collection<java.lang.String> missing_fields, java.util.Map<java.lang.String,java.lang.String> errors, java.util.Map<java.lang.String,java.lang.Object> post_params)
int	getTargetStage() get which stage of a multi-stage form is being shown/read.
boolean	isComplete() returns the last value returned by #poll(FormResult)
boolean	poll() Attempt to show/validate the current state of the form as part of a multi-phase form.
void	setTargetStage(int stage) set which stage of a multi-stage form is being shown/read
boolean	supportsMultiStage() Query if multi stage forms are supported by this implementation

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

Field Detail

FORM_STATE_ATTR

public static final java.lang.String FORM_STATE_ATTR

See Also:

Constant Field Values

FORM_STAGE_INPUT

public static final java.lang.String FORM_STAGE_INPUT

See Also:

Constant Field Values

MULTI_STAGE_FORMS

public static final Feature MULTI_STAGE_FORMS

self

public final FormResult self

A FormResult to return to this form. This must be set to support stateful/multi-stage forms

stage

protected int stage

target_stage

protected int target_stage

Constructor Detail

BaseHTMLForm

public BaseHTMLForm(AppContext c,
                    FormResult self)

BaseHTMLForm

public BaseHTMLForm(AppContext c)

Method Detail

getTargetStage

public int getTargetStage()

Description copied from interface: Form

get which stage of a multi-stage form is being shown/read.

Returns:

setTargetStage

public void setTargetStage(int stage)

Description copied from interface: Form

set which stage of a multi-stage form is being shown/read

poll

public boolean poll()
             throws TransitionException

Description copied from interface: Form

Attempt to show/validate the current state of the form as part of a multi-phase form. This is called during form construction when values from inputs are needed to construct the rest of the form. If the method returns true then form construction can continue. For GUI forms this may mean that a partial form has been shown and completed by the end user. If false then the method will have modified the form to add actions to progress the multi-stage completion and the form should be displayed as-is.

If multi-stage submission is not supported the method will just return true.

Returns:

boolean true if form build should continue

Throws:

TransitionException

supportsMultiStage

public final boolean supportsMultiStage()

Description copied from interface: Form

Query if multi stage forms are supported by this implementation

Returns:

isComplete

public boolean isComplete()

Description copied from interface: Form

returns the last value returned by #poll(FormResult)

Returns:

getActionButtons

public java.lang.String getActionButtons()

emit the action buttons (if any) registered for this form.

Returns:

String HTML fragment

getActionButtons

public XMLContentBuilder getActionButtons(XMLContentBuilder result)

getHiddenForm

public java.lang.String getHiddenForm()

get the current contents of the form as a set of hidden parameters

Returns:

String HTML form fragment

getHiddenForm

public <X extends HtmlPrinter> X getHiddenForm(X result)

getHtmlFieldTable

protected java.lang.String getHtmlFieldTable(java.util.Collection<java.lang.String> missing_fields,
                                             java.util.Map<java.lang.String,java.lang.String> errors,
                                             java.util.Map<java.lang.String,java.lang.Object> post_params)

emit an HTML form with error markup specified if post_params or errors are null show errors from the Form state

Parameters:

missing_fields -

errors -

post_params -

Returns:

string HTML fragment

Throws:

java.lang.Exception

getHtmlFieldTable

protected <X extends XMLContentBuilder> X getHtmlFieldTable(X result,
                                                            java.util.Collection<java.lang.String> missing_fields,
                                                            java.util.Map<java.lang.String,java.lang.String> errors,
                                                            java.util.Map<java.lang.String,java.lang.Object> post_params)

emitHiddenParam

public static void emitHiddenParam(ExtendedXMLBuilder hb,
                                   Input i)

emitHiddenParam

public static void emitHiddenParam(ExtendedXMLBuilder hb,
                                   java.lang.String key,
                                   java.lang.String value)

getHiddenParam

public static void getHiddenParam(ExtendedXMLBuilder hb,
                                  Input i)