org.hippoecm.frontend

Class PluginRequestTarget

java.lang.Object

org.apache.wicket.ajax.AjaxRequestTarget

org.hippoecm.frontend.PluginRequestTarget

All Implemented Interfaces:

org.apache.wicket.ajax.AjaxRequestTarget.IListener, org.apache.wicket.IRequestTarget, org.apache.wicket.request.target.component.IPageRequestTarget

public class PluginRequestTarget
extends org.apache.wicket.ajax.AjaxRequestTarget
implements org.apache.wicket.ajax.AjaxRequestTarget.IListener

Extension of Wicket's AjaxRequestTarget that filters the list of Components that have been added.

This implementation of the AjaxRequestTarget allows components to be added to the request target even when they are later on removed from the (visible) component tree. The default wicket way requires that the component that responds to an ajax request knows which components need to be redrawn and which changes are made in the component hierarchy.

For the CMS plugin framework, this coupling has been lifted using this extension, the PluginRequestTarget. In the processing of ajax requests, the action phase (invocation of the listener) marks components that need to be redrawn (see RenderService#redraw), that later on can actually register for rendering (IRenderService#render).

For regular wicket components, this is not an option. So for those are still able to rerender themselves after e.g. a model change. Since other plugins might change the hierarchy in response to the changes, the component might no longer be there during the rendering though. The PluginRequestTarget handles this case by discarding the component.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.ajax.AjaxRequestTarget

org.apache.wicket.ajax.AjaxRequestTarget.IJavascriptResponse, org.apache.wicket.ajax.AjaxRequestTarget.IListener, org.apache.wicket.ajax.AjaxRequestTarget.ITargetRespondListener

Constructor Summary

Constructors

Constructor and Description
PluginRequestTarget(org.apache.wicket.Page page)

Method Summary

Methods

Modifier and Type	Method and Description
void	addComponent(org.apache.wicket.Component component)
void	addListener(org.apache.wicket.ajax.AjaxRequestTarget.IListener listener)
boolean	equals(Object obj)
org.apache.wicket.markup.html.IHeaderResponse	getHeaderResponse()
int	hashCode()
void	onAfterRespond(Map map, org.apache.wicket.ajax.AjaxRequestTarget.IJavascriptResponse response)
void	onBeforeRespond(Map existing, org.apache.wicket.ajax.AjaxRequestTarget target)

Methods inherited from class org.apache.wicket.ajax.AjaxRequestTarget

addChildren, addComponent, addJavascript, appendJavascript, detach, encode, focusComponent, get, getComponents, getEncodingName, getLastFocusedElementId, getPage, needsEncoding, prependJavascript, registerRespondListener, respond, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PluginRequestTarget

public PluginRequestTarget(org.apache.wicket.Page page)

Method Detail

addComponent

public void addComponent(org.apache.wicket.Component component)

Overrides:

addComponent in class org.apache.wicket.ajax.AjaxRequestTarget

addListener

public void addListener(org.apache.wicket.ajax.AjaxRequestTarget.IListener listener)

Overrides:

addListener in class org.apache.wicket.ajax.AjaxRequestTarget

onBeforeRespond

public void onBeforeRespond(Map existing,
                   org.apache.wicket.ajax.AjaxRequestTarget target)

Specified by:

onBeforeRespond in interface org.apache.wicket.ajax.AjaxRequestTarget.IListener

onAfterRespond

public void onAfterRespond(Map map,
                  org.apache.wicket.ajax.AjaxRequestTarget.IJavascriptResponse response)

Specified by:

onAfterRespond in interface org.apache.wicket.ajax.AjaxRequestTarget.IListener

getHeaderResponse

public org.apache.wicket.markup.html.IHeaderResponse getHeaderResponse()

Overrides:

getHeaderResponse in class org.apache.wicket.ajax.AjaxRequestTarget

hashCode

public int hashCode()

Overrides:

hashCode in class org.apache.wicket.ajax.AjaxRequestTarget

equals

public boolean equals(Object obj)

Overrides:

equals in class org.apache.wicket.ajax.AjaxRequestTarget