com.neurosys.site.wicket.behaviors

Class FieldAjaxEventBehavior

java.lang.Object

org.apache.wicket.behavior.AbstractBehavior

org.apache.wicket.behavior.AbstractAjaxBehavior

org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

org.apache.wicket.ajax.AjaxEventBehavior

com.neurosys.site.wicket.behaviors.FieldAjaxEventBehavior

All Implemented Interfaces:

Serializable, org.apache.wicket.ajax.markup.html.IAjaxLink, 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:

EditorAjaxSaveBehavior

public abstract class FieldAjaxEventBehavior
extends org.apache.wicket.ajax.AjaxEventBehavior
implements org.apache.wicket.ajax.markup.html.IAjaxLink

Allow to provide custom, action & response on field level events. Similar to creating Web-Service based AJAX methods, except instead of defining a separate Web Service layer + Security, we can let Wicket wrap the AJAX and handle AJAX requests and service each field independently without needing a Form Submit or Ajax form submit.

Simply override and add this IBehavior to any component. You can also make the component invisible and make it as a proxy trigger; so other custom/pure JavaScript components can call this say via a JQuery .trigger() and put in custom info in the onClick of this component before it is triggered. This way, it can also act like a Bridge for non Wicket Java-Script components to submit info to Wicket AJAX.

Author:

Arjun Dhar

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
FieldAjaxEventBehavior(String event, Map<String,String> idMap, Map<String,String> valueMap)

Method Summary

Modifier and Type	Method and Description
protected CharSequence	decorateCallbackUrl(CharSequence callbackUrl) Decorate CallbackUrl : This is the script executed when the AJAX call is made to Wicket on the server.
protected abstract String	eventAction(org.apache.wicket.ajax.AjaxRequestTarget target, Map<String,String[]> paramMap) The action to take on a valid request with its request Parameter Map included
protected void	eventFailure(org.apache.wicket.ajax.AjaxRequestTarget target, Map<String,String[]> paramMap) The action to be taken in-case there was some fault in the AJAX request
protected org.apache.wicket.ajax.IAjaxCallDecorator	getAjaxCallDecorator()
protected CharSequence	getBody() The part of the callback URL that can carry back data from the client
protected CharSequence	getCallbackScript(boolean onlyTargetActivePage)
CharSequence	getCallbackUrl(boolean onlyTargetActivePage) The Script that is called when the button is clicked to relay info back to the Server via Ajax
org.apache.wicket.ajax.IAjaxCallDecorator	getCallDecorator()
Map<String,String>	getIdMap()
Map<String,String>	getValueMap()
boolean	isPost()
void	onClick(org.apache.wicket.ajax.AjaxRequestTarget target)
protected void	onEvent(org.apache.wicket.ajax.AjaxRequestTarget target) Server handler code, that is executed after {@link this#getCallbackUrl(boolean) executes on client
FieldAjaxEventBehavior	setCallDecorator(org.apache.wicket.ajax.IAjaxCallDecorator callDecorator)
void	setIdMap(Map<String,String> idMap)
FieldAjaxEventBehavior	setPost(boolean post)
void	setValueMap(Map<String,String> valueMap)

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

generateCallbackScript, getEvent, getEventHandler, onCheckEvent, onComponentTag, respond, setThrottleDelay

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

findIndicatorId, getCallbackScript, getChannelName, getFailureScript, getPreconditionScript, getSuccessScript, onBind, onRequest, renderHead, throttleScript

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

bind, getCallbackUrl, getComponent, getImplementationId, getStatelessHint, onComponentRendered, 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

FieldAjaxEventBehavior

public FieldAjaxEventBehavior(String event,
                              Map<String,String> idMap,
                              Map<String,String> valueMap)

Parameters:

event - as String JavaScript Event Name

idMap - as Map of params that identify the field uniquely

valueMap - as Map of values associated with the field

Method Detail

getCallbackUrl

public final CharSequence getCallbackUrl(boolean onlyTargetActivePage)

The Script that is called when the button is clicked to relay info back to the Server via Ajax

Overrides:

getCallbackUrl in class org.apache.wicket.behavior.AbstractAjaxBehavior

getCallbackScript

protected final CharSequence getCallbackScript(boolean onlyTargetActivePage)

Overrides:

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

onEvent

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

Server handler code, that is executed after {@link this#getCallbackUrl(boolean) executes on client

Specified by:

onEvent in class org.apache.wicket.ajax.AjaxEventBehavior

onClick

public void onClick(org.apache.wicket.ajax.AjaxRequestTarget target)

Specified by:

onClick in interface org.apache.wicket.ajax.markup.html.IAjaxLink

getAjaxCallDecorator

protected final org.apache.wicket.ajax.IAjaxCallDecorator getAjaxCallDecorator()

Overrides:

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

eventAction

protected abstract String eventAction(org.apache.wicket.ajax.AjaxRequestTarget target,
                                      Map<String,String[]> paramMap)

The action to take on a valid request with its request Parameter Map included

Parameters:

target -

Returns:

String as response (null if all ok, else one can put a script or message)

eventFailure

protected void eventFailure(org.apache.wicket.ajax.AjaxRequestTarget target,
                            Map<String,String[]> paramMap)

The action to be taken in-case there was some fault in the AJAX request

Parameters:

target -

decorateCallbackUrl

protected CharSequence decorateCallbackUrl(CharSequence callbackUrl)

Decorate CallbackUrl : This is the script executed when the AJAX call is made to Wicket on the server. This adds a PARAM_ID=paramId&PARAM_VALUE={paramValue} ; using idMap

Gets called during the rendering of the component. Post render this code will have no effect so any params decorated will remain the way they are.

Parameters:

callbackUrl -

Returns:

getBody

protected CharSequence getBody()

The part of the callback URL that can carry back data from the client

See Also:

decorateCallbackUrl(CharSequence)

getCallDecorator

public org.apache.wicket.ajax.IAjaxCallDecorator getCallDecorator()

setCallDecorator

public FieldAjaxEventBehavior setCallDecorator(org.apache.wicket.ajax.IAjaxCallDecorator callDecorator)

isPost

public boolean isPost()

Returns:

post

Default value:

false

setPost

public FieldAjaxEventBehavior setPost(boolean post)

Parameters:

post -

Default value:

false

getIdMap

public Map<String,String> getIdMap()

setIdMap

public void setIdMap(Map<String,String> idMap)

getValueMap

public Map<String,String> getValueMap()

setValueMap

public void setValueMap(Map<String,String> valueMap)