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

Class AbstractFormDialog<T extends Serializable>

  • Type Parameters:
    T - the model object type
    All Implemented Interfaces:
    com.googlecode.wicket.jquery.core.IJQueryWidget, IDialogListener, Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.feedback.IFeedbackContributor, org.apache.wicket.IConverterLocator, org.apache.wicket.IGenericComponent<T,​org.apache.wicket.markup.html.panel.GenericPanel<T>>, org.apache.wicket.IMetadataContext<Serializable,​org.apache.wicket.Component>, org.apache.wicket.IQueueRegion, 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 Description
      protected class  AbstractFormDialog.DialogFormSubmitter
      Provides the form-dialog IFormSubmitter
      This is basically the same technic used in AjaxButton class.

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

        com.googlecode.wicket.jquery.core.IJQueryWidget.JQueryWidget

    • 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_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method 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)
      Gets the form associated to the button.
      It means that it will return the form if the button is the submit button and null otherwise.
      org.apache.wicket.model.IModelComparator getModelComparator()  
      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 ButtonAjaxBehavior newButtonAjaxBehavior​(com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware source, DialogButton button)
      Gets the ButtonAjaxPostBehavior associated to the specified button.
      void onClose​(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler, DialogButton button)
      Triggered when the dialog closes.
      protected abstract void onError​(org.apache.wicket.ajax.AjaxRequestTarget target, DialogButton button)
      Triggered when the form is submitted, but the validation failed
      protected void onInitialize()  
      protected void onModelChanged()  
      protected abstract void onSubmit​(org.apache.wicket.ajax.AjaxRequestTarget target, DialogButton button)
      Triggered when the form is submitted, and the validation succeed

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

        getRegionMarkup, newMarkupSourcingStrategy

      • 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, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, 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, 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, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onEvent, 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 interface org.apache.wicket.IGenericComponent

        getDefaultModel, getDefaultModelObject, getModel, getModelObject, setDefaultModel, setDefaultModelObject, setModel, setModelObject

      • Methods inherited from interface org.apache.wicket.IQueueRegion

        dequeue, newDequeueContext

    • 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

        public 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)
        Gets 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

      • getModelComparator

        public org.apache.wicket.model.IModelComparator getModelComparator()
        Overrides:
        getModelComparator in class org.apache.wicket.Component

      • onModelChanged

        protected void onModelChanged()
        Overrides:
        onModelChanged in class org.apache.wicket.Component

      • onClose

        public void onClose​(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler,
                    DialogButton button)
        Description copied from interface: IDialogListener
        Triggered when the dialog closes.
        Parameters:
        handler - the IPartialPageRequestHandler
        button - the button that closed the dialog

      • onError

        protected abstract void onError​(org.apache.wicket.ajax.AjaxRequestTarget target,
                                DialogButton button)
        Triggered when the form is submitted, but the validation failed
        Parameters:
        target - the AjaxRequestTarget
        button - the DialogButton that submitted the form

      • onSubmit

        protected abstract void onSubmit​(org.apache.wicket.ajax.AjaxRequestTarget target,
                                 DialogButton button)
        Triggered when the form is submitted, and the validation succeed
        Parameters:
        target - the AjaxRequestTarget
        button - the DialogButton that submitted the form