| wicket.markup.html.panel.Panel
 wicket.extensions.wizard.Wizard
All known Subclasses: wicket.examples.wizard.NewUserWizard, wicket.examples.wizard.StaticWizardWithPanels, wicket.examples.wizard.StaticWizard,
| Wizard | | public class Wizard extends Panel implements IWizardModelListener,IWizard(Code) | | A wizard is a dialog component that takes it's users through a number of
predefined steps. It has common functionality like a next, previous, finish
and cancel button, and it uses a
IWizardModel to navigate through the
steps.
This default implementation should be useful for basic cases, if the layout
is exactly what you need. If you want to provide your own layout and/ or have
more or less components (e.g. you want to additionally provide an overview
component), you can override this class and add the components you want
yourself.
If that's still not enough flexiblity for you, but you want to use the
IWizardModel wizard model and
IWizardStep wizard step functionality provided in this package, you can provde a custom wizard
author:
Eelco Hillenius |
| Field Summary | |
| final public static String | BUTTONS_ID
Component id of the buttons panel as used by the default wizard panel. | | final public static String | FEEDBACK_ID
Component id of the feedback panel as used by the default wizard panel. | | final public static String | HEADER_ID
Component id of the header panel as used by the default wizard panel. | | final public static String | OVERVIEW_ID
Component id of the overview panel as used by the default wizard panel. | | final public static String | VIEW_ID
Component id of the view panel (where the main wizard contents go) as
used by the default wizard panel. |
| BUTTONS_ID | | final public static String BUTTONS_ID(Code) | | Component id of the buttons panel as used by the default wizard panel.
|
| FEEDBACK_ID | | final public static String FEEDBACK_ID(Code) | | Component id of the feedback panel as used by the default wizard panel.
|
| HEADER_ID | | final public static String HEADER_ID(Code) | | Component id of the header panel as used by the default wizard panel.
|
| OVERVIEW_ID | | final public static String OVERVIEW_ID(Code) | | Component id of the overview panel as used by the default wizard panel.
|
| VIEW_ID | | final public static String VIEW_ID(Code) | | Component id of the view panel (where the main wizard contents go) as
used by the default wizard panel.
|
| Wizard | | public Wizard(String id)(Code) | | Construct. Adds the default style.
If you override this class, it makes sense to call this constructor
(super(id)), then - in your constructor - construct a transition model
and then call
Wizard.init(IWizardModel) to initialize the wizard.
This constructor is not meant for normal clients of this class
Parameters:
id - The component model |
| Wizard | | public Wizard(String id, boolean addDefaultCssStyle)(Code) | | Construct.
If you override this class, it makes sense to call this constructor
(super(id)), then - in your constructor - construct a transition model
and then call
Wizard.init(IWizardModel) to initialize the wizard.
This constructor is not meant for normal clients of this class
Parameters:
id - The component model
Parameters:
addDefaultCssStyle - Whether to add the Wizard.addDefaultCssStyle() default style |
| Wizard | | public Wizard(String id, IWizardModel wizardModel)(Code) | | Construct with a transition model. Adds the default style.
For most clients, this is typically the right constructor to use.
Parameters:
id - The component id
Parameters:
wizardModel - The transitions model |
| Wizard | | public Wizard(String id, IWizardModel wizardModel, boolean addDefaultCssStyle)(Code) | | Construct with a transition model.
For most clients, this is typically the right constructor to use.
Parameters:
id - The component id
Parameters:
wizardModel - The transitions model
Parameters:
addDefaultCssStyle - Whether to add the Wizard.addDefaultCssStyle() default style |
| addDefaultCssStyle | | final public void addDefaultCssStyle()(Code) | | Will let the wizard contribute a CSS include to the page's header. It
will add Wizard.css from this package. This method is typically called by
the class that creates the wizard.
|
| getActiveStep | | final public IWizardStep getActiveStep()(Code) | | Convenience method to get the active step from the model.
The active step |
| getForm | | final public Form getForm()(Code) | | Gets the form in which the view is nested, and on which the wizard
buttons work.
The wizard form |
| init | | protected void init(IWizardModel wizardModel)(Code) | | Initialize this wizard with a transition model.
If you constructed this wizard using a constructor without the
transitions model argument, you must call this method
prior to actually using it.
Parameters:
wizardModel - |
| isVersioned | | public boolean isVersioned()(Code) | | Turn versioning off for wizards. This works best when the wizard is
not accessed from bookmarkable pages, so that the url
doesn't change at all.
False
See Also: wicket.Component.isVersioned |
| newButtonBar | | protected Component newButtonBar(String id)(Code) | | Create a new button bar. Clients can override this method to provide a
custom button bar.
Parameters:
id - The id to be used to construct the component A new button bar |
| newFeedbackPanel | | protected FeedbackPanel newFeedbackPanel(String id)(Code) | | Create a new feedback panel. Clients can override this method to provide
a custom feedback panel.
Parameters:
id - The id to be used to construct the component A new feedback panel |
| newOverviewBar | | protected Component newOverviewBar(String id)(Code) | | Create a new overview bar. Clients can override this method to provide a
custom bar.
Parameters:
id - The id to be used to construct the component A new ovewview bar |
| onCancel | | public void onCancel()(Code) | | Called when the wizard is cancelled.
|
| onFinish | | public void onFinish()(Code) | | Called when the wizard is finished.
|
|
|