Package org.apache.syncope.client.ui.commons.wizards

Class AjaxWizard<T extends Serializable>

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.apache.syncope.client.ui.commons.wizards.AjaxWizard<T>

All Implemented Interfaces:

Serializable, Iterable<Component>, ModalPanel, SubmitableModalPanel, WizardModalPanel<T>, IEventSink, IEventSource, IWizard, IWizardModelListener, IFeedbackContributor, IConverterLocator, IMetadataContext<Serializable,Component>, IQueueRegion, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

public abstract class AjaxWizard<T extends Serializable>
extends Wizard
implements SubmitableModalPanel, WizardModalPanel<T>

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AjaxWizard.EditItemActionEvent<T extends Serializable>
static enum	AjaxWizard.Mode
static class	AjaxWizard.NewItemActionEvent<T extends Serializable>
static class	AjaxWizard.NewItemCancelEvent<T extends Serializable>
static class	AjaxWizard.NewItemEvent<T extends Serializable>
static class	AjaxWizard.NewItemFinishEvent<T extends Serializable>

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Logger	LOG

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_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
AjaxWizard(String id, T item, WizardModel model, AjaxWizard.Mode mode, PageReference pageRef)	Construct.

Method Summary

Modifier and Type	Method	Description
final AjaxWizard<T>	addOuterObject(List<Component> childs)	Add object outside the main container.
protected abstract Future<Pair<Serializable,Serializable>>	execute(Callable<Pair<Serializable,Serializable>> future)
T	getItem()
protected abstract long	getMaxWaitTimeInSeconds()
protected void	init(IWizardModel wizardModel)
protected Component	newButtonBar(String id)
protected abstract Pair<Serializable,Serializable>	onApplyInternal(AjaxRequestTarget target)	Apply operation
final void	onCancel()
protected abstract void	onCancelInternal()
void	onError(AjaxRequestTarget target)
final void	onFinish()
void	onSubmit(AjaxRequestTarget target)
protected abstract void	sendError(Exception exception)
protected abstract void	sendWarning(String message)
AjaxWizard<T>	setEventSink(IEventSink eventSink)
AjaxWizard<T>	setItem(T item)	Replaces the default value provided with the constructor.

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

getActiveStep, getForm, getWizardModel, isVersioned, newFeedbackPanel, newForm, newOverviewBar, onActiveStepChanged

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, onInitialize, 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, 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, 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.IQueueRegion

dequeue, newDequeueContext

Methods inherited from interface org.apache.wicket.request.component.IRequestableComponent

canCallListenerAfterExpiry, detach, get, getBehaviorById, getBehaviorId, getId, getPage, getPageRelativePath

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

LOG

protected static final Logger LOG

Constructor Details

AjaxWizard

public AjaxWizard(String id,
 T item,
 WizardModel model,
 AjaxWizard.Mode mode,
 PageReference pageRef)

Construct.

Parameters:

id - The component id

item - model object

model - wizard model

mode - mode

pageRef - caller page reference.

Method Details

addOuterObject

public final AjaxWizard<T> addOuterObject(List<Component> childs)

Add object outside the main container. Use this method just to be not influenced by specific inner object css'. Be sure to provide outer as id.

Parameters:

childs - components to be added.

Returns:

the current panel instance.

setEventSink

public AjaxWizard<T> setEventSink(IEventSink eventSink)

init

protected void init(IWizardModel wizardModel)

Overrides:

init in class Wizard

newButtonBar

protected Component newButtonBar(String id)

Overrides:

newButtonBar in class Wizard

onCancelInternal

protected abstract void onCancelInternal()

sendError

protected abstract void sendError(Exception exception)

sendWarning

protected abstract void sendWarning(String message)

execute

protected abstract Future<Pair<Serializable,Serializable>> execute(Callable<Pair<Serializable,Serializable>> future)

onApplyInternal

protected abstract Pair<Serializable,Serializable> onApplyInternal(AjaxRequestTarget target)

Apply operation

Parameters:

target - request target

Returns:

a pair of payload (maybe null) and resulting object.

getMaxWaitTimeInSeconds

protected abstract long getMaxWaitTimeInSeconds()

onCancel

public final void onCancel()

Specified by:

onCancel in interface IWizardModelListener

Overrides:

onCancel in class Wizard

onFinish

public final void onFinish()

Specified by:

onFinish in interface IWizardModelListener

Overrides:

onFinish in class Wizard

getItem

public T getItem()

Specified by:

getItem in interface WizardModalPanel<T extends Serializable>

setItem

public AjaxWizard<T> setItem(T item)

Replaces the default value provided with the constructor.

Parameters:

item - new value.

Returns:

the current wizard instance.

onSubmit

public void onSubmit(AjaxRequestTarget target)

Specified by:

onSubmit in interface SubmitableModalPanel

onError

public void onError(AjaxRequestTarget target)

Specified by:

onError in interface SubmitableModalPanel