org.apache.wicket.extensions.ajax.markup.html
Class AjaxLazyLoadPanel

java.lang.Object
  org.apache.wicket.Component
      org.apache.wicket.MarkupContainer
          org.apache.wicket.markup.html.WebMarkupContainer
              org.apache.wicket.markup.html.WebMarkupContainerWithAssociatedMarkup
                  org.apache.wicket.markup.html.panel.Panel
                      org.apache.wicket.extensions.ajax.markup.html.AjaxLazyLoadPanel

All Implemented Interfaces:

Serializable, IClusterable, IConverterLocator, IHeaderPartContainerProvider

public abstract class AjaxLazyLoadPanel
extends Panel

A panel where you can lazy load another panel. This can be used if you have a panel/component that is pretty heavy in creation and you first want to show the user the page and then replace the panel when it is ready.

Since:

1.3

Author:

jcompagner

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.Component

Component.ComponentModelChange, Component.EnabledChange, Component.IVisitor<T extends Component>, Component.VisibilityChange

Field Summary

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_CONFIGURED, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PATH_SEPARATOR, RENDER

Constructor Summary

AjaxLazyLoadPanel(String id)
Constructor

AjaxLazyLoadPanel(String id, IModel<?> model)
Constructor

Method Summary

abstract Component	getLazyLoadComponent(String markupId)
Component	getLoadingComponent(String markupId)
protected void	handleCallbackScript(IHeaderResponse response, String callbackScript) Allows subclasses to change the callback script if needed.
protected void	onBeforeRender() Called just before a component is rendered.

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

onComponentTag, onComponentTagBody, renderHead

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainerWithAssociatedMarkup

newHeaderPartContainer, renderHeadFromAssociatedMarkupFile

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

getMarkupType, getWebPage, getWebRequest

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onAfterRenderChildren, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, renderNext, replace, setDefaultModel, setMarkupStream, size, swap, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdImpl, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalAttach, internalDetach, internalOnAttach, internalOnDetach, internalOnModelChanged, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onAttach, onBeginRequest, onConfigure, onDetach, onEndRequest, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AjaxLazyLoadPanel

public AjaxLazyLoadPanel(String id)

Constructor

Parameters:

id -

AjaxLazyLoadPanel

public AjaxLazyLoadPanel(String id,
                         IModel<?> model)

Constructor

Parameters:

id -

model -

Method Detail

handleCallbackScript

protected void handleCallbackScript(IHeaderResponse response,
                                    String callbackScript)

Allows subclasses to change the callback script if needed.

Parameters:

response -

callbackScript -

onBeforeRender

protected void onBeforeRender()

Description copied from class: Component

Called just before a component is rendered.

NOTE: If you override this, you *must* call super.onBeforeRender() within your implementation. Because this method is responsible for cascading Component.onBeforeRender() call to its children it is strongly recommended that super call is made at the end of the override.

Overrides:

onBeforeRender in class Component

See Also:

Component.onBeforeRender()

getLazyLoadComponent

public abstract Component getLazyLoadComponent(String markupId)

Parameters:

markupId - The components markupid.

Returns:

The component that must be lazy created. You may call setRenderBodyOnly(true) on this component if you need the body only.

getLoadingComponent

public Component getLoadingComponent(String markupId)

Parameters:

markupId - The components markupid.

Returns:

The component to show while the real component is being created.