public interface IAjaxCallListener
Each method can return JavaScript that will be used as a body of a function that is executed
at the appropriate time. If the method returns null
or an empty string then it is ignored
and no function will be executed for this listener. Each JavaScript function receives arguments
in the exact order as specified in the method's javadoc.
Ajax call listeners are potential contributors to the page header by implementing
IComponentAwareHeaderContributor
. E.g. the JavaScript used
by the listener may depend on some JavaScript library, by implementing
IComponentAwareHeaderContributor
interface they can assure
it will be loaded.
Modifier and Type | Method and Description |
---|---|
CharSequence |
getAfterHandler(Component component)
The JavaScript that will be executed after the Ajax call.
|
CharSequence |
getBeforeHandler(Component component)
The JavaScript that will be executed before the Ajax call, as early as possible.
|
CharSequence |
getBeforeSendHandler(Component component)
The JavaScript that will be executed right before the execution of the the Ajax call, only if all
preconditions pass.
|
CharSequence |
getCompleteHandler(Component component)
The JavaScript that will be executed after both successful and unsuccessful return of the
Ajax call.
|
CharSequence |
getFailureHandler(Component component)
The JavaScript that will be executed after unsuccessful return of the Ajax call.
|
CharSequence |
getPrecondition(Component component)
A JavaScript function that is invoked before the request is being executed.
|
CharSequence |
getSuccessHandler(Component component)
The JavaScript that will be executed after successful return of the Ajax call.
|
CharSequence getBeforeHandler(Component component)
component
- the Component with the Ajax behaviorCharSequence getPrecondition(Component component)
false
then the execution of the Ajax call will be cancelled. The script will be
executed in a function that receives the following parameters:
component
- the Component with the Ajax behaviorCharSequence getBeforeSendHandler(Component component)
component
- the Component with the Ajax behaviorCharSequence getAfterHandler(Component component)
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.component
- the Component with the Ajax behaviorCharSequence getSuccessHandler(Component component)
AjaxRequestAttributes.dataType
component
- the Component with the Ajax behaviorCharSequence getFailureHandler(Component component)
component
- the Component with the Ajax behaviorCharSequence getCompleteHandler(Component component)
component
- the Component with the Ajax behaviorCopyright © 2006–2014 Apache Software Foundation. All rights reserved.