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

java.lang.Object
  extended by org.apache.wicket.Component
      extended by org.apache.wicket.MarkupContainer
          extended by org.apache.wicket.markup.html.WebMarkupContainer
              extended by org.apache.wicket.markup.html.link.AbstractLink
                  extended by org.apache.wicket.markup.html.form.AbstractSubmitLink
                      extended by org.apache.wicket.ajax.markup.html.form.AjaxSubmitLink
All Implemented Interfaces:
java.io.Serializable, java.lang.Iterable<Component>, IEventSink, IEventSource, IClusterable, IConverterLocator, IFormSubmitter, IFormSubmittingComponent, IHeaderContributor, IRequestableComponent, IHierarchical<Component>

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_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER
 
Constructor Summary
AjaxSubmitLink(java.lang.String id)
          Construct.
AjaxSubmitLink(java.lang.String id, Form<?> form)
          Construct.
 
Method Summary
protected  IAjaxCallDecorator getAjaxCallDecorator()
          Returns the IAjaxCallDecorator that will be used to modify the generated javascript.
protected  void onComponentTag(ComponentTag tag)
          Processes the component tag.
 void onError()
          Final implementation of the Button's onError.
protected abstract  void onError(AjaxRequestTarget target, Form<?> form)
          Listener method invoked on form submit with errors
 void onSubmit()
          Final implementation of the Button's onSubmit.
protected abstract  void onSubmit(AjaxRequestTarget target, Form<?> form)
          Listener method invoked on form submit
 
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, getAfterDisabledLink, getBeforeDisabledLink, getBody, isLinkEnabled, onBeforeRender, onComponentTagBody, onDetach, setAfterDisabledLink, setBeforeDisabledLink, setBody
 
Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer
getWebPage, getWebRequest
 
Methods inherited from class org.apache.wicket.MarkupContainer
add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, hasAssociatedMarkup, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onMarkupAttached, 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, 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, getFeedbackMessage, 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, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onConfigure, onEvent, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, 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, warn, wrap
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AjaxSubmitLink

public AjaxSubmitLink(java.lang.String id)
Construct.

Parameters:
id -

AjaxSubmitLink

public AjaxSubmitLink(java.lang.String id,
                      Form<?> form)
Construct.

Parameters:
id -
form -
Method Detail

getAjaxCallDecorator

protected IAjaxCallDecorator getAjaxCallDecorator()
Returns the IAjaxCallDecorator that will be used to modify the generated javascript. This is the preferred way of changing the javascript in the onclick handler

Returns:
call decorator used to modify the generated javascript or null for none

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

onSubmit

public final void onSubmit()
Final implementation of the Button's onSubmit. AjaxSubmitLinks have there own onSubmit which is called.

See Also:
Button.onSubmit()

onError

public final void onError()
Final implementation of the Button's onError. AjaxSubmitLinks have their own onError which is called.

See Also:
Button.onError()

onSubmit

protected abstract void onSubmit(AjaxRequestTarget target,
                                 Form<?> form)
Listener method invoked on form submit

Parameters:
target -
form -

onError

protected abstract void onError(AjaxRequestTarget target,
                                Form<?> form)
Listener method invoked on form submit with errors

Parameters:
target -
form -


Copyright © 2006-2011 Apache Software Foundation. All Rights Reserved.