org.apache.wicket.extensions.wizard

Class WizardButtonBar

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.WizardButtonBar

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IQueueRegion, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

Direct Known Subclasses:

AjaxWizardButtonBar

public class WizardButtonBar
extends Panel

The default bar of button components for wizards. This should be good for 90% of the cases. If not, override Wizard.newButtonBar(String) and provide your own.

The button bar holds the previous, [@link NextButton next}, last, [@link CancelButton cancel} and finish buttons. The last button is off by default. You can turn it on by having the wizard model return true for the is last visible method.

Author:

Eelco Hillenius

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 and Description
WizardButtonBar(String id, IWizard wizard) Construct.

Method Summary

Modifier and Type	Method and Description
WizardButton	getDefaultButton(IWizardModel model)
protected WizardButton	newCancelButton(String id, IWizard wizard) Creates a new button for IWizardModel.cancel().
protected WizardButton	newFinishButton(String id, IWizard wizard) Creates a new button for IWizardModel.finish().
protected WizardButton	newLastButton(String id, IWizard wizard) Creates a new button for IWizardModel.last().
protected WizardButton	newNextButton(String id, IWizard wizard) Creates a new button for IWizardModel.next().
protected WizardButton	newPreviousButton(String id, IWizard wizard) Creates a new button for IWizardModel.previous().
protected void	onBeforeRender() Called on all visible components before any component is rendered.
protected void	onInitialize() This method is meant to be used as an alternative to initialize components.

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, 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, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, 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.IQueueRegion

dequeue, newDequeueContext

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

WizardButtonBar

public WizardButtonBar(String id,
                       IWizard wizard)

Construct.

Parameters:

id - The component id

wizard - The containing wizard

Method Detail

onInitialize

protected void onInitialize()

Description copied from class: Component

This method is meant to be used as an alternative to initialize components. Usually the component's constructor is used for this task, but sometimes a component cannot be initialized in isolation, it may need to access its parent component or its markup in order to fully initialize. This method is invoked once per component's lifecycle when a path exists from this component to the Page 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().

Overrides:

onInitialize in class MarkupContainer

onBeforeRender

protected void onBeforeRender()

Description copied from class: Component

Called on all visible components before any component is rendered.

NOTE: If you override this, you *must* call super.onBeforeRender() within your implementation. Because this method is responsible for cascading Component.onBeforeRender() call to its children it is strongly recommended that super call is made at the end of the override.

Changes to the component tree can be made only before calling super.onBeforeRender().

Overrides:

onBeforeRender in class Component

See Also:

MarkupContainer.addOrReplace(Component...)

getDefaultButton

public WizardButton getDefaultButton(IWizardModel model)

See Also:

IDefaultButtonProvider.getDefaultButton(org.apache.wicket.extensions.wizard.IWizardModel)

newPreviousButton

protected WizardButton newPreviousButton(String id,
                                         IWizard wizard)

Creates a new button for IWizardModel.previous().

Parameters:

id - the button's id

wizard - the IWizard

Returns:

a new PreviousButton

newNextButton

protected WizardButton newNextButton(String id,
                                     IWizard wizard)

Creates a new button for IWizardModel.next().

Parameters:

id - the button's id

wizard - the IWizard

Returns:

a new NextButton

newLastButton

protected WizardButton newLastButton(String id,
                                     IWizard wizard)

Creates a new button for IWizardModel.last().

Parameters:

id - the button's id

wizard - the IWizard

Returns:

a new LastButton

newCancelButton

protected WizardButton newCancelButton(String id,
                                       IWizard wizard)

Creates a new button for IWizardModel.cancel().

Parameters:

id - the button's id

wizard - the IWizard

Returns:

a new CancelButton

newFinishButton

protected WizardButton newFinishButton(String id,
                                       IWizard wizard)

Creates a new button for IWizardModel.finish().

Parameters:

id - the button's id

wizard - the IWizard

Returns:

a new button