org.hippoecm.frontend.dialog

Class AbstractWizard<T>

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

org.hippoecm.frontend.plugins.standards.wizard.AjaxWizard

org.hippoecm.frontend.dialog.AbstractWizard<T>

All Implemented Interfaces:

Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.ajax.IAjaxIndicatorAware, 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, IDialogService.Dialog

Direct Known Subclasses:

Wizard

public class AbstractWizard<T>
extends AjaxWizard
implements IDialogService.Dialog, org.apache.wicket.ajax.IAjaxIndicatorAware

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.wicket.extensions.wizard.Wizard

BUTTONS_ID, FEEDBACK_ID, FORM_ID, HEADER_ID, OVERVIEW_ID, VIEW_ID

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 and Description
AbstractWizard()
AbstractWizard(org.apache.wicket.model.IModel<T> model)

Method Summary

Modifier and Type	Method and Description
protected boolean	addAjaxIndicator()
String	getAjaxIndicatorMarkupId() Implement IAjaxIndicatorAware, to let ajax components in the dialog trigger the ajax indicator when they trigger an ajax request.
org.apache.wicket.Component	getComponent()
org.apache.wicket.model.IModel<T>	getModel() Gets model
T	getModelObject() Gets model object
org.apache.wicket.util.value.IValueMap	getProperties() Properties that determine how the dialog is rendered.
org.apache.wicket.model.IModel<String>	getTitle() The title of the dialog.
protected boolean	hasError()
protected void	init(org.apache.wicket.extensions.wizard.IWizardModel wizardModel)
void	onActiveStepChanged(org.apache.wicket.extensions.wizard.IWizardStep newStep)
void	onCancel()
void	onClose() Invoked when the dialog is closed.
void	onFinish()
void	render(PluginRequestTarget target) Part of the pre-rendering registration.
void	setDialogService(IDialogService service) When the dialog is shown (IDialogService.show(Dialog)), the dialog service is injected into the dialog.
AjaxUpdatingWidget<?>	setFocus(AjaxUpdatingWidget<?> widget)
org.apache.wicket.Component	setFocus(org.apache.wicket.Component c)
void	setModel(org.apache.wicket.model.IModel<T> model) Sets model
void	setModelObject(T object) Sets model object

Methods inherited from class org.hippoecm.frontend.plugins.standards.wizard.AjaxWizard

newButtonBar

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

addDefaultCssStyle, getActiveStep, getForm, getWizardModel, isVersioned, newFeedbackPanel, newForm, newOverviewBar, onBeforeRender, renderHead

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

newMarkupSourcingStrategy

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, clearOriginalDestination, 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, onReAdd, 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

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

Constructor Detail

AbstractWizard

public AbstractWizard()

AbstractWizard

public AbstractWizard(org.apache.wicket.model.IModel<T> model)

Method Detail

init

protected void init(org.apache.wicket.extensions.wizard.IWizardModel wizardModel)

Overrides:

init in class org.apache.wicket.extensions.wizard.Wizard

getModel

public final org.apache.wicket.model.IModel<T> getModel()

Gets model

Returns:

model

setModel

public final void setModel(org.apache.wicket.model.IModel<T> model)

Sets model

Parameters:

model -

getModelObject

public final T getModelObject()

Gets model object

Returns:

model object

setModelObject

public final void setModelObject(T object)

Sets model object

Parameters:

object -

onActiveStepChanged

public void onActiveStepChanged(org.apache.wicket.extensions.wizard.IWizardStep newStep)

Specified by:

onActiveStepChanged in interface org.apache.wicket.extensions.wizard.IWizardModelListener

Overrides:

onActiveStepChanged in class org.apache.wicket.extensions.wizard.Wizard

onCancel

public void onCancel()

Specified by:

onCancel in interface org.apache.wicket.extensions.wizard.IWizardModelListener

Overrides:

onCancel in class org.apache.wicket.extensions.wizard.Wizard

onFinish

public void onFinish()

Specified by:

onFinish in interface org.apache.wicket.extensions.wizard.IWizardModelListener

Overrides:

onFinish in class org.apache.wicket.extensions.wizard.Wizard

hasError

protected final boolean hasError()

getProperties

public org.apache.wicket.util.value.IValueMap getProperties()

Properties that determine how the dialog is rendered. In particular, the width and height properties are used for the size (in pixels).

Specified by:

getProperties in interface IDialogService.Dialog

getComponent

public org.apache.wicket.Component getComponent()

Specified by:

getComponent in interface IDialogService.Dialog

Returns:

a component with wicket id "content"

getTitle

public org.apache.wicket.model.IModel<String> getTitle()

Description copied from interface: IDialogService.Dialog

The title of the dialog. Will be displayed in the dialog border.

Specified by:

getTitle in interface IDialogService.Dialog

onClose

public void onClose()

Description copied from interface: IDialogService.Dialog

Invoked when the dialog is closed. Since the dialog will be decorated with a close link (X), this method may be called even when the dialog is not explicitly closed via IDialogService.close().

Specified by:

onClose in interface IDialogService.Dialog

render

public void render(PluginRequestTarget target)

Description copied from interface: IDialogService.Dialog

Part of the pre-rendering registration. When the dialog has components that should be rendered, they can be registered with the target.

Implementations must invoke IRenderService.render(PluginRequestTarget) on render services that contribute to the wicket component hierarchy.

Specified by:

render in interface IDialogService.Dialog

getAjaxIndicatorMarkupId

public String getAjaxIndicatorMarkupId()

Implement IAjaxIndicatorAware, to let ajax components in the dialog trigger the ajax indicator when they trigger an ajax request.

Specified by:

getAjaxIndicatorMarkupId in interface org.apache.wicket.ajax.IAjaxIndicatorAware

Returns:

the markup id of the ajax indicator

addAjaxIndicator

protected boolean addAjaxIndicator()

setDialogService

public void setDialogService(IDialogService service)

Description copied from interface: IDialogService.Dialog

When the dialog is shown (IDialogService.show(Dialog)), the dialog service is injected into the dialog.

Specified by:

setDialogService in interface IDialogService.Dialog

setFocus

public org.apache.wicket.Component setFocus(org.apache.wicket.Component c)

setFocus

public AjaxUpdatingWidget<?> setFocus(AjaxUpdatingWidget<?> widget)