org.apache.wicket.ajax.markup.html.form

Class AjaxSubmitLink

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.link.AbstractLink

org.apache.wicket.markup.html.form.AbstractSubmitLink

org.apache.wicket.ajax.markup.html.form.AjaxSubmitLink

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IConverterLocator, IFormSubmitter, IFormSubmittingComponent, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

public abstract class AjaxSubmitLink
extends AbstractSubmitLink

A link that submits a form via ajax. Since this link takes the form as a constructor argument it does not need to be inside form's component hierarchy.

Since:

1.2

Author:

Igor Vaynberg (ivaynberg)

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_AFTER_RENDERING, FLAG_INITIALIZED, FLAG_PREPARED_FOR_RENDER, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RENDERING, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING

Constructor Summary

Constructors

Constructor and Description
AjaxSubmitLink(String id) Construct.
AjaxSubmitLink(String id, Form<?> form) Construct.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	getStatelessHint() Returns whether the component can be stateless.
protected AjaxFormSubmitBehavior	newAjaxFormSubmitBehavior(String event)
void	onAfterSubmit() Use onAfterSubmit(AjaxRequestTarget, Form) instead.
protected void	onAfterSubmit(AjaxRequestTarget target, Form<?> form) Override this method to provide special submit handling in a multi-button form.
protected void	onComponentTag(ComponentTag tag) Processes the component tag.
void	onError() Final implementation of the Button's onError.
protected void	onError(AjaxRequestTarget target, Form<?> form) Listener method invoked on form submit with errors.
protected void	onInitialize() This method is meant to be used as an alternative to initialize components.
void	onSubmit() Use onSubmit(AjaxRequestTarget, Form) instead.
protected void	onSubmit(AjaxRequestTarget target, Form<?> form) Override this method to provide special submit handling in a multi-button form.
protected void	updateAjaxAttributes(AjaxRequestAttributes attributes)

Methods inherited from class org.apache.wicket.markup.html.form.AbstractSubmitLink

getDefaultFormProcessing, getForm, getInputName, setDefaultFormProcessing

Methods inherited from class org.apache.wicket.markup.html.link.AbstractLink

disableLink, getBody, onComponentTagBody, onDetach, setBody

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, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onAfterRenderChildren, onRender, queue, 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, canCallListenerInterfaceAfterExpiry, 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, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, internalPrepareForRender, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onBeforeRender, onConfigure, onEvent, 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

Constructor Detail

AjaxSubmitLink

public AjaxSubmitLink(String id)

Construct.

Parameters:

id -

AjaxSubmitLink

public AjaxSubmitLink(String id,
              Form<?> form)

Construct.

Parameters:

id -

form -

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

newAjaxFormSubmitBehavior

protected AjaxFormSubmitBehavior newAjaxFormSubmitBehavior(String event)

onSubmit

protected void onSubmit(AjaxRequestTarget target,
            Form<?> form)

Override this method to provide special submit handling in a multi-button form. This method will be called before the form's onSubmit method.

onAfterSubmit

protected void onAfterSubmit(AjaxRequestTarget target,
                 Form<?> form)

Override this method to provide special submit handling in a multi-button form. This method will be called after the form's onSubmit method.

updateAjaxAttributes

protected void updateAjaxAttributes(AjaxRequestAttributes attributes)

onComponentTag

protected void onComponentTag(ComponentTag tag)

Description copied from class: Component

Processes the component tag. Overrides of this method most likely should call the super implementation.

Overrides:

onComponentTag in class Component

Parameters:

tag - Tag to modify

onError

public final void onError()

Final implementation of the Button's onError. AjaxSubmitLinks have their own onError which is called.

See Also:

Button.onError()

onError

protected void onError(AjaxRequestTarget target,
           Form<?> form)

Listener method invoked on form submit with errors. This method is called before Form.onError().

Parameters:

target -

form -

onSubmit

public final void onSubmit()

Use onSubmit(AjaxRequestTarget, Form) instead.

onAfterSubmit

public final void onAfterSubmit()

Use onAfterSubmit(AjaxRequestTarget, Form) instead.

getStatelessHint

protected boolean getStatelessHint()

Description copied from class: Component

Returns whether the component can be stateless. Also the component behaviors must be stateless, otherwise the component will be treat as stateful. In order for page to be stateless (and not to be stored in session), all components (and component behaviors) must be stateless.

Overrides:

getStatelessHint in class Component

Returns:

whether the component can be stateless