org.wicketstuff.urlfragment

Class UrlParametersReceivingBehavior

java.lang.Object

org.apache.wicket.behavior.Behavior

org.apache.wicket.behavior.AbstractAjaxBehavior

org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

org.wicketstuff.urlfragment.UrlParametersReceivingBehavior

All Implemented Interfaces:

Serializable, org.apache.wicket.behavior.IBehaviorListener, org.apache.wicket.IComponentAwareEventSink, org.apache.wicket.IRequestListener, org.apache.wicket.markup.html.IComponentAwareHeaderContributor, org.apache.wicket.util.io.IClusterable

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

Reads URL fragment parameters. This Behavior will execute an AJAX call to itself with the URL query and fragment parameters.

Author:

Martin Knopf

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
UrlParametersReceivingBehavior(org.apache.wicket.Component... components) Constructor that takes an array of Components which will be added to the AjaxRequestTarget for you when the URL parameters come in.
UrlParametersReceivingBehavior(Map<String,String> options, org.apache.wicket.Component... components) Constructor that takes an array of Components which will be added to the AjaxRequestTarget for you when the URL parameters come in.

Method Summary

Methods

Modifier and Type	Method and Description
protected static org.apache.wicket.markup.head.HeaderItem	getJS(Class<?> scope) Returns the HeaderItem representing the JavaScript library used to read and write URL fragment parameters.
protected abstract void	onParameterArrival(org.apache.wicket.request.IRequestParameters requestParameters, org.apache.wicket.ajax.AjaxRequestTarget target) Hook for evaluating the request parameters when they come in.
void	renderHead(org.apache.wicket.Component component, org.apache.wicket.markup.head.IHeaderResponse response)
protected void	respond(org.apache.wicket.ajax.AjaxRequestTarget target)
protected void	updateAjaxAttributes(org.apache.wicket.ajax.attributes.AjaxRequestAttributes attributes)

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

findIndicatorId, getAttributes, getCallbackFunction, getCallbackFunctionBody, getCallbackScript, getCallbackScript, getChannel, getFailureScript, getPreconditionScript, getSuccessScript, onBind, onRequest, postprocessConfiguration, renderAjaxAttributes, renderAjaxAttributes

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

afterRender, bind, getCallbackUrl, getComponent, onComponentRendered, onComponentTag, onComponentTag, onUnbind, unbind

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

beforeRender, canCallListenerInterface, detach, getStatelessHint, isEnabled, isTemporary, onConfigure, onEvent, onException, onRemove

Methods inherited from class java.lang.Object

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

Constructor Detail

UrlParametersReceivingBehavior

public UrlParametersReceivingBehavior(org.apache.wicket.Component... components)

Constructor that takes an array of Components which will be added to the AjaxRequestTarget for you when the URL parameters come in.

Parameters:

components - the components you wish to add to the request target when the income of the URL fragment parameters is handled

UrlParametersReceivingBehavior

public UrlParametersReceivingBehavior(Map<String,String> options,
                              org.apache.wicket.Component... components)

Constructor that takes an array of Components which will be added to the AjaxRequestTarget for you when the URL parameters come in.

Parameters:

options - JS options to customize the behavior

components - the components you wish to add to the request target when the income of the URL fragment parameters is handled

Method Detail

renderHead

public void renderHead(org.apache.wicket.Component component,
              org.apache.wicket.markup.head.IHeaderResponse response)

Specified by:

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

Overrides:

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

respond

protected void respond(org.apache.wicket.ajax.AjaxRequestTarget target)

Specified by:

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

updateAjaxAttributes

protected void updateAjaxAttributes(org.apache.wicket.ajax.attributes.AjaxRequestAttributes attributes)

Overrides:

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

onParameterArrival

protected abstract void onParameterArrival(org.apache.wicket.request.IRequestParameters requestParameters,
                      org.apache.wicket.ajax.AjaxRequestTarget target)

Hook for evaluating the request parameters when they come in.

Parameters:

requestParameters - use this to obtain the values of your URL fragment parameters

target - use this like in any other ajax callback

getJS

protected static org.apache.wicket.markup.head.HeaderItem getJS(Class<?> scope)

Returns the HeaderItem representing the JavaScript library used to read and write URL fragment parameters.

Parameters:

scope - the scope of the PackageResourceReference

Returns: