Package com.inductiveautomation.ignition.gateway.web.components.wizard

Class GatewayWizardStep

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.WizardStep
org.apache.wicket.extensions.wizard.dynamic.DynamicWizardStep
com.inductiveautomation.ignition.gateway.web.components.wizard.GatewayWizardStep
All Implemented Interfaces:
Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.extensions.wizard.dynamic.IDynamicWizardStep, org.apache.wicket.extensions.wizard.IWizardStep, 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
public abstract class GatewayWizardStep extends org.apache.wicket.extensions.wizard.dynamic.DynamicWizardStep
Created by mattg on 3/23/15. Implement one or more of these steps for use in a GatewayWizard. Note that you will also need to create a matching html file for the step class.
See Also:

  • 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

    Constructors
    Constructor
    Description
    GatewayWizardStep(org.apache.wicket.extensions.wizard.dynamic.DynamicWizardStep previousStep, String title, org.apache.wicket.model.IModel dataModel)
    If this step is always the first step in the wizard, pass NULL for the previous step.

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract boolean
    isLastStep()
    Override as needed to return true or false, depending on the state of the data model.
    abstract org.apache.wicket.extensions.wizard.dynamic.IDynamicWizardStep
    next()
    Override as needed to determine the next step in the wizard, depending on the state of the data model.

    Methods inherited from class org.apache.wicket.extensions.wizard.dynamic.DynamicWizardStep

    isLastAvailable, isNextAvailable, isPreviousAvailable, last, previous

    Methods inherited from class org.apache.wicket.extensions.wizard.WizardStep

    add, applyState, detachModel, getHeader, getSummary, getTitle, getView, getWizardModel, init, isComplete, onInit, onInitialize, setComplete, setSummaryModel, setTitleModel

    Methods inherited from class org.apache.wicket.markup.html.panel.Panel

    newMarkupSourcingStrategy

    Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

    getWebApplication, 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, clearOriginalDestination, configure, continueToOriginalDestination, debug, detach, 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, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onDetach, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, 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

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface java.lang.Iterable

    forEach, spliterator

    Methods inherited from interface org.apache.wicket.extensions.wizard.IWizardStep

    applyState, getHeader, getView, init, isComplete

  • Constructor Details

    • GatewayWizardStep

      public GatewayWizardStep(org.apache.wicket.extensions.wizard.dynamic.DynamicWizardStep previousStep, String title, org.apache.wicket.model.IModel dataModel)
      If this step is always the first step in the wizard, pass NULL for the previous step.

  • Method Details

    • isLastStep

      public abstract boolean isLastStep()
      Override as needed to return true or false, depending on the state of the data model. For example, if the user makes a certain choice on the page of the previous step, you may want to declare this step as the last step. The step's data model is shared with the wizard and is updated as the user moves thru the wizard. You will need to examine this data model to evaluate the current state of the wizard and decide whether to return true or false.

    • next

      public abstract org.apache.wicket.extensions.wizard.dynamic.IDynamicWizardStep next()
      Override as needed to determine the next step in the wizard, depending on the state of the data model. For example, if the user makes a certain choice on the page of the previous step, the next step may be one of two different GatewayWizardStep objects. The step's data model is shared with the wizard and is updated as the user moves thru the wizard. You will need to examine this data model to evaluate the current state of the wizard and decide which step is the next one.