com.helger.photon.ajax

Interface IAjaxRegistry

All Superinterfaces:

Serializable

All Known Implementing Classes:

AjaxRegistry

public interface IAjaxRegistry
extends Serializable

Base interface for an AJAX registry. It has a set of IAjaxExecutor instances. See IAjaxInvoker for the interface to implement the execution.
Note: This interface was extracted from IAjaxInvoker in v8.1.4.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
com.helger.commons.collection.impl.ICommonsMap<String,IAjaxFunctionDeclaration>	getAllRegisteredFunctions()
IAjaxFunctionDeclaration	getRegisteredFunction(String sFunctionName) Get the registered AJAX function with the specified name
boolean	isRegisteredFunction(String sFunctionName) Check whether an AJAX function with the given name is present
void	registerFunction(IAjaxFunctionDeclaration aFunction) Add a handler function that is used as a callback.

Method Detail

getAllRegisteredFunctions

@Nonnull
 @ReturnsMutableCopy
com.helger.commons.collection.impl.ICommonsMap<String,IAjaxFunctionDeclaration> getAllRegisteredFunctions()

getRegisteredFunction

@Nullable
IAjaxFunctionDeclaration getRegisteredFunction(@Nullable
                                                          String sFunctionName)

Get the registered AJAX function with the specified name

Parameters:

sFunctionName - The AJAX function name to search. May be null.

Returns:

null if no such AJAX function is registered.

isRegisteredFunction

boolean isRegisteredFunction(@Nullable
                             String sFunctionName)

Check whether an AJAX function with the given name is present

Parameters:

sFunctionName - The name of the AJAX function to check. May be null.

Returns:

true if an AJAX function with the given name is contained, false otherwise.

registerFunction

void registerFunction(@Nonnull
                      IAjaxFunctionDeclaration aFunction)

Add a handler function that is used as a callback.

Parameters:

aFunction - The AJAX function declaration to be invoked. May not be null.