org.wicketstuff.jquery.validation

Class AjaxFormComponentValidatorBehaviour

java.lang.Object

org.apache.wicket.behavior.Behavior

org.apache.wicket.behavior.AbstractAjaxBehavior

org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

org.apache.wicket.ajax.AjaxEventBehavior

org.apache.wicket.ajax.form.AjaxFormComponentUpdatingBehavior

org.wicketstuff.jquery.validation.AjaxFormComponentValidatorBehaviour

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 class AjaxFormComponentValidatorBehaviour
extends org.apache.wicket.ajax.form.AjaxFormComponentUpdatingBehavior

Ajax validation behaviour that triggers when the selected event is fired. The default action is to add a css class to the parent element of the component and add any error messages in a span directly after the component. You can change this behaviour by overriding getErrorJavascript(). By default it uses JQuery to do the markup manipulation. You can either skip jquery or load another library by overriding the renderHead method. This behaviour will also update the model object when the selected client side event fires.

Author:

Edvin Syse

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ERROR_COMPONENT_CLASS
static String	ERROR_MESSAGE_CLASS

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
AjaxFormComponentValidatorBehaviour()
AjaxFormComponentValidatorBehaviour(String event)

Method Summary

Methods

Modifier and Type	Method and Description
protected String	getErrorJavascript() Returns the javascript that will manipulate the markup to show the error message.
protected String	getErrorSeparator() The error separator is used to differentiate each error-message in case a component has more than one error message Defaults to separating using a tag.
protected String	getRemovePreviousErrorsScript() Javascript used to remove previously shown error messages.
protected void	onError(org.apache.wicket.ajax.AjaxRequestTarget target, RuntimeException e) Adds the error-javascript to the response since the component has errors.
protected void	onUpdate(org.apache.wicket.ajax.AjaxRequestTarget target) When the component renders, onUpdate will remove the markup containing any previous error-message.
void	renderHead(org.apache.wicket.Component component, org.apache.wicket.markup.head.IHeaderResponse response) Add the JQuery library so we can use it in the onError method to manipulate the markup.

Methods inherited from class org.apache.wicket.ajax.form.AjaxFormComponentUpdatingBehavior

checkComponent, disableFocusOnBlur, getFormComponent, getUpdateModel, onBind, onEvent, updateAjaxAttributes

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

getEvent, onCheckEvent, respond

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

findIndicatorId, getAttributes, getCallbackFunction, getCallbackFunctionBody, getCallbackScript, getCallbackScript, getChannel, getFailureScript, getPreconditionScript, getSuccessScript, 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

Field Detail

ERROR_COMPONENT_CLASS

public static final String ERROR_COMPONENT_CLASS

See Also:

Constant Field Values

ERROR_MESSAGE_CLASS

public static final String ERROR_MESSAGE_CLASS

See Also:

Constant Field Values

Constructor Detail

AjaxFormComponentValidatorBehaviour

public AjaxFormComponentValidatorBehaviour()

AjaxFormComponentValidatorBehaviour

public AjaxFormComponentValidatorBehaviour(String event)

Method Detail

onUpdate

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

When the component renders, onUpdate will remove the markup containing any previous error-message.

Specified by:

onUpdate in class org.apache.wicket.ajax.form.AjaxFormComponentUpdatingBehavior

Parameters:

target -

getRemovePreviousErrorsScript

protected String getRemovePreviousErrorsScript()

Javascript used to remove previously shown error messages.

Returns:

onError

protected void onError(org.apache.wicket.ajax.AjaxRequestTarget target,
           RuntimeException e)

Adds the error-javascript to the response since the component has errors.

Overrides:

onError in class org.apache.wicket.ajax.form.AjaxFormComponentUpdatingBehavior

Parameters:

target - The AjaxRequestTarget you can add components to

e - The exception if any

getErrorJavascript

protected String getErrorJavascript()

Returns the javascript that will manipulate the markup to show the error message. Defaults to adding a CSS-class to the parent element (nice if you add a

or

around your label/component)

Returns:

getErrorSeparator

protected String getErrorSeparator()

The error separator is used to differentiate each error-message in case a component has more than one error message Defaults to separating using a
tag.

Returns:

the markup for separating multiple error message

renderHead

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

Add the JQuery library so we can use it in the onError method to manipulate the markup.

Specified by:

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

Overrides:

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

Parameters:

response -