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

java.lang.Object
  org.apache.wicket.Component
      org.apache.wicket.MarkupContainer
          org.apache.wicket.markup.html.WebMarkupContainer
              org.apache.wicket.markup.html.form.LabeledWebMarkupContainer
                  org.apache.wicket.markup.html.form.FormComponent<String>
                      org.apache.wicket.markup.html.form.Button
                          org.apache.wicket.ajax.markup.html.form.AjaxButton

All Implemented Interfaces:

Serializable, IClusterable, IConverterLocator, IFormModelUpdateListener, IFormSubmittingComponent, IFormVisitorParticipant, ILabelProvider<String>

Direct Known Subclasses:

AjaxSubmitButton, IndicatingAjaxButton

public abstract class AjaxButton
extends Button

A button that submits the form via ajax.

Since:

1.3

Author:

Igor Vaynberg (ivaynberg)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.markup.html.form.FormComponent

FormComponent.AbstractVisitor, FormComponent.IVisitor

Nested classes/interfaces inherited from class org.apache.wicket.Component

Component.ComponentModelChange, Component.EnabledChange, Component.VisibilityChange

Field Summary

Fields inherited from class org.apache.wicket.markup.html.form.FormComponent

FLAG_CONVERT_EMPTY_INPUT_STRING_TO_NULL, VALUE_SEPARATOR

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_CONFIGURED, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

Constructor Summary

AjaxButton(String id)
Construct.

AjaxButton(String id, Form<?> form)
Construct.

AjaxButton(String id, IModel<String> model)
Construct.

AjaxButton(String id, IModel<String> model, Form<?> form)
Construct.

Method Summary

protected IAjaxCallDecorator	getAjaxCallDecorator() Returns the IAjaxCallDecorator that will be used to modify the generated javascript.
Form<?>	getForm() Returns the form if it was set in constructor, otherwise returns the form nearest in parent hierarchy.
protected void	onError(AjaxRequestTarget target, Form<?> form) Listener method invoked on form submit with errors
protected abstract void	onSubmit(AjaxRequestTarget target, Form<?> form) Listener method invoked on form submit with no errors

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

getDefaultFormProcessing, getOnClickScript, initModel, onComponentTag, onSubmit, setDefaultFormProcessing, updateModel

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

add, add, checkRequired, clearInput, convertInput, convertValue, error, getConvertedInput, getDefaultLabel, getDefaultLabel, getInput, getInputAsArray, getInputName, getModel, getModelObject, getModelValue, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isInputNullable, isMultiPart, isPersistent, isRequired, isValid, newValidatable, onDetach, onDisabled, onInvalid, onValid, processChildren, processInput, setConvertedInput, setLabel, setModel, setModelObject, setModelValue, setModelValue, setPersistent, setRequired, setType, shouldTrimInput, supportsPersistence, trim, valid, validate, validateRequired, validateValidators, visitComponentsPostOrder, visitFormComponentsPostOrder

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

getLabel, setLabelInternal

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

getMarkupType, getWebPage, getWebRequest

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onAfterRenderChildren, onComponentTagBody, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, renderNext, replace, setDefaultModel, setMarkupStream, size, swap, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdImpl, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, internalAttach, internalDetach, internalOnAttach, internalOnDetach, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onConfigure, onEndRequest, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, urlFor, 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

Methods inherited from interface org.apache.wicket.markup.html.form.IFormSubmittingComponent

getInputName

Constructor Detail

AjaxButton

public AjaxButton(String id)

Construct.

Parameters:

id -

AjaxButton

public AjaxButton(String id,
                  IModel<String> model)

Construct.

Parameters:

id -

model - model used to set value markup attribute

AjaxButton

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

Construct.

Parameters:

id -

form -

AjaxButton

public AjaxButton(String id,
                  IModel<String> model,
                  Form<?> form)

Construct.

Parameters:

id -

model - model used to set value markup attribute

form -

Method Detail

getForm

public Form<?> getForm()

Returns the form if it was set in constructor, otherwise returns the form nearest in parent hierarchy.

Specified by:

getForm in interface IFormSubmittingComponent

Overrides:

getForm in class FormComponent<String>

Returns:

The parent form for this form component

See Also:

FormComponent.getForm()

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

onSubmit

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

Listener method invoked on form submit with no errors

Parameters:

target -

form -

onError

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

Listener method invoked on form submit with errors

Parameters:

target -

form - TODO 1.3: Make abstract to be consistent with onSubmit()