|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.wicket.Component
org.apache.wicket.MarkupContainer
org.apache.wicket.markup.html.WebMarkupContainer
org.apache.wicket.markup.html.panel.Panel
org.apache.wicket.extensions.wizard.WizardStep
public class WizardStep
default implementation of IWizardStep. It is also a panel, which is used as the view
component.
And example of a custom step with a panel follows. Java (defined e.g. in class x.NewUserWizard):
private final class UserNameStep extends WizardStep
{
public UserNameStep()
{
super(new ResourceModel("username.title"), new ResourceModel("username.summary"));
add(new RequiredTextField("user.userName"));
add(new RequiredTextField("user.email").add(EmailAddressValidator.getInstance()));
}
}
HTML (defined in e.g. file x/NewUserWizard$UserNameStep.html):
<wicket:panel>
<table>
<tr>
<td><wicket:message key="username">Username</wicket:message></td>
<td><input type="text" wicket:id="user.userName" /></td>
</tr>
<tr>
<td><wicket:message key="email">Email Address</wicket:message></td>
<td><input type="text" wicket:id="user.email" /></td>
</tr>
</table>
</wicket:panel>
| Field Summary |
|---|
| Fields inherited from class org.apache.wicket.markup.html.panel.Panel |
|---|
PANEL |
| Fields inherited from class org.apache.wicket.Component |
|---|
ENABLE, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER |
| Constructor Summary | |
|---|---|
WizardStep()
Construct without a title and a summary. |
|
WizardStep(IModel<String> title,
IModel<String> summary)
Creates a new step with the specified title and summary. |
|
WizardStep(IModel<String> title,
IModel<String> summary,
IModel<?> model)
Creates a new step with the specified title and summary. |
|
WizardStep(String title,
String summary)
Creates a new step with the specified title and summary. |
|
WizardStep(String title,
String summary,
IModel<?> model)
Creates a new step with the specified title and summary. |
|
| Method Summary | |
|---|---|
void |
add(IFormValidator validator)
Adds a form validator. |
void |
applyState()
This method is called whenever the user presses next while this step is active. |
protected void |
detachModel()
Detaches the model for this component if it is detachable. |
Component |
getHeader(String id,
Component parent,
IWizard wizard)
Gets the header component for this step. |
String |
getSummary()
Gets the summary of this step. |
String |
getTitle()
Gets the title of this step. |
Component |
getView(String id,
Component parent,
IWizard wizard)
Returns the current view this step is displaying. |
IWizardModel |
getWizardModel()
|
void |
init(IWizardModel wizardModel)
Called to initialize the step. |
boolean |
isComplete()
Checks if this step is compete. |
protected void |
onInit(IWizardModel wizardModel)
Template method that is called when the step is being initialized. |
protected void |
onInitialize()
This method is meant to be used as an alternative to initialize components. |
void |
setComplete(boolean complete)
Marks this step as compete. |
void |
setSummaryModel(IModel<String> summary)
Sets summary. |
void |
setTitleModel(IModel<String> title)
Sets title. |
| Methods inherited from class org.apache.wicket.markup.html.panel.Panel |
|---|
newMarkupSourcingStrategy |
| Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer |
|---|
getWebPage, getWebRequest |
| Methods inherited from class org.apache.wicket.MarkupContainer |
|---|
add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, hasAssociatedMarkup, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, onMarkupAttached, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, toString, visitChildren, visitChildren, visitChildren, visitChildren |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public WizardStep()
getHeader(String, Component, IWizard).
public WizardStep(IModel<String> title,
IModel<String> summary)
title - the title of this step.summary - a brief summary of this step or some usage guidelines.
public WizardStep(IModel<String> title,
IModel<String> summary,
IModel<?> model)
title - the title of this step.summary - a brief summary of this step or some usage guidelines.model - Any model which is to be used for this step
public WizardStep(String title,
String summary)
title - the title of this step.summary - a brief summary of this step or some usage guidelines.
public WizardStep(String title,
String summary,
IModel<?> model)
title - the title of this step.summary - a brief summary of this step or some usage guidelines.model - Any model which is to be used for this step| Method Detail |
|---|
public final void add(IFormValidator validator)
validator - public void applyState()
IWizardStep
This method will only be called if IWizardModel.isNextAvailable() returns true.
applyState in interface IWizardStepIWizardStep.applyState()
public Component getHeader(String id,
Component parent,
IWizard wizard)
IWizardStep
getHeader in interface IWizardStepid - The id that the component should be created withparent - The parent component (for post 1.2)wizard - The wizard component the header will be placed on
IWizardStep.getHeader(java.lang.String,
org.apache.wicket.Component, org.apache.wicket.extensions.wizard.IWizard)public String getSummary()
public String getTitle()
public Component getView(String id,
Component parent,
IWizard wizard)
IWizardStep
getView in interface IWizardStepid - The id that the component should be created withparent - The parent component (for post 1.2)wizard - The wizard component the header will be placed on
IWizardStep.getView(java.lang.String,
org.apache.wicket.Component, org.apache.wicket.extensions.wizard.IWizard)public final void init(IWizardModel wizardModel)
static wizard model knows all the steps upfront and initializes themm
when starting up. This method will be called when the wizard is initializing.
The dynamic wizard model initializes steps every time they are
encountered.
This method sets the wizard model and then calls template method
onInit(IWizardModel)
init in interface IWizardStepwizardModel - the model to which the step belongs.public boolean isComplete()
setComplete(boolean) .
isComplete in interface IWizardStepsetComplete(boolean)public void setComplete(boolean complete)
complete - true to allow the wizard to proceed, false otherwise.isComplete()public void setSummaryModel(IModel<String> summary)
summary - summarypublic void setTitleModel(IModel<String> title)
title - titleprotected void detachModel()
Component
detachModel in class ComponentComponent.detachModel()protected void onInitialize()
ComponentPage thus providing the component with an atomic callback
when the component's environment is built out.
Overrides must call super#Component.onInitialize(). Usually this should be the first thing an
override does, much like a constructor.
Parent containers are guaranteed to be initialized before their children
It is safe to use Component.getPage() in this method
NOTE:The timing of this call is not precise, the contract is that it is called sometime
before Component.onBeforeRender().
onInitialize in class Componentprotected void onInit(IWizardModel wizardModel)
wizardModel - init(IWizardModel)public IWizardModel getWizardModel()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||