Module org.apache.wicket.extensions
Package org.apache.wicket.extensions.ajax.markup.html.modal

Class ModalDialog

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.extensions.ajax.markup.html.modal.ModalDialog
All Implemented Interfaces:
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.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
public class ModalDialog extends org.apache.wicket.markup.html.panel.Panel
Presents a modal dialog to the user. See open(Component, AjaxRequestTarget) and close(AjaxRequestTarget) methods.

Note: This component does not provide any styling by itself, so you have can add a DefaultTheme to this component if aren't styling these CSS classes by yourself:

modal-dialog-overlay
the wrapper around the actual dialog, usually used to overlay the rest of the document
modal-dialog
the actual dialog
modal-dialog-content
any additional styling for the content of this dialog
Author:
Igor Vaynberg (ivaynberg), svenmeier
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CONTENT_ID
    The id for the content of this dialoh.

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    ModalDialog(String id)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    ModalDialog
    close(org.apache.wicket.ajax.AjaxRequestTarget target)
    Close this dialog.
    ModalDialog
    closeOnClick()
    Close this dialog on click outside.
    ModalDialog
    closeOnEscape()
    Close this dialog on press of escape key.
    boolean
    isOpen()
    Is this dialog open.
    protected org.apache.wicket.markup.html.WebMarkupContainer
    newDialog(String dialogId)
    Factory method for the dialog markup around the content.
    protected org.apache.wicket.markup.html.WebMarkupContainer
    newOverlay(String overlayId)
    Factory method for the overlay markup around the dialog.
    ModalDialog
    open(org.apache.wicket.ajax.AjaxRequestTarget target)
    Open the dialog.
    ModalDialog
    open(org.apache.wicket.Component content, org.apache.wicket.ajax.AjaxRequestTarget target)
    Open the dialog with a content.
    protected void
    postProcessCloseBehaviorAjaxAttributes(org.apache.wicket.ajax.attributes.AjaxRequestAttributes attributes)
    can be overridden to change the AjaxRequestAttributes of the default ModalDialog.CloseBehavior executed on close.
    void
    setContent(org.apache.wicket.Component content)
    Set a content.
    ModalDialog
    trapFocus()
    Convenience method to trap focus inside the overlay.

    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, onDetach, onInitialize, 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, getMarkupTag, 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, 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, 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.IQueueRegion

    dequeue, newDequeueContext

    Methods inherited from interface java.lang.Iterable

    forEach, spliterator

  • Field Details

  • Constructor Details

  • Method Details

    • newOverlay

      protected org.apache.wicket.markup.html.WebMarkupContainer newOverlay(String overlayId)
      Factory method for the overlay markup around the dialog.
      Parameters:
      overlayId - id
      Returns:
      overlay

    • newDialog

      protected org.apache.wicket.markup.html.WebMarkupContainer newDialog(String dialogId)
      Factory method for the dialog markup around the content.
      Parameters:
      dialogId - id
      Returns:
      overlay

    • setContent

      public void setContent(org.apache.wicket.Component content)
      Set a content.
      Parameters:
      content -
      See Also:

    • open

      public ModalDialog open(org.apache.wicket.Component content, org.apache.wicket.ajax.AjaxRequestTarget target)
      Open the dialog with a content.

      The content will be removed on close of the dialog.

      Parameters:
      content - the content
      target - an optional Ajax target
      Returns:
      this
      See Also:

    • open

      public ModalDialog open(org.apache.wicket.ajax.AjaxRequestTarget target)
      Open the dialog.
      Parameters:
      target - an optional Ajax target
      Returns:
      this
      See Also:

    • isOpen

      public boolean isOpen()
      Is this dialog open.
      Returns:
      true if open

    • close

      public ModalDialog close(org.apache.wicket.ajax.AjaxRequestTarget target)
      Close this dialog.

      If opened via open(Component, AjaxRequestTarget), the content is removed from the component tree

      Parameters:
      target - an optional Ajax target
      Returns:
      this
      See Also:

    • closeOnEscape

      public ModalDialog closeOnEscape()
      Close this dialog on press of escape key.
      Returns:
      this

    • closeOnClick

      public ModalDialog closeOnClick()
      Close this dialog on click outside.
      Returns:
      this

    • trapFocus

      public ModalDialog trapFocus()
      Convenience method to trap focus inside the overlay.
      Returns:
      this
      See Also:

    • postProcessCloseBehaviorAjaxAttributes

      protected void postProcessCloseBehaviorAjaxAttributes(org.apache.wicket.ajax.attributes.AjaxRequestAttributes attributes)
      can be overridden to change the AjaxRequestAttributes of the default ModalDialog.CloseBehavior executed on close. For example to change the Ajax Channel.
      Parameters:
      attributes - the AjaxRequestAttributes of the default ModalDialog.CloseBehavior