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<java.lang.String>
-
- org.apache.wicket.markup.html.form.Button
-
- org.apache.wicket.ajax.markup.html.form.AjaxButton
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Iterable<Component>,IEventSink,IEventSource,IFeedbackContributor,IConverterLocator,IGenericComponent<java.lang.String,FormComponent<java.lang.String>>,IMetadataContext<java.io.Serializable,Component>,IFormModelUpdateListener,IFormSubmitter,IFormSubmittingComponent,IFormVisitorParticipant,ILabelProvider<java.lang.String>,IHeaderContributor,IRequestableComponent,org.apache.wicket.util.IHierarchical<Component>,org.apache.wicket.util.io.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"- UseAjaxFallbackButtonif 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_INITIALIZED, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING
-
-
Constructor Summary
Constructors Constructor Description AjaxButton(java.lang.String id)Construct.AjaxButton(java.lang.String id, Form<?> form)Construct.AjaxButton(java.lang.String id, IModel<java.lang.String> model)Construct.AjaxButton(java.lang.String id, IModel<java.lang.String> model, Form<?> form)Construct.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Form<?>getForm()Returns the form if it was set in constructor, otherwise returns the form nearest in parent hierarchy.protected booleangetStatelessHint()Returns whether the component can be stateless.protected AjaxFormSubmitBehaviornewAjaxFormSubmitBehavior(java.lang.String event)voidonAfterSubmit()Override this method to provide special submit handling in a multi-button form.protected voidonAfterSubmit(AjaxRequestTarget target)Listener method invoked on form submit with no errors, afterForm.onSubmit().voidonError()This method is never called.protected voidonError(AjaxRequestTarget target)Listener method invoked on form submit with errorsprotected voidonInitialize()This method is meant to be used as an alternative to initialize components.voidonSubmit()This method is never called.protected voidonSubmit(AjaxRequestTarget target)Listener method invoked on form submit with no errors, beforeForm.onSubmit().protected voidupdateAjaxAttributes(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, getModelValue, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isInputNullable, isMultiPart, isRequired, isValid, newValidatable, newValidationError, onDetach, onDisabled, onInvalid, onValid, processChildren, processInput, remove, reportRequiredError, setConvertedInput, setLabel, 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, findChildComponent, findComponentToDequeue, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, 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, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onBeforeRender, 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.markup.html.form.IFormSubmittingComponent
getInputName
-
Methods inherited from interface org.apache.wicket.IGenericComponent
getDefaultModel, getDefaultModelObject, getModel, getModelObject, setDefaultModel, setDefaultModelObject, setModel, setModelObject
-
-
-
-
Constructor Detail
-
AjaxButton
public AjaxButton(java.lang.String id)
Construct.- Parameters:
id-
-
AjaxButton
public AjaxButton(java.lang.String id, IModel<java.lang.String> model)Construct.- Parameters:
id-model- model used to setvaluemarkup attribute
-
AjaxButton
public AjaxButton(java.lang.String id, Form<?> form)Construct.- Parameters:
id-form-
-
-
Method Detail
-
onInitialize
protected void onInitialize()
Description copied from class:ComponentThis 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 thePagethus 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 methodNOTE:The timing of this call is not precise, the contract is that it is called sometime before
Component.onBeforeRender().- Overrides:
onInitializein classMarkupContainer
-
newAjaxFormSubmitBehavior
protected AjaxFormSubmitBehavior newAjaxFormSubmitBehavior(java.lang.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:
getFormin interfaceIFormSubmitter- Overrides:
getFormin classButton- Returns:
- the parent form or
null - See Also:
FormComponent.getForm()
-
onSubmit
public final void onSubmit()
This method is never called.- Specified by:
onSubmitin interfaceIFormSubmitter- Overrides:
onSubmitin classButton- See Also:
onSubmit(AjaxRequestTarget)
-
onAfterSubmit
public final void onAfterSubmit()
Description copied from class:ButtonOverride 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 afterForm.onSubmit().- Specified by:
onAfterSubmitin interfaceIFormSubmitter- Overrides:
onAfterSubmitin classButton
-
onError
public final void onError()
This method is never called.- Specified by:
onErrorin interfaceIFormSubmitter- Overrides:
onErrorin classButton- See Also:
onError(AjaxRequestTarget)
-
onSubmit
protected void onSubmit(AjaxRequestTarget target)
Listener method invoked on form submit with no errors, beforeForm.onSubmit().- Parameters:
target-
-
onAfterSubmit
protected void onAfterSubmit(AjaxRequestTarget target)
Listener method invoked on form submit with no errors, afterForm.onSubmit().- Parameters:
target-
-
onError
protected void onError(AjaxRequestTarget target)
Listener method invoked on form submit with errors- Parameters:
target-
-
getStatelessHint
protected boolean getStatelessHint()
Description copied from class:ComponentReturns 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:
getStatelessHintin classComponent- Returns:
- whether the component can be stateless
-
-