Package com.helger.html.js

Class JSEventMap

java.lang.Object

com.helger.html.js.JSEventMap

All Implemented Interfaces:

Serializable

@NotThreadSafe
public class JSEventMap
extends Object
implements Serializable

This class represents a map from an EJSEvent to an IHasJSCode that represents the code. This is mainly meant for managing HTML element JS event handler.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
JSEventMap()

Method Summary

Modifier and Type	Method	Description
void	addHandler(EJSEvent eJSEvent, IHasJSCode aNewHandler)	Add an additional handler for the given JS event.
boolean	containsHandler(EJSEvent eJSEvent)
com.helger.commons.collection.impl.ICommonsMap<EJSEvent,CollectingJSCodeProvider>	getAllEventHandler()
CollectingJSCodeProvider	getHandler(EJSEvent eJSEvent)
void	prependHandler(EJSEvent eJSEvent, IHasJSCode aNewHandler)	Add an additional handler for the given JS event.
com.helger.commons.state.EChange	removeHandler(EJSEvent eJSEvent)
void	setHandler(EJSEvent eJSEvent, IHasJSCode aNewHandler)	Set a handler for the given JS event.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JSEventMap

public JSEventMap()

Method Detail

addHandler

public void addHandler(@Nonnull
                       EJSEvent eJSEvent,
                       @Nonnull
                       IHasJSCode aNewHandler)

Add an additional handler for the given JS event. If an existing handler is present, the new handler is appended at the end.

Parameters:

eJSEvent - The JS event. May not be null.

aNewHandler - The new handler to be added. May not be null.

prependHandler

public void prependHandler(@Nonnull
                           EJSEvent eJSEvent,
                           @Nonnull
                           IHasJSCode aNewHandler)

Add an additional handler for the given JS event. If an existing handler is present, the new handler is appended at front.

Parameters:

eJSEvent - The JS event. May not be null.

aNewHandler - The new handler to be added. May not be null.

setHandler

public void setHandler(@Nonnull
                       EJSEvent eJSEvent,
                       @Nonnull
                       IHasJSCode aNewHandler)

Set a handler for the given JS event. If an existing handler is present, it is automatically overridden.

Parameters:

eJSEvent - The JS event. May not be null.

aNewHandler - The new handler to be added. May not be null.

removeHandler

@Nonnull
public com.helger.commons.state.EChange removeHandler(@Nullable
                                                      EJSEvent eJSEvent)

getHandler

@Nullable
public CollectingJSCodeProvider getHandler(@Nullable
                                           EJSEvent eJSEvent)

containsHandler

public boolean containsHandler(@Nullable
                               EJSEvent eJSEvent)

getAllEventHandler

@Nonnull
@ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsMap<EJSEvent,CollectingJSCodeProvider> getAllEventHandler()

toString

public String toString()

Overrides:

toString in class Object