com.arsdigita.bebop
Class MultiStepForm
java.lang.Object
com.arsdigita.bebop.Completable
com.arsdigita.bebop.SimpleComponent
com.arsdigita.bebop.FormSection
com.arsdigita.bebop.Form
com.arsdigita.bebop.MultiStepForm
- All Implemented Interfaces:
- BebopConstants, Cloneable, Component, Container, Lockable
- Direct Known Subclasses:
- Wizard
- public class MultiStepForm
- extends Form
The MultiStepForm class is a simple extension to Form that modifies the
behavior of Form with respect to widgets that are not visible. Instead of
generating no XML for widgets that are not visible, the MultiStepForm class
generates XML that preserves the sate of non visible widgets using hidden
form variables. This allows a single form to preserve data across multiple
submits thereby allowing multi step forms such as confirmation forms or
wizards to be easily created. When creating complicated wizards it is
useful to use MultiStepForm in conjunction with the FormStep
class
to provide cascading initialization of the different steps in the form.
- Version:
- $Revision: #8 $ $Date: 2004/04/07 $
- Author:
- rhs@mit.edu
- See Also:
FormStep
,
Wizard
Fields inherited from class com.arsdigita.bebop.Form |
GET, POST |
Fields inherited from interface com.arsdigita.bebop.util.BebopConstants |
BEBOP_BORDER, BEBOP_BOXPANEL, BEBOP_CELL, BEBOP_CHECKBOX, BEBOP_CHECKBOXGROUP, BEBOP_COLUMNPANEL, BEBOP_DATE, BEBOP_DATETIME, BEBOP_DHTMLEDITOR, BEBOP_FORMERRORS, BEBOP_FORMWIDGET, BEBOP_GRIDPANEL, BEBOP_LIST, BEBOP_MULTISELECT, BEBOP_OPTION, BEBOP_PAD, BEBOP_PADFRAME, BEBOP_PANELROW, BEBOP_PORTAL, BEBOP_PORTLET, BEBOP_RADIO, BEBOP_RADIOGROUP, BEBOP_SEG_BODY, BEBOP_SEG_HEADER, BEBOP_SEG_PANEL, BEBOP_SEGMENT, BEBOP_SELECT, BEBOP_TABLE, BEBOP_TABLEBODY, BEBOP_TABLEROW, BEBOP_TEXTAREA |
Method Summary |
protected Element |
generateXMLSansState(PageState ps,
Element parent)
Generates the XML representing the form and its widgets, but not the
state information from s . |
void |
register(Page p)
Adds this form to the page and traverses the components contained in
this form, collecting parameterModels and Listeners into this form's
FormModel. |
Methods inherited from class com.arsdigita.bebop.Form |
addMagicTag, excludeParameterFromExport, generateErrors, generateXML, getAction, getFormData, getName, getProcessInvisible, isRedirecting, process, respond, setAction, setEncType, setFormData, setMethod, setName, setOnReset, setOnSubmit, setProcessInvisible, setRedirecting, toString, traverse |
Methods inherited from class com.arsdigita.bebop.FormSection |
add, add, addCancelListener, addInitListener, addProcessListener, addSubmissionListener, addValidationListener, children, contains, createInitListener, createProcessListener, createSubmissionListener, createValidationListener, fireCancel, fireInit, fireProcess, fireSubmitted, fireValidate, forwardInit, forwardProcess, forwardSubmission, forwardValidation, get, getModel, getPanel, indexOf, isEmpty, lock, register, removeCancelListener, removeInitListener, removeProcessListener, removeSubmissionListener, removeValidationListener, size |
Methods inherited from class com.arsdigita.bebop.SimpleComponent |
clone, exportAttributes, getAttribute, getClassAttr, getIdAttr, getKey, getMetaDataAttribute, getStyleAttr, hasAttributes, isLocked, isVisible, setAttribute, setClassAttr, setIdAttr, setKey, setMetaDataAttribute, setStyleAttr, setVisible |
versionId
public static final String versionId
- See Also:
- Constant Field Values
MultiStepForm
public MultiStepForm(String name)
- See Also:
Form.Form(String)
MultiStepForm
public MultiStepForm(String name,
Container panel)
- See Also:
Form.Form(String, Container)
register
public void register(Page p)
- Description copied from class:
Form
- Adds this form to the page and traverses the components contained in
this form, collecting parameterModels and Listeners into this form's
FormModel.
- Specified by:
register
in interface Component
- Overrides:
register
in class Form
- Parameters:
p
- page in which to register this form
generateXMLSansState
protected Element generateXMLSansState(PageState ps,
Element parent)
- Description copied from class:
Form
- Generates the XML representing the form and its widgets, but not the
state information from
s
.
- Overrides:
generateXMLSansState
in class Form
- Parameters:
ps
- represents the curent request
- Returns:
- the top-level element for the form
Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 21 2004:2337 UTC