com.arsdigita.bebop
Class Wizard
java.lang.Object
com.arsdigita.bebop.Completable
com.arsdigita.bebop.SimpleComponent
com.arsdigita.bebop.FormSection
com.arsdigita.bebop.Form
com.arsdigita.bebop.MultiStepForm
com.arsdigita.bebop.Wizard
- All Implemented Interfaces:
- BebopConstants, Cloneable, Component, Container, Lockable
- public class Wizard
- extends MultiStepForm
The Wizard class can be used in conjunction with FormStep to build a series
of forms that gather information from the user in several stages. A simple
two stage confirmation step would be built like this:
// The first step asks the user for a subject and body.
FormStep one = new FormStep("one");
one.add(new Label("Subject"));
final TextField subject = new TextField("subject");
one.add(subject);
one.add(new Label("Body"));
final TextArea body = new TextArea("body");
one.add(body);
// The second step displays the subject and body to the user as it will
// appear when posted.
GridPanel two = new GridPanel(1);
two.add(new Label() {
public String getLabel(PageState ps) {
return "Subject: " + subject.getValue(ps);
}
});
two.add(new Label() {
public String getLabel(PageState ps) {
return (String) body.getValue(ps);
}
});
two.add(new Label("Are you sure?"));
// Create the wizard and add the steps in the appropriate order.
Wizard form = new Wizard("post");
form.add(one);
form.add(two);
// Add a process listener to actually save the message.
form.addProcessListener(new FormProcessListener() {
public void process(FormSectionEvent evt) {
PageState ps = evt.getPageState();
System.out.println("SAVING MESSAGE");
System.out.println("Subject: " + subject.getValue(ps));
System.out.println("Body: " + body.getValue(ps));
}
});
- Version:
- $Revision: #9 $ $Date: 2004/04/07 $
- Author:
- rhs@mit.edu
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 |
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, 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
Wizard
public Wizard(String name)
Wizard
public Wizard(String name,
Container panel)
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 MultiStepForm
add
public void add(Container step)
add
public void add(Container step,
int constraints)
getCancel
public Submit getCancel()
getFinish
public Submit getFinish()
isFirst
public boolean isFirst(PageState ps)
isLast
public boolean isLast(PageState ps)
next
public void next(PageState ps)
previous
public void previous(PageState ps)
fireSubmitted
protected void fireSubmitted(FormSectionEvent evt)
throws FormProcessException
- Description copied from class:
FormSection
- Calls the
submitted
method on all registered submission
listeners.
- Overrides:
fireSubmitted
in class FormSection
- Parameters:
evt
- the event to pass to the listeners
- Throws:
FormProcessException
- if one of the listeners throws such an
exception.
fireProcess
protected void fireProcess(FormSectionEvent evt)
throws FormProcessException
- Description copied from class:
FormSection
- Calls the
process
method on all registered process
listeners.
- Overrides:
fireProcess
in class FormSection
- Parameters:
evt
- the event to pass to the listeners
- Throws:
FormProcessException
- if one of the listeners throws such an
exception.
Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 20 2004:2337 UTC