com.helger.photon.ajax

Class AjaxRegistry

java.lang.Object

com.helger.photon.ajax.AjaxRegistry

All Implemented Interfaces:

IAjaxRegistry, Serializable

@ThreadSafe
public class AjaxRegistry
extends Object
implements IAjaxRegistry

The default implementation of IAjaxRegistry.

Since:

8.1.4

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AjaxRegistry()

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
static boolean	isValidFunctionName(String sFunctionName)
void	registerFunction(IAjaxFunctionDeclaration aFunctionDeclaration) Add a handler function that is used as a callback.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AjaxRegistry

public AjaxRegistry()

Method Detail

isValidFunctionName

public static boolean isValidFunctionName(@Nullable
                                          String sFunctionName)

getAllRegisteredFunctions

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

Specified by:

getAllRegisteredFunctions in interface IAjaxRegistry

getRegisteredFunction

@Nullable
public IAjaxFunctionDeclaration getRegisteredFunction(@Nullable
                                                                 String sFunctionName)

Description copied from interface: IAjaxRegistry

Get the registered AJAX function with the specified name

Specified by:

getRegisteredFunction in interface IAjaxRegistry

Parameters:

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

Returns:

null if no such AJAX function is registered.

isRegisteredFunction

public boolean isRegisteredFunction(@Nullable
                                    String sFunctionName)

Description copied from interface: IAjaxRegistry

Check whether an AJAX function with the given name is present

Specified by:

isRegisteredFunction in interface IAjaxRegistry

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

public void registerFunction(@Nonnull
                             IAjaxFunctionDeclaration aFunctionDeclaration)

Description copied from interface: IAjaxRegistry

Add a handler function that is used as a callback.

Specified by:

registerFunction in interface IAjaxRegistry

Parameters:

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

toString

public String toString()

Overrides:

toString in class Object