Package org.hippoecm.frontend.dialog

Class DialogWindow

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.hippoecm.frontend.dialog.wicket9.ModalWindow
org.hippoecm.frontend.dialog.DialogWindow
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, IDialogService
Direct Known Subclasses:
DialogService
public class DialogWindow extends ModalWindow implements IDialogService
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.hippoecm.frontend.dialog.wicket9.ModalWindow

    ModalWindow.CloseButtonBehavior, ModalWindow.CloseButtonCallback, ModalWindow.MaskType, ModalWindow.PageCreator, ModalWindow.WindowClosedCallback

    Nested classes/interfaces inherited from interface org.hippoecm.frontend.dialog.IDialogService

    IDialogService.Dialog

  • Field Summary

    Fields inherited from class org.hippoecm.frontend.dialog.wicket9.ModalWindow

    CONTENT_ID, CSS_CLASS_BLUE, CSS_CLASS_GRAY

    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

    Fields inherited from interface org.hippoecm.frontend.dialog.IDialogService

    DIALOG_WICKET_ID

  • Constructor Summary

    Constructors
    Constructor
    Description
    DialogWindow(String id)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    Close the current dialog.
    protected CharSequence
    getShowJavaScript()
    Revert ModalWindow change committed in https://issues.apache.org/jira/browse/WICKET-5101.
    void
    hide(IDialogService.Dialog dialog)
    Hides the dialog, if it is currently shown, or removes it from the list of to-be-shown dialogs.
    void
    internalRenderHead(org.apache.wicket.markup.html.internal.HtmlHeaderContainer container)
     
    boolean
    isShowingDialog()
    If a dialog is opened and still open, isShowingDialog() returns true until the previous opened dialog is closed.
    boolean
    isShown()
    Is this window currently showing.
    protected boolean
    makeContentVisible()
    You may subclass this method in case you don't want to show up the window on normal page refresh.
    protected void
    postProcessSettings(com.github.openjson.JSONObject settings)
    Adds the full dialog title for use in a tooltip.
    void
    render(PluginRequestTarget target)
    Invoked during the pre-rendering registration.
    void
    renderHead(org.apache.wicket.markup.head.IHeaderResponse response)
     
    void
    show(org.apache.wicket.ajax.AjaxRequestTarget target)
    Shows the modal window.
    void
    show(IDialogService.Dialog dialog)
    Show a dialog.
    void
    showPending()
     

    Methods inherited from class org.hippoecm.frontend.dialog.wicket9.ModalWindow

    close, closeCurrent, getCloseJavacript, getContent, getContentId, getCookieName, getCssClassName, getHeightUnit, getInitialHeight, getInitialWidth, getMaskType, getMinimalHeight, getMinimalWidth, getTitle, getWidthUnit, getWindowOpenJavaScript, isAutoSize, isCustomComponent, isResizable, isUseInitialHeight, newCloseButtonBehavior, newCssResource, onBeforeRender, onComponentTag, onDetach, remove, setAutoSize, setCloseButtonCallback, setContent, setCookieName, setCssClassName, setHeightUnit, setInitialHeight, setInitialWidth, setMaskType, setMinimalHeight, setMinimalWidth, setPageCreator, setResizable, setTitle, setTitle, setUseInitialHeight, setWidthUnit, setWindowClosedCallback, show, showUnloadConfirmation, showUnloadConfirmation

    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, onInitialize, onRender, queue, 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, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, 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

  • Constructor Details

    • DialogWindow

      public DialogWindow(String id)

  • Method Details

    • renderHead

      public void renderHead(org.apache.wicket.markup.head.IHeaderResponse response)
      Specified by:
      renderHead in interface org.apache.wicket.markup.html.IHeaderContributor
      Overrides:
      renderHead in class ModalWindow

    • getShowJavaScript

      protected CharSequence getShowJavaScript()
      Revert ModalWindow change committed in https://issues.apache.org/jira/browse/WICKET-5101. Dialogs should be created synchronously, otherwise other initialization code inside the dialogs (e.g. initializing YUI accordions) fails.
      Overrides:
      getShowJavaScript in class ModalWindow
      Returns:
      the script that actually shows the window.

    • postProcessSettings

      protected void postProcessSettings(com.github.openjson.JSONObject settings)
      Adds the full dialog title for use in a tooltip. This value shouldn't be HTML-escaped, but requires JavaScript quote-escaping.
      Overrides:
      postProcessSettings in class ModalWindow
      Parameters:
      settings - JSONObject

    • show

      public void show(IDialogService.Dialog dialog)
      Description copied from interface: IDialogService
      Show a dialog. When a dialog is already shown, the dialog is enqueued to be displayed when the current dialog is closed.
      Specified by:
      show in interface IDialogService

    • hide

      public void hide(IDialogService.Dialog dialog)
      Hides the dialog, if it is currently shown, or removes it from the list of to-be-shown dialogs. The onClose() method is not invoked on the dialog.
      Parameters:
      dialog - The dialog to hide

    • showPending

      public void showPending()

    • close

      public void close()
      Description copied from interface: IDialogService
      Close the current dialog.
      Specified by:
      close in interface IDialogService

    • internalRenderHead

      public void internalRenderHead(org.apache.wicket.markup.html.internal.HtmlHeaderContainer container)
      Overrides:
      internalRenderHead in class org.apache.wicket.Component

    • isShowingDialog

      public boolean isShowingDialog()
      Description copied from interface: IDialogService
      If a dialog is opened and still open, isShowingDialog() returns true until the previous opened dialog is closed.
      Specified by:
      isShowingDialog in interface IDialogService
      Returns:
      true if dialog is pending, otherwise false

    • render

      public void render(PluginRequestTarget target)
      Description copied from interface: IDialogService
      Invoked during the pre-rendering registration.
      Specified by:
      render in interface IDialogService

    • isShown

      public boolean isShown()
      Description copied from class: ModalWindow
      Is this window currently showing.
      Overrides:
      isShown in class ModalWindow
      Returns:
      the shown

    • show

      public void show(org.apache.wicket.ajax.AjaxRequestTarget target)
      Shows the modal window.
      Parameters:
      target - Request target associated with current ajax request.

    • makeContentVisible

      protected boolean makeContentVisible()
      Description copied from class: ModalWindow
      You may subclass this method in case you don't want to show up the window on normal page refresh.
      Overrides:
      makeContentVisible in class ModalWindow
      Returns:
      true, if the window shall be shown