Module org.apache.wicket.extensions

Package org.apache.wicket.extensions.wizard.dynamic

Class DynamicWizardStep

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

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IDynamicWizardStep, IWizardStep, IFeedbackContributor, IConverterLocator, IMetadataContext<Serializable,Component>, IQueueRegion, IHeaderContributor, IRequestableComponent, org.apache.wicket.util.IHierarchical<Component>, org.apache.wicket.util.io.IClusterable

public abstract class DynamicWizardStep
extends WizardStep
implements IDynamicWizardStep

Default implementation of a dynamic wizard step.

Author:

eelcohillenius

See Also:

• Serialized Form

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_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING, RFLAG_CONTAINER_HAS_REMOVALS

Constructor Summary

Constructors

Constructor	Description
DynamicWizardStep(IDynamicWizardStep previousStep)	Construct without a title and a summary.
DynamicWizardStep(IDynamicWizardStep previousStep, String title, String summary)	Creates a new step with the specified title and summary.
DynamicWizardStep(IDynamicWizardStep previousStep, String title, String summary, IModel<?> model)	Creates a new step with the specified title and summary.
DynamicWizardStep(IDynamicWizardStep previousStep, IModel<String> title, IModel<String> summary)	Creates a new step with the specified title and summary.
DynamicWizardStep(IDynamicWizardStep previousStep, IModel<String> title, IModel<String> summary, IModel<?> model)	Creates a new step with the specified title and summary.

Method Summary

Modifier and Type	Method	Description
boolean	isLastAvailable()	Checks if the last button should be enabled.
boolean	isNextAvailable()	Gets whether the next button should be enabled.
boolean	isPreviousAvailable()	Gets whether the previous button should be enabled.
IDynamicWizardStep	last()	Gets the next wizard step from here.
IDynamicWizardStep	previous()	Gets the previous wizard step from here.

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

getRegionMarkup, 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, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findChildComponent, findComponentToDequeue, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, onDetach, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, stream, streamChildren, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, beforeRender, canCallListener, canCallListenerAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, 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, getMarkupTag, 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, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderPart, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlForListener, urlForListener, 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 org.apache.wicket.extensions.wizard.dynamic.IDynamicWizardStep

isFinishAvailable, isLastStep, next

Methods inherited from interface org.apache.wicket.IQueueRegion

dequeue, newDequeueContext

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

DynamicWizardStep

public DynamicWizardStep(IDynamicWizardStep previousStep)

Construct without a title and a summary. Useful for when you provide a custom header by overriding WizardStep.getHeader(String, Component, IWizard).

Parameters:

previousStep - The previous step. May be null if this is the first step in the wizard

DynamicWizardStep

public DynamicWizardStep(IDynamicWizardStep previousStep,
 IModel<String> title,
 IModel<String> summary)

Creates a new step with the specified title and summary. The title and summary are displayed in the wizard title block while this step is active.

Parameters:

previousStep - The previous step. May be null if this is the first step in the wizard

title - the title of this step.

summary - a brief summary of this step or some usage guidelines.

DynamicWizardStep

public DynamicWizardStep(IDynamicWizardStep previousStep,
 IModel<String> title,
 IModel<String> summary,
 IModel<?> model)

Creates a new step with the specified title and summary. The title and summary are displayed in the wizard title block while this step is active.

Parameters:

previousStep - The previous step. May be null if this is the first step in the wizard

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

DynamicWizardStep

public DynamicWizardStep(IDynamicWizardStep previousStep,
 String title,
 String summary)

Creates a new step with the specified title and summary. The title and summary are displayed in the wizard title block while this step is active.

Parameters:

previousStep - The previous step. May be null if this is the first step in the wizard

title - the title of this step.

summary - a brief summary of this step or some usage guidelines.

DynamicWizardStep

public DynamicWizardStep(IDynamicWizardStep previousStep,
 String title,
 String summary,
 IModel<?> model)

Creates a new step with the specified title and summary. The title and summary are displayed in the wizard title block while this step is active.

Parameters:

previousStep - The previous step. May be null if this is the first step in the wizard

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 Details

isLastAvailable

public boolean isLastAvailable()

Description copied from interface: IDynamicWizardStep

Checks if the last button should be enabled.

Specified by:

isLastAvailable in interface IDynamicWizardStep

Returns:

true if the last button should be enabled, false otherwise.

See Also:

• IDynamicWizardStep.isLastAvailable()

isNextAvailable

public boolean isNextAvailable()

Description copied from interface: IDynamicWizardStep

Gets whether the next button should be enabled.

Specified by:

isNextAvailable in interface IDynamicWizardStep

Returns:

True if the next button should be enabled, false otherwise.

See Also:

• IDynamicWizardStep.isNextAvailable()

isPreviousAvailable

public boolean isPreviousAvailable()

Description copied from interface: IDynamicWizardStep

Gets whether the previous button should be enabled.

Specified by:

isPreviousAvailable in interface IDynamicWizardStep

Returns:

True if the previous button should be enabled, false otherwise.

See Also:

• IDynamicWizardStep.isPreviousAvailable()

last

public IDynamicWizardStep last()

Description copied from interface: IDynamicWizardStep

Gets the next wizard step from here. Can only be called when DynamicWizardModel.isLastAvailable() returns true.

Specified by:

last in interface IDynamicWizardStep

Returns:

The next wizard step. May not be null.

See Also:

• IDynamicWizardStep.last()

previous

public IDynamicWizardStep previous()

Description copied from interface: IDynamicWizardStep

Gets the previous wizard step from here. Can only be called when IDynamicWizardStep.isPreviousAvailable() returns true.

Specified by:

previous in interface IDynamicWizardStep

Returns:

The next wizard step. May not be null unless this is the first step (in which case it should never be called).

See Also:

• IDynamicWizardStep.previous()