Package org.apache.wicket.ajax.attributes

Class AjaxCallListener

java.lang.Object

org.apache.wicket.ajax.attributes.AjaxCallListener

All Implemented Interfaces:

java.io.Serializable, IAjaxCallListener, IComponentAwareHeaderContributor, org.apache.wicket.util.io.IClusterable

Direct Known Subclasses:

CancelEventIfAjaxListener

public class AjaxCallListener
extends java.lang.Object
implements IAjaxCallListener, IComponentAwareHeaderContributor

An adapter for implementations of IAjaxCallListener.

Since:

6.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
AjaxCallListener()

Method Summary

Modifier and Type	Method	Description
java.lang.CharSequence	getAfterHandler(Component component)	The JavaScript that will be executed after the Ajax call.
java.lang.CharSequence	getBeforeHandler(Component component)	The JavaScript that will be executed before the Ajax call, as early as possible.
java.lang.CharSequence	getBeforeSendHandler(Component component)	The JavaScript that will be executed right before the execution of the the Ajax call, only if all preconditions pass.
java.lang.CharSequence	getCompleteHandler(Component component)	The JavaScript that will be executed after both successful and unsuccessful return of the Ajax call.
java.lang.CharSequence	getDoneHandler(Component component)	The JavaScript that will be executed after the Ajax call is done, regardless whether it was sent or not.
java.lang.CharSequence	getFailureHandler(Component component)	The JavaScript that will be executed after unsuccessful return of the Ajax call.
java.lang.CharSequence	getInitHandler(Component component)	The JavaScript that will be executed on initialization of the Ajax call, immediately after the causing event.
java.lang.CharSequence	getPrecondition(Component component)	A JavaScript function that is invoked before the request is being executed.
java.lang.CharSequence	getSuccessHandler(Component component)	The JavaScript that will be executed after successful return of the Ajax call.
AjaxCallListener	onAfter(java.lang.CharSequence after)	Sets the JavaScript code that will be returned by getAfterHandler(Component).
AjaxCallListener	onBefore(java.lang.CharSequence before)	Sets the JavaScript code that will be returned by getBeforeHandler(Component).
AjaxCallListener	onBeforeSend(java.lang.CharSequence beforeSend)	Sets the JavaScript code that will be returned by getBeforeSendHandler(Component).
AjaxCallListener	onComplete(java.lang.CharSequence complete)	Sets the JavaScript code that will be returned by getCompleteHandler(Component).
AjaxCallListener	onDone(java.lang.CharSequence done)	Sets the JavaScript code that will be returned by getDoneHandler(Component).
AjaxCallListener	onFailure(java.lang.CharSequence failure)	Sets the JavaScript code that will be returned by getFailureHandler(Component).
AjaxCallListener	onInit(java.lang.CharSequence init)	Sets the JavaScript code that will be returned by getInitHandler(Component).
AjaxCallListener	onPrecondition(java.lang.CharSequence precondition)	Sets the JavaScript code that will be returned by getPrecondition(Component).
AjaxCallListener	onSuccess(java.lang.CharSequence success)	Sets the JavaScript code that will be returned by getSuccessHandler(Component).
void	renderHead(Component component, IHeaderResponse response)	Render to the web response whatever the component-aware wants to contribute to the head section.

Methods inherited from class java.lang.Object

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

Constructor Detail

AjaxCallListener

public AjaxCallListener()

Method Detail

onInit

public AjaxCallListener onInit(java.lang.CharSequence init)

Sets the JavaScript code that will be returned by getInitHandler(Component). If this code was already set, the new one will be appended to the existing one.

Parameters:

init - the JavaScript code for the corresponding handler

Returns:

This

onDone

public AjaxCallListener onDone(java.lang.CharSequence done)

Sets the JavaScript code that will be returned by getDoneHandler(Component). If this code was already set, the new one will be appended to the existing one.

Parameters:

init - the JavaScript code for the corresponding handler

Returns:

This

onBefore

public AjaxCallListener onBefore(java.lang.CharSequence before)

Sets the JavaScript code that will be returned by getBeforeHandler(Component). If this code was already set, the new one will be appended to the existing one.

Parameters:

before - the JavaScript code for the corresponding handler

Returns:

This

onBeforeSend

public AjaxCallListener onBeforeSend(java.lang.CharSequence beforeSend)

Sets the JavaScript code that will be returned by getBeforeSendHandler(Component). If this code was already set, the new one will be appended to the existing one.

Parameters:

beforeSend - the JavaScript code for the corresponding handler

Returns:

This

onAfter

public AjaxCallListener onAfter(java.lang.CharSequence after)

Sets the JavaScript code that will be returned by getAfterHandler(Component). If this code was already set, the new one will be appended to the existing one.

Parameters:

after - the JavaScript code for the corresponding handler

Returns:

This

onSuccess

public AjaxCallListener onSuccess(java.lang.CharSequence success)

Sets the JavaScript code that will be returned by getSuccessHandler(Component). If this code was already set, the new one will be appended to the existing one.

Parameters:

success - the JavaScript code for the corresponding handler

Returns:

This

onFailure

public AjaxCallListener onFailure(java.lang.CharSequence failure)

Sets the JavaScript code that will be returned by getFailureHandler(Component). If this code was already set, the new one will be appended to the existing one.

Parameters:

failure - the JavaScript code for the corresponding handler

Returns:

This

onComplete

public AjaxCallListener onComplete(java.lang.CharSequence complete)

Sets the JavaScript code that will be returned by getCompleteHandler(Component). If this code was already set, the new one will be appended to the existing one.

Parameters:

complete - the JavaScript code for the corresponding handler

Returns:

This

onPrecondition

public AjaxCallListener onPrecondition(java.lang.CharSequence precondition)

Sets the JavaScript code that will be returned by getPrecondition(Component). If this code was already set, the new one will be appended to the existing one.

Parameters:

precondition - the JavaScript code for the precondition

Returns:

This

getSuccessHandler

public java.lang.CharSequence getSuccessHandler(Component component)

Description copied from interface: IAjaxCallListener

The JavaScript that will be executed after successful return of the Ajax call. The script will be executed in a function that receives the following parameters:

1. attrs - the AjaxRequestAttributes as JSON
2. jqXHR - the jQuery XMLHttpRequest object
3. data - the Ajax response. Its type depends on AjaxRequestAttributes.dataType
4. textStatus - the status as text

Specified by:

getSuccessHandler in interface IAjaxCallListener

Parameters:

component - the Component with the Ajax behavior

Returns:

the JavaScript that will be executed after a successful return of the Ajax call.

getFailureHandler

public java.lang.CharSequence getFailureHandler(Component component)

Description copied from interface: IAjaxCallListener

The JavaScript that will be executed after unsuccessful return of the Ajax call. The script will be executed in a function that receives the following parameters:

1. attrs - the AjaxRequestAttributes as JSON
2. jqXHR - the jQuery XMLHttpRequest object
3. errorMessage - in case of HTTP error the textual portion of the HTTP status
4. textStatus - type of failure: null, "timeout", "error", "abort" or "parsererror"

Specified by:

getFailureHandler in interface IAjaxCallListener

Parameters:

component - the Component with the Ajax behavior

Returns:

the JavaScript that will be executed after a unsuccessful return of the Ajax call.

getInitHandler

public java.lang.CharSequence getInitHandler(Component component)

Description copied from interface: IAjaxCallListener

The JavaScript that will be executed on initialization of the Ajax call, immediately after the causing event. The script will be executed in a function that receives the following parameters:

1. attrs - the AjaxRequestAttributes as JSON

Specified by:

getInitHandler in interface IAjaxCallListener

Parameters:

component - the Component with the Ajax behavior

Returns:

the JavaScript that will be executed on initialization of the Ajax call.

getBeforeHandler

public java.lang.CharSequence getBeforeHandler(Component component)

Description copied from interface: IAjaxCallListener

The JavaScript that will be executed before the Ajax call, as early as possible. Even before the preconditions. The script will be executed in a function that receives the following parameters:

1. attrs - the AjaxRequestAttributes as JSON

Specified by:

getBeforeHandler in interface IAjaxCallListener

Parameters:

component - the Component with the Ajax behavior

Returns:

the JavaScript that will be executed before the Ajax call.

getBeforeSendHandler

public java.lang.CharSequence getBeforeSendHandler(Component component)

Description copied from interface: IAjaxCallListener

The JavaScript that will be executed right before the execution of the the Ajax call, only if all preconditions pass. The script will be executed in a function that receives the following parameters:

1. attrs - the AjaxRequestAttributes as JSON
2. jqXHR - the jQuery XMLHttpRequest object
3. settings - the settings used for the jQuery.ajax() call

Specified by:

getBeforeSendHandler in interface IAjaxCallListener

Parameters:

component - the Component with the Ajax behavior

Returns:

the JavaScript that will be executed before the Ajax call.

getAfterHandler

public java.lang.CharSequence getAfterHandler(Component component)

Description copied from interface: IAjaxCallListener

The JavaScript that will be executed after the Ajax call. The script will be executed in a function that receives the following parameters:

1. attrs - the AjaxRequestAttributes as JSON

Note: if the Ajax call is synchronous (see AjaxRequestAttributes.setAsynchronous(boolean)) then this JavaScript will be executed after the complete handler, otherwise it is executed right after the execution of the Ajax request.

Specified by:

getAfterHandler in interface IAjaxCallListener

Parameters:

component - the Component with the Ajax behavior

Returns:

the JavaScript that will be executed after the start of the Ajax call but before its response is returned.

getCompleteHandler

public java.lang.CharSequence getCompleteHandler(Component component)

Description copied from interface: IAjaxCallListener

The JavaScript that will be executed after both successful and unsuccessful return of the Ajax call. The script will be executed in a function that receives the following parameters:

1. attrs - the AjaxRequestAttributes as JSON
2. jqXHR - the jQuery XMLHttpRequest object
3. textStatus - the status as text

Specified by:

getCompleteHandler in interface IAjaxCallListener

Parameters:

component - the Component with the Ajax behavior

Returns:

the JavaScript that will be executed after both successful and unsuccessful return of the Ajax call.

getPrecondition

public java.lang.CharSequence getPrecondition(Component component)

Description copied from interface: IAjaxCallListener

A JavaScript function that is invoked before the request is being executed. If it returns false then the execution of the Ajax call will be cancelled. The script will be executed in a function that receives the following parameters:

1. attrs - the AjaxRequestAttributes as JSON

Specified by:

getPrecondition in interface IAjaxCallListener

Parameters:

component - the Component with the Ajax behavior

Returns:

the JavaScript that should be used to decide whether the Ajax call should be made at all.

getDoneHandler

public java.lang.CharSequence getDoneHandler(Component component)

Description copied from interface: IAjaxCallListener

The JavaScript that will be executed after the Ajax call is done, regardless whether it was sent or not. The script will be executed in a function that receives the following parameters:

1. attrs - the AjaxRequestAttributes as JSON

Specified by:

getDoneHandler in interface IAjaxCallListener

Parameters:

component - the Component with the Ajax behavior

Returns:

the JavaScript that will be executed after the Ajax call is done.

renderHead

public void renderHead(Component component,
                       IHeaderResponse response)

Description copied from interface: IComponentAwareHeaderContributor

Render to the web response whatever the component-aware wants to contribute to the head section.

Specified by:

renderHead in interface IComponentAwareHeaderContributor

Parameters:

component - component which is contributing to the response. This parameter is here to give the component as the context for component-awares implementing this interface

response - Response object