com.googlecode.wicket.jquery.ui.widget.dialog

Class AbstractFormDialog<T extends Serializable>

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.panel.Panel

com.googlecode.wicket.jquery.core.JQueryPanel

com.googlecode.wicket.jquery.ui.widget.dialog.AbstractDialog<T>

com.googlecode.wicket.jquery.ui.widget.dialog.AbstractFormDialog<T>

Type Parameters:

T - the model object type

All Implemented Interfaces:

IJQueryWidget, Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, 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

Direct Known Subclasses:

AbstractWizard, FragmentFormDialog, InputDialog, MessageFormDialog

public abstract class AbstractFormDialog<T extends Serializable>
extends AbstractDialog<T>

Provides the base class for form-based dialogs

Author:

Sebastien Briquet - sebfz1

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractFormDialog.DialogFormSubmitter Provides the form-dialog IFormSubmitter This is basically the same technic used in AjaxButton class.
protected static class	AbstractFormDialog.FormButtonAjaxBehavior Provides the button's form-submit behavior

Nested classes/interfaces inherited from interface com.googlecode.wicket.jquery.core.IJQueryWidget

IJQueryWidget.JQueryWidget

Field Summary

Fields inherited from class com.googlecode.wicket.jquery.ui.widget.dialog.AbstractDialog

LBL_CANCEL, LBL_CLOSE, LBL_NO, LBL_OK, LBL_SUBMIT, LBL_YES

Fields inherited from class com.googlecode.wicket.jquery.core.JQueryPanel

options

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

Constructors

Constructor and Description
AbstractFormDialog(String id, org.apache.wicket.model.IModel<String> title) Constructor
AbstractFormDialog(String id, org.apache.wicket.model.IModel<String> title, boolean modal) Constructor
AbstractFormDialog(String id, org.apache.wicket.model.IModel<String> title, org.apache.wicket.model.IModel<T> model) Constructor
AbstractFormDialog(String id, org.apache.wicket.model.IModel<String> title, org.apache.wicket.model.IModel<T> model, boolean modal) Constructor
AbstractFormDialog(String id, String title) Constructor
AbstractFormDialog(String id, String title, boolean modal) Constructor
AbstractFormDialog(String id, String title, org.apache.wicket.model.IModel<T> model) Constructor
AbstractFormDialog(String id, String title, org.apache.wicket.model.IModel<T> model, boolean modal) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getDefaultFormProcessing() Returns whether form should be processed the default way.
abstract org.apache.wicket.markup.html.form.Form<?>	getForm() Gets the form to be validated by this dialog. Warning, the onSubmit and the onError are being delegated to this dialog.
protected org.apache.wicket.markup.html.form.Form<?>	getForm(DialogButton button) Returns the form associated to the button. It means that it will return the form if the button is the submit button and null otherwise.
protected abstract DialogButton	getSubmitButton() Gets the button that is in charge to submit the form. It should be in the list of buttons returned by AbstractDialog.getButtons()
protected DialogBehavior.ButtonAjaxBehavior	newButtonAjaxBehavior(IJQueryAjaxAware source, DialogButton button) Gets the AbstractFormDialog.FormButtonAjaxBehavior associated to the specified button.
void	onClose(org.apache.wicket.ajax.AjaxRequestTarget target, DialogButton button)
protected abstract void	onError(org.apache.wicket.ajax.AjaxRequestTarget target) Triggered after Form.onError() (when the form processing has error(s))
protected abstract void	onSubmit(org.apache.wicket.ajax.AjaxRequestTarget target) Triggered after Form.onSubmit() (the form has been submitted and it does not have error)

Methods inherited from class com.googlecode.wicket.jquery.ui.widget.dialog.AbstractDialog

close, findButton, getButtons, getModel, getModelObject, getTitle, getWidth, isDefaultCloseEventEnabled, isModal, isResizable, newWidgetBehavior, onClick, onConfigure, onInitialize, onOpen, open, setModelObject, setTitle

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

AbstractFormDialog

public AbstractFormDialog(String id,
                  String title)

Constructor

Parameters:

id - the markup id

title - the dialog's title

AbstractFormDialog

public AbstractFormDialog(String id,
                  org.apache.wicket.model.IModel<String> title)

Constructor

Parameters:

id - the markup id

title - the dialog's title

AbstractFormDialog

public AbstractFormDialog(String id,
                  String title,
                  org.apache.wicket.model.IModel<T> model)

Constructor

Parameters:

id - the markup id

title - the dialog's title

model - the dialog's model

AbstractFormDialog

public AbstractFormDialog(String id,
                  org.apache.wicket.model.IModel<String> title,
                  org.apache.wicket.model.IModel<T> model)

Constructor

Parameters:

id - the markup id

title - the dialog's title

model - the dialog's model

AbstractFormDialog

public AbstractFormDialog(String id,
                  String title,
                  boolean modal)

Constructor

Parameters:

id - the markup id

title - the dialog's title

modal - indicates whether the dialog is modal

AbstractFormDialog

public AbstractFormDialog(String id,
                  org.apache.wicket.model.IModel<String> title,
                  boolean modal)

Constructor

Parameters:

id - the markup id

title - the dialog's title

modal - indicates whether the dialog is modal

AbstractFormDialog

public AbstractFormDialog(String id,
                  String title,
                  org.apache.wicket.model.IModel<T> model,
                  boolean modal)

Constructor

Parameters:

id - the markup id

title - the dialog's title

model - the dialog's model

modal - indicates whether the dialog is modal

AbstractFormDialog

public AbstractFormDialog(String id,
                  org.apache.wicket.model.IModel<String> title,
                  org.apache.wicket.model.IModel<T> model,
                  boolean modal)

Constructor

Parameters:

id - the markup id

title - the dialog's title

model - the dialog's model

modal - indicates whether the dialog is modal

Method Detail

getSubmitButton

protected abstract DialogButton getSubmitButton()

Gets the button that is in charge to submit the form.
It should be in the list of buttons returned by AbstractDialog.getButtons()

Returns:

the submit button

getDefaultFormProcessing

public boolean getDefaultFormProcessing()

Returns whether form should be processed the default way. When false (default is true), all validation and form updating is bypassed and the onSubmit method of that button is called directly, and the onSubmit method of the parent form is not called. A common use for this is to create a cancel button.

Returns:

defaultFormProcessing

getForm

public abstract org.apache.wicket.markup.html.form.Form<?> getForm()

Gets the form to be validated by this dialog.
Warning, the onSubmit and the onError are being delegated to this dialog. However, it does not prevent the use of Form#onSubmit nor Form#onError

Returns:

the form

getForm

protected org.apache.wicket.markup.html.form.Form<?> getForm(DialogButton button)

Returns the form associated to the button.
It means that it will return the form if the button is the submit button and null otherwise. The callback script will differ depending on this.

Parameters:

button - the dialog's button

Returns:

the Form or null

onClose

public void onClose(org.apache.wicket.ajax.AjaxRequestTarget target,
           DialogButton button)

onError

protected abstract void onError(org.apache.wicket.ajax.AjaxRequestTarget target)

Triggered after Form.onError() (when the form processing has error(s))

Parameters:

target -

onSubmit

protected abstract void onSubmit(org.apache.wicket.ajax.AjaxRequestTarget target)

Triggered after Form.onSubmit() (the form has been submitted and it does not have error)

Parameters:

target -

newButtonAjaxBehavior

protected DialogBehavior.ButtonAjaxBehavior newButtonAjaxBehavior(IJQueryAjaxAware source,
                                                      DialogButton button)

Gets the AbstractFormDialog.FormButtonAjaxBehavior associated to the specified button.

Overrides:

newButtonAjaxBehavior in class AbstractDialog<T extends Serializable>

Parameters:

source - the IJQueryAjaxAware source

button - the button that is passed to the behavior so it can be retrieved via the DialogBehavior#ClickEvent

Returns:

the DialogBehavior.ButtonAjaxBehavior