|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object wicket.Component wicket.MarkupContainer wicket.markup.html.WebMarkupContainer wicket.markup.html.WebMarkupContainerWithAssociatedMarkup wicket.markup.html.panel.Panel 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(EmailAddressPatternValidator.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 Adress</wicket:message></td> <td><input type="text" wicket:id="user.email" /></td> </tr> </table> </wicket:panel>
Nested Class Summary |
---|
Nested classes/interfaces inherited from class wicket.markup.html.WebMarkupContainerWithAssociatedMarkup |
---|
wicket.markup.html.WebMarkupContainerWithAssociatedMarkup.HeaderPartContainer |
Nested classes/interfaces inherited from class wicket.Component |
---|
wicket.Component.ComponentModelChange, wicket.Component.EnabledChange, wicket.Component.IVisitor, wicket.Component.VisibilityChange |
Field Summary |
---|
Fields inherited from class wicket.Component |
---|
ENABLE, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PATH_SEPARATOR, RENDER |
Constructor Summary | |
---|---|
WizardStep()
Construct without a title and a summary. |
|
WizardStep(wicket.model.IModel title,
wicket.model.IModel summary)
Creates a new step with the specified title and summary. |
|
WizardStep(wicket.model.IModel title,
wicket.model.IModel summary,
wicket.model.IModel model)
Creates a new step with the specified title and summary. |
|
WizardStep(java.lang.String title,
java.lang.String summary)
Creates a new step with the specified title and summary. |
|
WizardStep(java.lang.String title,
java.lang.String summary,
wicket.model.IModel model)
Creates a new step with the specified title and summary. |
Method Summary | |
---|---|
void |
add(wicket.markup.html.form.validation.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()
|
wicket.Component |
getHeader(java.lang.String id,
wicket.Component parent,
IWizard wizard)
Gets the header component for this step. |
java.lang.String |
getSummary()
Gets the summary of this step. |
java.lang.String |
getTitle()
Gets the title of this step. |
wicket.Component |
getView(java.lang.String id,
wicket.Component parent,
IWizard wizard)
Returns the current view this step is displaying. |
void |
init(IWizardModel wizardModel)
Called to initialize the step. |
boolean |
isComplete()
Checks if this step is compete. |
protected void |
onAttach()
Workaround for adding the form validators; not needed in 2.0. |
protected void |
onInit(IWizardModel wizardModel)
Called when the step is being initialized. |
void |
setComplete(boolean complete)
Marks this step as compete. |
void |
setSummaryModel(wicket.model.IModel summary)
Sets summary. |
void |
setTitleModel(wicket.model.IModel title)
Sets title. |
Methods inherited from class wicket.markup.html.panel.Panel |
---|
onComponentTag, onComponentTagBody, renderHead |
Methods inherited from class wicket.markup.html.WebMarkupContainerWithAssociatedMarkup |
---|
newHeaderPartContainer, renderHeadFromAssociatedMarkupFile |
Methods inherited from class wicket.markup.html.WebMarkupContainer |
---|
getMarkupType, getWebPage |
Methods inherited from class wicket.MarkupContainer |
---|
add, autoAdd, contains, findMarkupStream, get, getAssociatedMarkupStream, getMarkupStream, internalAdd, internalAttach, internalDetach, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, replace, setMarkupStream, setModel, size, toString, toString, visitChildren, visitChildren |
Methods inherited from class wicket.Component |
---|
add, addStateChange, checkComponentTag, checkComponentTagAttribute, continueToOriginalDestination, debug, detachBehaviors, detachModels, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getApplicationPages, getApplicationSettings, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMetaData, getModel, getModelComparator, getModelObject, getModelObjectAsString, getOutputMarkupId, getPage, getPageFactory, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getString, getString, getString, getStyle, getVariation, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnAttach, internalOnDetach, internalOnModelChanged, isActionAuthorized, isAncestorOf, isBehaviorAccepted, isEnableAllowed, isEnabled, isHeadRendered, isIgnoreAttributeModifier, isRenderAllowed, isVersioned, isVisible, isVisibleInHierarchy, modelChanged, modelChanging, newPage, newPage, onAfterRender, onBeforeRender, onBeginRequest, onDetach, onEndRequest, onModelChanged, onModelChanging, onRender, redirectToInterceptPage, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderedBehaviors, replaceComponentTagBody, replaceWith, resetHeadRendered, sameRootModel, sameRootModel, setAuto, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMetaData, setModelObject, setOutputMarkupId, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public WizardStep()
#getHeader(String, Component, Wizard)
.
public WizardStep(wicket.model.IModel title, wicket.model.IModel summary)
title
- the title of this step.summary
- a brief summary of this step or some usage guidelines.public WizardStep(wicket.model.IModel title, wicket.model.IModel summary, wicket.model.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 steppublic WizardStep(java.lang.String title, java.lang.String summary)
title
- the title of this step.summary
- a brief summary of this step or some usage guidelines.public WizardStep(java.lang.String title, java.lang.String summary, wicket.model.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 stepMethod Detail |
---|
protected void detachModel()
detachModel
in class wicket.Component
Component.detachModel()
public final void add(wicket.markup.html.form.validation.IFormValidator validator)
validator
- public void applyState()
IWizardStep
This method will only be called if IWizardModel.isNextAvailable()
and IWizardStep.isComplete()
return true.
applyState
in interface IWizardStep
IWizardStep.applyState()
public wicket.Component getHeader(java.lang.String id, wicket.Component parent, IWizard wizard)
IWizardStep
getHeader
in interface IWizardStep
id
- 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
wicket.extensions.wizard.IWizardStep#getHeader(java.lang.String,
wicket.Component, wicket.extensions.wizard.Wizard)
public java.lang.String getSummary()
public java.lang.String getTitle()
public wicket.Component getView(java.lang.String id, wicket.Component parent, IWizard wizard)
IWizardStep
getView
in interface IWizardStep
id
- 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
wicket.extensions.wizard.IWizardStep#getView(java.lang.String,
wicket.Component, wicket.extensions.wizard.Wizard)
public final void init(IWizardModel wizardModel)
onInit(IWizardModel)
init
in interface IWizardStep
wizardModel
- the model to which the step belongs.public boolean isComplete()
setComplete(boolean)
.
isComplete
in interface IWizardStep
setComplete(boolean)
public void setComplete(boolean complete)
complete
- true to allow the wizard to proceed, false
otherwise.isComplete()
public void setSummaryModel(wicket.model.IModel summary)
summary
- summarypublic void setTitleModel(wicket.model.IModel title)
title
- titleprotected void onAttach()
onAttach
in class wicket.Component
Component.onAttach()
protected void onInit(IWizardModel wizardModel)
wizardModel
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |