org.hippoecm.frontend.plugins.yui

Class AbstractYuiAjaxBehavior

java.lang.Object

org.apache.wicket.behavior.AbstractBehavior

org.apache.wicket.behavior.AbstractAjaxBehavior

org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

org.hippoecm.frontend.plugins.yui.AbstractYuiAjaxBehavior

All Implemented Interfaces:

Serializable, org.apache.wicket.behavior.IBehavior, org.apache.wicket.behavior.IBehaviorListener, org.apache.wicket.behavior.IComponentConfigurationBehavior, org.apache.wicket.IClusterable, org.apache.wicket.IRequestListener, org.apache.wicket.markup.html.IHeaderContributor

Direct Known Subclasses:

AbstractDragDropBehavior, AjaxMultiFileUploadBehavior, AutoCompleteBehavior, ProbeFlashBehavior, TreeBehavior, WireframeBehavior

public abstract class AbstractYuiAjaxBehavior
extends org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

Base class for AbstractDefaultAjaxBehaviors that want to use YUI modules. It uses a IYuiContext to register all required components. The IYuiContext is created by a (global) IYuiManager which, in this case, lives inside the Page (as an IBehavior) that is retrieved by component.getPage()

To allow clientside javascript components to do callbacks in a more flexible way than, for example, just sticking them inside an element's onclick attribute, this behavior uses a bean that implements IAjaxSettings in which it will store the callbackUrl, a list of allowed callbackParameters and an anonymous function that takes the callbackUrl as an argument and executes the callbackScript that is generated by the AbstractDefaultAjaxBehavior.

Subclasses should override addHeaderContribution(IYuiContext context) to get access to the IYuiContext.

Note: This behavior skips adding the necessary Wicket-Ajax header contributions, as this is handled by the YuiHeaderCache

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

INDICATOR

Fields inherited from interface org.apache.wicket.behavior.IBehaviorListener

INTERFACE

Constructor Summary

Constructors

Constructor and Description
AbstractYuiAjaxBehavior(IAjaxSettings settings)

Method Summary

Methods

Modifier and Type	Method and Description
void	addHeaderContribution(IYuiContext context) Override this method to get access to the IYuiContext
protected String	getCallbackFunction() Wrap the callback script in an anonymous function that takes the callback url as a parameter to allow client side code to add request parameters
protected Map<String,Object>	getCallbackParameters() Provide custom callbackParameters
protected void	onRenderHead(org.apache.wicket.markup.html.IHeaderResponse response)
void	renderHead(org.apache.wicket.markup.html.IHeaderResponse response) Don't call super since WicketAjax is loaded by Yui webapp behavior TODO: webapp ajax is configurable, maybe check here and still load it.
protected void	updateAjaxSettings()

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

findIndicatorId, generateCallbackScript, getAjaxCallDecorator, getCallbackScript, getCallbackScript, getChannelName, getFailureScript, getPreconditionScript, getSuccessScript, onBind, onRequest, respond, throttleScript

Methods inherited from class org.apache.wicket.behavior.AbstractAjaxBehavior

bind, getCallbackUrl, getCallbackUrl, getComponent, getImplementationId, getStatelessHint, onComponentRendered, onComponentTag, onComponentTag, onRendered, onRenderHeadContribution, onRenderHeadInitContribution

Methods inherited from class org.apache.wicket.behavior.AbstractBehavior

afterRender, beforeRender, cleanup, detach, detachModel, exception, isEnabled, isTemporary, onConfigure, onException, rendered

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractYuiAjaxBehavior

public AbstractYuiAjaxBehavior(IAjaxSettings settings)

Method Detail

updateAjaxSettings

protected void updateAjaxSettings()

getCallbackFunction

protected String getCallbackFunction()

Wrap the callback script in an anonymous function that takes the callback url as a parameter to allow client side code to add request parameters

Returns:

A javascript function that takes a callback URL as parameter and executes wicketAjax-GET

getCallbackParameters

protected Map<String,Object> getCallbackParameters()

Provide custom callbackParameters

Returns:

JavascriptObjectMap containing key/value pairs that should be used as callbackParameters

addHeaderContribution

public void addHeaderContribution(IYuiContext context)

Override this method to get access to the IYuiContext

Parameters:

context - The IYuiContext this behavior can use to register YUI-modules and the likes.

renderHead

public void renderHead(org.apache.wicket.markup.html.IHeaderResponse response)

Don't call super since WicketAjax is loaded by Yui webapp behavior TODO: webapp ajax is configurable, maybe check here and still load it.

Specified by:

renderHead in interface org.apache.wicket.markup.html.IHeaderContributor

Overrides:

renderHead in class org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

onRenderHead

protected void onRenderHead(org.apache.wicket.markup.html.IHeaderResponse response)