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, Iterable<Component>, IEventSink, IEventSource, IConverterLocator, IGenericComponent<String>, IFormModelUpdateListener, IFormSubmitter, IFormSubmittingComponent, IFormVisitorParticipant, ILabelProvider<String>, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

public abstract class AjaxButton
extends Button

A button that submits the form via Ajax.
Note that an HTML type attribute of "submit" is automatically changed to "button"- Use AjaxFallbackButton if you want to support non-Ajax form submits too.

Since:

1.3

Author:

Igor Vaynberg (ivaynberg)

See Also:

Serialized Form

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_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
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

Methods

Modifier and Type	Method and Description
Form<?>	getForm() Returns the form if it was set in constructor, otherwise returns the form nearest in parent hierarchy.
protected boolean	getStatelessHint() Returns whether the component can be stateless.
protected AjaxFormSubmitBehavior	newAjaxFormSubmitBehavior(String event)
void	onAfterSubmit() Override this method to provide special submit handling in a multi-button form.
protected void	onAfterSubmit(AjaxRequestTarget target, Form<?> form) Listener method invoked on form submit with no errors, after Form.onSubmit().
void	onError() This method is never called.
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() This method is never called.
protected void	onSubmit(AjaxRequestTarget target, Form<?> form) Listener method invoked on form submit with no errors, before Form.onSubmit().
protected void	updateAjaxAttributes(AjaxRequestAttributes attributes)

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

getDefaultFormProcessing, getOnClickScript, initModel, onComponentTag, onComponentTagBody, 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, isRequired, isValid, newValidatable, newValidationError, onDetach, onDisabled, onInvalid, onRequired, onValid, processChildren, processInput, remove, reportRequiredError, setConvertedInput, setLabel, setModel, setModelObject, setModelValue, setRequired, setType, shouldTrimInput, trim, updateAutoLabels, updateCollectionModel, valid, validate, validateRequired, validateValidators, visitComponentsPostOrder, visitFormComponentsPostOrder

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

getLabel

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

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

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)

updateAjaxAttributes

protected void updateAjaxAttributes(AjaxRequestAttributes attributes)

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 IFormSubmitter

Overrides:

getForm in class Button

Returns:

the parent form or null

See Also:

FormComponent.getForm()

onSubmit

public final void onSubmit()

This method is never called.

Specified by:

onSubmit in interface IFormSubmitter

Overrides:

onSubmit in class Button

See Also:

onSubmit(AjaxRequestTarget, Form)

onAfterSubmit

public final void onAfterSubmit()

Description copied from class: Button

Override this method to provide special submit handling in a multi-button form. It is called whenever the user clicks this particular button, except if validation fails. This method will be called after Form.onSubmit().

Specified by:

onAfterSubmit in interface IFormSubmitter

Overrides:

onAfterSubmit in class Button

onError

public final void onError()

This method is never called.

Specified by:

onError in interface IFormSubmitter

Overrides:

onError in class Button

See Also:

onError(AjaxRequestTarget, Form)

onSubmit

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

Listener method invoked on form submit with no errors, before Form.onSubmit().

Parameters:

target -

form -

onAfterSubmit

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

Listener method invoked on form submit with no errors, after Form.onSubmit().

Parameters:

target -

form -

onError

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

Listener method invoked on form submit with errors

Parameters:

target -

form -

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