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

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.form.LabeledWebMarkupContainer
                  extended by org.apache.wicket.markup.html.form.FormComponent<String>
                      extended by org.apache.wicket.markup.html.form.Button
                          extended by org.apache.wicket.ajax.markup.html.form.AjaxFallbackButton
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 AjaxFallbackButton
extends Button

An ajax submit button that will degrade to a normal request if ajax is not available or javascript is disabled.

Since:
1.3
Author:
Jeremy Thomerson (jthomerson), Alastair Maw
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_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER
 
Constructor Summary
AjaxFallbackButton(String id, Form<?> form)
          Construct.
AjaxFallbackButton(String id, IModel<String> model, Form<?> form)
          Construct.
 
Method Summary
protected  AjaxChannel getChannel()
          Deprecated. Use #updateAjaxAttributes() instead
 Form<?> getForm()
          Override to not throw exception if there is no parent form.
protected  boolean isButtonEnabled()
          Helper methods that both checks whether the link is enabled and whether the action ENABLE is allowed.
 void onAfterSubmit()
          Override this method to provide special submit handling in a multi-button form.
protected  void onAfterSubmit(AjaxRequestTarget target, Form<?> form)
          Callback for the onClick event.
protected  void onComponentTag(ComponentTag tag)
          Processes the component tag.
protected  void onError(AjaxRequestTarget target, Form<?> form)
          Listener method invoked on form submit with errors
 void onSubmit()
          Override this method to provide special submit handling in a multi-button form.
protected  void onSubmit(AjaxRequestTarget target, Form<?> form)
          Callback for the onClick event.
protected  void updateAjaxAttributes(AjaxRequestAttributes attributes)
           
 
Methods inherited from class org.apache.wicket.markup.html.form.Button
getDefaultFormProcessing, getOnClickScript, initModel, onError, 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, onValid, processChildren, processInput, remove, reportRequiredError, setConvertedInput, setLabel, setModel, setModelObject, setModelValue, setRequired, setType, shouldTrimInput, trim, 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
getWebPage, getWebRequest, getWebResponse, getWebSession
 
Methods inherited from class org.apache.wicket.MarkupContainer
add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, 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, clearOriginalDestination, 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, 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, internalPrepareForRender, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onBeforeRender, 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, 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

AjaxFallbackButton

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

Parameters:
id -
form -

AjaxFallbackButton

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

Parameters:
id -
model -
form -
Method Detail

updateAjaxAttributes

protected void updateAjaxAttributes(AjaxRequestAttributes attributes)

onError

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

Parameters:
target -
form -

onSubmit

public final void onSubmit()
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 before Form.onSubmit().

Specified by:
onSubmit in interface IFormSubmitter
Overrides:
onSubmit in class Button
See Also:
IFormSubmitter.onSubmit()

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
See Also:
IFormSubmitter.onAfterSubmit()

getForm

public Form<?> getForm()
Description copied from class: Button
Override to not throw exception if there is no parent form.

Specified by:
getForm in interface IFormSubmitter
Overrides:
getForm in class Button
Returns:
the parent form or null
See Also:
Button.getForm()

onSubmit

protected void onSubmit(AjaxRequestTarget target,
                        Form<?> form)
Callback for the onClick event. If ajax failed and this event was generated via a normal submission, the target argument will be null. This method will be called before Form.onSubmit().

Parameters:
target - ajax target if this linked was invoked using ajax, null otherwise
form -

onAfterSubmit

protected void onAfterSubmit(AjaxRequestTarget target,
                             Form<?> form)
Callback for the onClick event. If ajax failed and this event was generated via a normal submission, the target argument will be null. This method will be called after Form.onSubmit().

Parameters:
target - ajax target if this linked was invoked using ajax, null otherwise
form -

getChannel

@Deprecated
protected AjaxChannel getChannel()
Deprecated. Use #updateAjaxAttributes() instead

Returns:
the channel that manages how Ajax calls are executed
See Also:
AbstractDefaultAjaxBehavior.getChannel()

isButtonEnabled

protected final boolean isButtonEnabled()
Helper methods that both checks whether the link is enabled and whether the action ENABLE is allowed.

Returns:
whether the link should be rendered as enabled

onComponentTag

protected void onComponentTag(ComponentTag tag)
Description copied from class: Button
Processes the component tag. A value attribute is added with the value of the model object, if available. An onclick attribute is added if the subclass specified javascript.

NOTE. For a <button> the value attribute is not rendered, markup needs to be added within the button to display the button's label.

Overrides:
onComponentTag in class Button
Parameters:
tag - Tag to modify
See Also:
Component.onComponentTag(ComponentTag)


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