As an example, a form that accepts a first and last name may be set - * up as follows: + *
+ * As an example, a form that accepts a first and last name may be set up as follows: * *
- * public class MyForm extends Form
- * implements FormProcessListener {
+ * public class MyForm extends Form implements FormProcessListener {
*
- * private Text m_firstName;
- * private Text m_lastName;
+ * private Text m_firstName; private Text m_lastName;
*
- * public MyForm() {
- * super("myform");
- * add(new Label("First Name:"));
- * m_firstName = new Text("firstName");
- * m_firstName.setDefaultValue("John");
- * add(m_firstName);
+ * public MyForm() { super("myform"); add(new Label("First Name:")); m_firstName = new
+ * Text("firstName"); m_firstName.setDefaultValue("John"); add(m_firstName);
*
- * add(new Label("Last Name:"));
- * m_lastName = new Text("lastName");
- * m_lastName.setDefaultValue("Doe");
- * m_lastName.addValidationListener(new NotNullValidationListener
- * ("The last name"));
- * add(m_lastName);
+ * add(new Label("Last Name:")); m_lastName = new Text("lastName");
+ * m_lastName.setDefaultValue("Doe"); m_lastName.addValidationListener(new NotNullValidationListener
+ * ("The last name")); add(m_lastName);
*
- * add(new Submit("save", "Save"));
- * addProcessListener(this);
- * }
+ * add(new Submit("save", "Save")); addProcessListener(this); }
*
- * public void process(FormSectionEvent e) {
- * PageState s = e.getPageState();
+ * public void process(FormSectionEvent e) { PageState s = e.getPageState();
*
- * System.out.println("You are " + m_firstName.getValue(s)
- * + " " + m_lastName.getValue(s));
- * }
- * }
+ * System.out.println("You are " + m_firstName.getValue(s) + " " + m_lastName.getValue(s)); } }
*
*
- * This form automatically checks that the user supplied a last name. Only
- * then does it call the process method, which prints the
- * user-supplied values.
+ *
+ * This form automatically checks that the user supplied a last name. Only then does it call the
+ * process method, which prints the user-supplied values.
*
* @author Karl Goldstein
* @author Uday Mathur
@@ -90,28 +74,25 @@ import org.apache.log4j.Logger;
* @version $Id: Form.java 287 2005-02-22 00:29:02Z sskracic $
*/
public class Form extends FormSection implements BebopConstants {
-
- /** Internal logger instance to faciliate debugging. Enable logging output
- * by editing /WEB-INF/conf/log4j.properties int hte runtime environment
- * and set com.arsdigita.bebop.Form=DEBUG by uncommenting
- * or adding the line. */
+ /**
+ * Internal logger instance to faciliate debugging. Enable logging output by editing
+ * /WEB-INF/conf/log4j.properties int hte runtime environment and set
+ * com.arsdigita.bebop.Form=DEBUG by uncommenting or adding the line.
+ */
private static final Logger s_log = Logger.getLogger(Form.class);
/**
- * Constant for specifying a get submission method for this
- * form. See the W3C
- * HTML specification for a description of what this attribute
- * does.
+ * Constant for specifying a get submission method for this form. See the W3C HTML specification for
+ * a description of what this attribute does.
*/
public final static String GET = "get";
/**
- * Constant for specifying a post submission method for this
- * form. See the W3C HTML
- * specification for a description of what this attribute does.
+ * Constant for specifying a post submission method for this form. See the W3C HTML specification for
+ * a description of what this attribute does.
*/
public final static String POST = "post";
@@ -134,18 +115,15 @@ public class Form extends FormSection implements BebopConstants {
private RequestLocal m_formData;
/**
- * Determines whether or not a form is 'redirecting', meaning that
- * it will clear the control event and redirect to the resulting
- * state after form processing, so that a page reload won't cause
- * the form to be resubmitted.
+ * Determines whether or not a form is 'redirecting', meaning that it will clear the control
+ * event and redirect to the resulting state after form processing, so that a page reload won't
+ * cause the form to be resubmitted.
*/
private boolean m_isRedirecting = false;
-
/**
- * Constructs a new form with the specified name.
- * At the time of creation, instantiates a new form model for the form and
- * instantiates a default ColumnPanel to contain the components.
+ * Constructs a new form with the specified name. At the time of creation, instantiates a new
+ * form model for the form and instantiates a default ColumnPanel to contain the components.
*
* @param name the name of the form
*/
@@ -154,12 +132,11 @@ public class Form extends FormSection implements BebopConstants {
}
/**
- * Constructs a new form with the specified name and container. At the time
- * of creation, instantiates a new form model for the form and replaces
- * the default ColumnPanel with the specified container as the implicit
- * container of the components.
+ * Constructs a new form with the specified name and container. At the time of creation,
+ * instantiates a new form model for the form and replaces the default ColumnPanel with the
+ * specified container as the implicit container of the components.
*
- * @param name the name attribute of the form
+ * @param name the name attribute of the form
* @param panel the implicit container that will hold the components
*/
public Form(String name, Container panel) {
@@ -170,29 +147,29 @@ public class Form extends FormSection implements BebopConstants {
addMagicTag();
}
-
/**
- * Writes the output to a DOM to be used with the XSLT template to produce
- * the appropriate output. If the form is not visible, no output is
- * generated.
+ * Writes the output to a DOM to be used with the XSLT template to produce the appropriate
+ * output. If the form is not visible, no output is generated.
*
- *
Generates a DOM fragment: - *
+ * Generates a DOM fragment:
+ *
+ * Determine whether or not this Form will redirect after its
- * process listeners are fired.
+ * Determine whether or not this Form will redirect after its process listeners are fired.
+ *
* <bebop:form action=%url; %bebopAttr;>
* .. XML for panel ..
* .. XML for page state ..
* </bebop:form>
* s.
+ * Generates the XML representing the form and its widgets, but not the state information from
+ * s.
*
- * @param s represents the curent request
+ * @param s represents the curent request
* @param parent
+ *
* @return the top-level element for the form
*/
protected Element generateXMLSansState(PageState s, Element parent) {
@@ -215,7 +193,6 @@ public class Form extends FormSection implements BebopConstants {
// Encode the URL with the servlet session information;
// do not use DispatcherHelper.encodeURL because the
// ACS global parameters are provided via the FormData.
-
String url = null;
if (m_action == null) {
@@ -242,41 +219,43 @@ public class Form extends FormSection implements BebopConstants {
}
/**
- *
+ *
* @param ps
- * @param parent
+ * @param parent
*/
protected void generateErrors(PageState ps, Element parent) {
- for (Iterator it = getFormData(ps).getErrors(); it.hasNext(); ) {
+ for (Iterator it = getFormData(ps).getErrors(); it.hasNext();) {
Element errors = parent.newChildElement(BEBOP_FORMERRORS,
BEBOP_XML_NS);
- errors.addAttribute("message",
- (String)((GlobalizedMessage) it.next()).localize
- (ps.getRequest())
- );
+ Object msg = it.next();
+
+ if (msg == null) {
+ errors.addAttribute("message", "Unknown error");
+ } else {
+ errors.addAttribute("message",
+ (String) ((GlobalizedMessage) msg).localize(ps.getRequest()));
+ }
errors.addAttribute("id", getName());
}
}
/**
- * state.
+ * Responds to the request by processing this form with the HTTP request given in
+ * state.
+ *
* @see #process process(...)
*
* @param state represents the current request
+ *
* @throws javax.servlet.ServletException
*/
@Override
@@ -306,11 +287,11 @@ public class Form extends FormSection implements BebopConstants {
// * * * * * * * * * * * * * * * * * * * * * * * * * * * *
// Methods to set the HTML attributes of the FORM element
// * * * * * * * * * * * * * * * * * * * * * * * * * * * *
-
/**
* Sets the name attribute for the form.
*
* @param name the name for the form
+ *
* @pre ! isLocked()
*/
public void setName(String name) {
@@ -328,11 +309,11 @@ public class Form extends FormSection implements BebopConstants {
}
/**
- * Sets the enctype attribute used in the
- * form element. No encoding type is specified by
- * default.
+ * Sets the enctype attribute used in the form element. No encoding
+ * type is specified by default.
*
* @param encType the encoding type
+ *
* @pre ! isLocked()
*/
public void setEncType(String encType) {
@@ -341,12 +322,11 @@ public class Form extends FormSection implements BebopConstants {
}
/**
- * Sets the onSubmit attribute used in the
- * form element. No onsubmit handler is specified by
- * default.
+ * Sets the onSubmit attribute used in the form element. No onsubmit
+ * handler is specified by default.
+ *
+ * @param javascriptCode the javascript code associated with this attribute
*
- * @param javascriptCode the javascript code associated with this
- * attribute
* @pre ! isLocked()
*/
public void setOnSubmit(String javascriptCode) {
@@ -355,12 +335,11 @@ public class Form extends FormSection implements BebopConstants {
}
/**
- * Sets the ONRESET attribute used in the
- * FORM element. No onreset handler is specified by
- * default.
+ * Sets the ONRESET attribute used in the FORM element. No onreset
+ * handler is specified by default.
+ *
+ * @param javascriptCode the javascript code associated with this attribute
*
- * @param javascriptCode the javascript code associated with this
- * attribute
* @pre ! isLocked()
*/
public void setOnReset(String javascriptCode) {
@@ -372,6 +351,7 @@ public class Form extends FormSection implements BebopConstants {
* Sets the HTTP method used to submit the form.
*
* @param method either GET or POST
+ *
* @pre ! isLocked()
*/
public void setMethod(String method) {
@@ -384,12 +364,10 @@ public class Form extends FormSection implements BebopConstants {
}
/**
- * Returns true if form processing is turned on when the form is
- * invisible.
+ * Returns true if form processing is turned on when the form is invisible.
*
- * @return true if the form listeners should be
- * processed even when the form is not visible on the page,
- * false otherwise
+ * @return true if the form listeners should be processed even when the form is not visible on
+ * the page, false otherwise
*/
protected boolean getProcessInvisible() {
return m_processInvisible;
@@ -398,24 +376,24 @@ public class Form extends FormSection implements BebopConstants {
/**
* Turns form processing on/off when the form is invisible.
*
- * @param processInvisible true if the form listeners should be
- * processed even when the form is not visible on the page
+ * @param processInvisible true if the form listeners should be processed even when the form is
+ * not visible on the page
*/
protected void setProcessInvisible(boolean processInvisible) {
m_processInvisible = processInvisible;
}
/**
- * Sets the URL for the form's action attribute. This
- * is the URL to which submissions will be sent when the user
- * clicks a submit button on the form. By default, the action is
- * null, instructing the form to set the action to
- * the URL of the page in which it is used. If the action is set
- * to a different URL, none of the listeners registered with this
- * form will be run.
+ * Sets the URL for the form's action attribute. This is the URL to which
+ * submissions will be sent when the user clicks a submit button on the form. By default, the
+ * action is null, instructing the form to set the action to the URL of the page in
+ * which it is used. If the action is set to a different URL, none of the listeners registered
+ * with this form will be run.
*
* @param action the URL to submit this form to
- * @pre ! isLocked() */
+ *
+ * @pre ! isLocked()
+ */
public void setAction(String action) {
Assert.isUnlocked(this);
m_action = action;
@@ -425,22 +403,24 @@ public class Form extends FormSection implements BebopConstants {
* Returns the URL for the form's action attribute.
*
* @return the URL to which to submit this form.
+ *
* @see #setAction setAction
*/
- public final String getAction(){
+ public final String getAction() {
return m_action;
}
/**
- * Processes this form, creating a FormData object. Runs the
- * right set of init, validation, and process listeners, depending on
- * whether this is an initial request to the form and whether the form
- * submission was valid. Submission listeners are always run.
+ * Processes this form, creating a FormData object. Runs the right set of init,
+ * validation, and process listeners, depending on whether this is an initial request to the
+ * form and whether the form submission was valid. Submission listeners are always run.
+ *
* @see #getFormData
*
- * @param state represents the current request
- * @return the values extracted from the HTTP request contained
- * in state.
+ * @param state represents the current request
+ *
+ * @return the values extracted from the HTTP request contained in state.
+ *
* @throws com.arsdigita.bebop.FormProcessException
* @pre state != null
* @post return != null
@@ -448,7 +428,7 @@ public class Form extends FormSection implements BebopConstants {
@Override
public FormData process(PageState state) throws FormProcessException {
Assert.exists(state, "PageState");
- FormData result = new FormData(getModel(), state.getRequest());
+ FormData result = new FormData(getModel(), state.getRequest());
setFormData(state, result);
// Unless invisible form processing is turned on, don't run any
@@ -461,14 +441,14 @@ public class Form extends FormSection implements BebopConstants {
/**
* Returns the form data constructed by the {@link #process
- * process} method for the request described by
- * state. Processes the form if it has not already
- * been processed.
+ * process} method for the request described by state. Processes the form if it has
+ * not already been processed.
*
* @param state describes the current request
- * @return the values extracted from the HTTP request contained
- * in state, or null if the form has not been
- * processed yet.
+ *
+ * @return the values extracted from the HTTP request contained in state, or
+ * null if the form has not been processed yet.
+ *
* @pre state != null
* @post return != null
*/
@@ -476,10 +456,9 @@ public class Form extends FormSection implements BebopConstants {
return (FormData) m_formData.get(state);
}
-
/**
- * Adds a Hidden Tag to this form so that our controller can determine if
- * this is an initial request.
+ * Adds a Hidden Tag to this form so that our controller can determine if this is an initial
+ * request.
*/
protected void addMagicTag() {
Hidden h = new Hidden(getModel().getMagicTagName());
@@ -488,30 +467,30 @@ public class Form extends FormSection implements BebopConstants {
}
/**
- * Traverses the components contained in this form, collecting
- * parameterModels and Listeners into this form's FormModel.
+ * Traverses the components contained in this form, collecting parameterModels and Listeners
+ * into this form's FormModel.
*/
protected void traverse() {
Traversal formRegistrar = new Traversal() {
- @Override
- protected void act(Component c) {
- if ( c == Form.this ) {
- return;
- }
- if ( c instanceof Form ) {
- throw new IllegalStateException
- ("Forms cannot contain other Forms");
- }
- c.register(Form.this, getModel());
+
+ @Override
+ protected void act(Component c) {
+ if (c == Form.this) {
+ return;
}
- };
+ if (c instanceof Form) {
+ throw new IllegalStateException("Forms cannot contain other Forms");
+ }
+ c.register(Form.this, getModel());
+ }
+
+ };
formRegistrar.preorder(this);
}
/**
- * Adds this form to the page and traverses the components contained in
- * this form, collecting parameterModels and Listeners into this form's
- * FormModel.
+ * Adds this form to the page and traverses the components contained in this form, collecting
+ * parameterModels and Listeners into this form's FormModel.
*
* @param p page in which to register this form
*/
@@ -522,7 +501,8 @@ public class Form extends FormSection implements BebopConstants {
}
/**
- * TODO
+ * TODO
+ *
* @param model
*/
public void excludeParameterFromExport(ParameterModel model) {
@@ -530,26 +510,27 @@ public class Form extends FormSection implements BebopConstants {
}
/**
- * Initialize m_formData so that accessing the per-request
- * form data forces the form to be processed on the first access and
- * caches the form data for subsequent requests.
+ * Initialize m_formData so that accessing the per-request form data forces the
+ * form to be processed on the first access and caches the form data for subsequent requests.
*/
private void initFormData() {
m_formData = new RequestLocal() {
- @Override
- protected Object initialValue(PageState s) {
+
+ @Override
+ protected Object initialValue(PageState s) {
// TODO: We need to come up with the right strategy for
- // how we deal with FormProcessExceptions. Are they fatal
- // ? Do we just add them to the form validation errors ?
- try {
- return process(s);
- } catch (FormProcessException e) {
- s_log.error("Form Process exception", e);
- throw new UncheckedWrapperException("Form Process error: "
+ // how we deal with FormProcessExceptions. Are they fatal
+ // ? Do we just add them to the form validation errors ?
+ try {
+ return process(s);
+ } catch (FormProcessException e) {
+ s_log.error("Form Process exception", e);
+ throw new UncheckedWrapperException("Form Process error: "
+ e.getMessage(), e);
- }
}
- };
+ }
+
+ };
}
/**
@@ -559,20 +540,19 @@ public class Form extends FormSection implements BebopConstants {
*/
@Override
public String toString() {
- return super.toString() + " " +
- "[" + getName() + "," + getAction() + "," + getMethod() + "," +
- isRedirecting() + "]";
+ return super.toString() + " " + "[" + getName() + "," + getAction() + "," + getMethod()
+ + "," + isRedirecting() + "]";
}
/**
- * Protected access to set the formdata request local.
- * This method is required if a subclass wishes to override the
- * process method.
- *
+ * Protected access to set the formdata request local. This method is required if a subclass
+ * wishes to override the process method.
+ *
* @param state
* @param data
*/
protected void setFormData(PageState state, FormData data) {
m_formData.set(state, data);
}
+
}