com.googlecode.wicket.jquery.ui.form.button
Class ConfirmAjaxButton

java.lang.Object
  org.apache.wicket.Component
      org.apache.wicket.MarkupContainer
          org.apache.wicket.markup.html.WebMarkupContainer
              org.apache.wicket.markup.html.panel.Panel
                  org.apache.wicket.markup.html.panel.GenericPanel<String>
                      com.googlecode.wicket.jquery.ui.form.button.ConfirmAjaxButton

All Implemented Interfaces:

Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, org.apache.wicket.IGenericComponent<String>, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.IClusterable

public abstract class ConfirmAjaxButton
extends org.apache.wicket.markup.html.panel.GenericPanel<String>

Provides a AjaxButton which pop-ups an OK-Cancel confirmation dialog when clicked. In case of confirmation, the form is sent via an ajax post.

Note: this component is not an AjaxButton itself but a Panel, it should not be attached to a <button />; it can be attached on a <div /> or a <span /> for instance.

Warning: it is not possible to get a form component value - that is going to be changed - to be displayed in the dialog box message. The reason is that in order to get a form component (updated) model object, the form component should be validated. The dialog does not proceed to a (whole) form validation while being opened, because the form validation will occur when the user will confirm (by clicking on OK button). This the intended behavior.

Author:

Sebastien Briquet - sebfz1

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.wicket.markup.html.panel.Panel

PANEL

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

ConfirmAjaxButton(String id, org.apache.wicket.model.IModel<String> label, org.apache.wicket.model.IModel<String> title, org.apache.wicket.model.IModel<String> message)
Constructor

ConfirmAjaxButton(String id, String label, String title, String message)
Constructor

Method Summary

protected String	getIcon() Gets the icon being displayed in the button
protected AbstractFormDialog<?>	newFormDialog(String id, org.apache.wicket.model.IModel<String> title, org.apache.wicket.model.IModel<String> message) Create the dialog instance Warning: to be overridden with care!
protected abstract void	onError(org.apache.wicket.ajax.AjaxRequestTarget target, org.apache.wicket.markup.html.form.Form<?> form) Triggered when the form has been submitted, but the validation failed
protected abstract void	onSubmit(org.apache.wicket.ajax.AjaxRequestTarget target, org.apache.wicket.markup.html.form.Form<?> form) Triggered when the form has been submitted, and the validation succeed

Methods inherited from class org.apache.wicket.markup.html.panel.GenericPanel

getModel, getModelObject, setModel, setModelObject

Methods inherited from class org.apache.wicket.markup.html.panel.Panel

newMarkupSourcingStrategy

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, initModel, internalOnModelChanged, internalPrepareForRender, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onDetach, 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

Constructor Detail

ConfirmAjaxButton

public ConfirmAjaxButton(String id,
                         String label,
                         String title,
                         String message)

Constructor

Parameters:

id - markup id

label - the button text

title - the dialog title

message - the dialog message

ConfirmAjaxButton

public ConfirmAjaxButton(String id,
                         org.apache.wicket.model.IModel<String> label,
                         org.apache.wicket.model.IModel<String> title,
                         org.apache.wicket.model.IModel<String> message)

Constructor

Parameters:

id - markup id

label - the button text

title - the dialog title

message - the dialog message

Method Detail

getIcon

protected String getIcon()

Gets the icon being displayed in the button

Returns:

the JQueryIcon

onError

protected abstract void onError(org.apache.wicket.ajax.AjaxRequestTarget target,
                                org.apache.wicket.markup.html.form.Form<?> form)

Triggered when the form has been submitted, but the validation failed

Parameters:

target - the AjaxRequestTarget

form - the Form

onSubmit

protected abstract void onSubmit(org.apache.wicket.ajax.AjaxRequestTarget target,
                                 org.apache.wicket.markup.html.form.Form<?> form)

Triggered when the form has been submitted, and the validation succeed

Parameters:

target - the AjaxRequestTarget

form - the Form

newFormDialog

protected AbstractFormDialog<?> newFormDialog(String id,
                                              org.apache.wicket.model.IModel<String> title,
                                              org.apache.wicket.model.IModel<String> message)

Create the dialog instance
Warning: to be overridden with care!

Parameters:

id - the markupId

title - the title of the dialog

message - the message to be displayed

Returns:

the dialog instance