Class GatewayWizard
- java.lang.Object
-
- org.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.Wizard
-
- com.inductiveautomation.ignition.gateway.web.components.wizard.GatewayWizard
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Iterable<org.apache.wicket.Component>
,org.apache.wicket.event.IEventSink
,org.apache.wicket.event.IEventSource
,org.apache.wicket.extensions.wizard.IWizard
,org.apache.wicket.extensions.wizard.IWizardModelListener
,org.apache.wicket.IConverterLocator
,org.apache.wicket.markup.html.IHeaderContributor
,org.apache.wicket.request.component.IRequestableComponent
,org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>
,org.apache.wicket.util.io.IClusterable
- Direct Known Subclasses:
RecordEditWizard.CPGatewayWizard
public abstract class GatewayWizard extends org.apache.wicket.extensions.wizard.Wizard
Created by mattg on 3/23/15. To use an implementation of this class, you will need:
- an IModel with an object that can hold all settings that the user can select in the wizard. Wicket will automatically update this model as a user moves thru the wizard.
- one more more implementations of GatewayWizardStep objects. Each of these represents a panel in the wizard. You must also create an html file for each step class.
- an implementation of a GatewayWizardModel. The first GatewayWizardStep object must be added to the model, and then you must call init() within the wizard and pass this model.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description GatewayWizard(java.lang.String id, IConfigPage configPage, org.apache.wicket.model.IModel dataModel)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
initWizardModel(org.apache.wicket.extensions.wizard.IWizardModel model)
protected org.apache.wicket.Component
newButtonBar(java.lang.String id)
protected org.apache.wicket.Component
newFeedbackPanel(java.lang.String id)
void
onFinish()
abstract void
onFinish(org.apache.wicket.model.IModel dataModel, IConfigPage configPage)
Called when the user clicks the "Finish" button.-
Methods inherited from class org.apache.wicket.extensions.wizard.Wizard
addDefaultCssStyle, getActiveStep, getForm, getWizardModel, init, isVersioned, newForm, newOverviewBar, onActiveStepChanged, onBeforeRender, onCancel, renderHead
-
Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer
getWebPage, getWebRequest, getWebResponse, getWebSession
-
Methods inherited from class org.apache.wicket.MarkupContainer
add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, toString, visitChildren, visitChildren, visitChildren, visitChildren
-
Methods inherited from class org.apache.wicket.Component
add, addStateChange, afterRender, beforeRender, canCallListenerInterface, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, internalPrepareForRender, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onComponentTag, onConfigure, onDetach, onEvent, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, visitParents, warn, wrap
-
-
-
-
Constructor Detail
-
GatewayWizard
public GatewayWizard(java.lang.String id, IConfigPage configPage, org.apache.wicket.model.IModel dataModel)
-
-
Method Detail
-
onFinish
public abstract void onFinish(org.apache.wicket.model.IModel dataModel, IConfigPage configPage)
Called when the user clicks the "Finish" button. At that point, you can grab all the data from the wizard's default model and save in the database as needed. Use the passed configPage to set a destination ConfigPanel after data validation and successful save.
-
onFinish
public void onFinish()
- Specified by:
onFinish
in interfaceorg.apache.wicket.extensions.wizard.IWizardModelListener
- Overrides:
onFinish
in classorg.apache.wicket.extensions.wizard.Wizard
-
initWizardModel
public void initWizardModel(org.apache.wicket.extensions.wizard.IWizardModel model)
-
newFeedbackPanel
protected org.apache.wicket.Component newFeedbackPanel(java.lang.String id)
- Overrides:
newFeedbackPanel
in classorg.apache.wicket.extensions.wizard.Wizard
-
newButtonBar
protected org.apache.wicket.Component newButtonBar(java.lang.String id)
- Overrides:
newButtonBar
in classorg.apache.wicket.extensions.wizard.Wizard
-
-