com.gargoylesoftware.htmlunit.javascript.host.event

Class EventListenersContainer

java.lang.Object

com.gargoylesoftware.htmlunit.javascript.host.event.EventListenersContainer

All Implemented Interfaces:

Serializable

public class EventListenersContainer
extends Object
implements Serializable

Container for event listener.

Author:

Marc Guillemot, Daniel Gredler, Ahmed Ashour, Frank Danek, Ronald Brill

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EventListenersContainer(EventTarget jsNode) The constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addEventListener(String type, net.sourceforge.htmlunit.corejs.javascript.Scriptable listener, boolean useCapture) Adds an event listener.
void	copyFrom(EventListenersContainer eventListenersContainer) Copies all the events from the provided container.
ScriptResult	executeBubblingListeners(Event event, Object[] args, Object[] propHandlerArgs) Executes bubbling listeners.
ScriptResult	executeCapturingListeners(Event event, Object[] args) Executes capturing listeners.
ScriptResult	executeListeners(Event event, Object[] args, Object[] propHandlerArgs) Executes listeners.
net.sourceforge.htmlunit.corejs.javascript.Function	getEventHandler(String eventName) Gets an event handler.
Object	getEventHandlerProp(String eventType) Returns event handler property.
List<net.sourceforge.htmlunit.corejs.javascript.Scriptable>	getHandlers(String eventType, boolean useCapture) Returns the relevant handlers.
boolean	hasEventHandlers(String eventType) Returns true if there are any event handlers for the specified event.
void	removeEventListener(String eventType, net.sourceforge.htmlunit.corejs.javascript.Scriptable listener, boolean useCapture) Removes event listener.
void	setEventHandlerProp(String eventName, Object value) Sets the handler property (with an handler or something else).
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

EventListenersContainer

public EventListenersContainer(EventTarget jsNode)

The constructor.

Parameters:

jsNode - the node.

Method Detail

addEventListener

public boolean addEventListener(String type,
                       net.sourceforge.htmlunit.corejs.javascript.Scriptable listener,
                       boolean useCapture)

Adds an event listener.

Parameters:

type - the event type to listen for (like "load")

listener - the event listener

useCapture - If true, indicates that the user wishes to initiate capture (not yet implemented)

Returns:

true if the listener has been added

getHandlers

public List<net.sourceforge.htmlunit.corejs.javascript.Scriptable> getHandlers(String eventType,
                                                                      boolean useCapture)

Returns the relevant handlers.

Parameters:

eventType - the event type

useCapture - whether to use capture of not

Returns:

the handlers list

removeEventListener

public void removeEventListener(String eventType,
                       net.sourceforge.htmlunit.corejs.javascript.Scriptable listener,
                       boolean useCapture)

Removes event listener.

Parameters:

eventType - the type

listener - the listener

useCapture - to use capture or not

setEventHandlerProp

public void setEventHandlerProp(String eventName,
                       Object value)

Sets the handler property (with an handler or something else).

Parameters:

eventName - the event name (like "click")

value - the new property

getEventHandlerProp

public Object getEventHandlerProp(String eventType)

Returns event handler property.

Parameters:

eventType - event type

Returns:

the handler, or null if not found

executeBubblingListeners

public ScriptResult executeBubblingListeners(Event event,
                                    Object[] args,
                                    Object[] propHandlerArgs)

Executes bubbling listeners.

Parameters:

event - the event

args - arguments

propHandlerArgs - handler arguments

Returns:

the result

executeCapturingListeners

public ScriptResult executeCapturingListeners(Event event,
                                     Object[] args)

Executes capturing listeners.

Parameters:

event - the event

args - the arguments

Returns:

the result

getEventHandler

public net.sourceforge.htmlunit.corejs.javascript.Function getEventHandler(String eventName)

Gets an event handler.

Parameters:

eventName - the event name (e.g. "click")

Returns:

the handler function, null if the property is null or not a function

hasEventHandlers

public boolean hasEventHandlers(String eventType)

Returns true if there are any event handlers for the specified event.

Parameters:

eventType - the event type (e.g. "click")

Returns:

true if there are any event handlers for the specified event, false otherwise

executeListeners

public ScriptResult executeListeners(Event event,
                            Object[] args,
                            Object[] propHandlerArgs)

Executes listeners.

Parameters:

event - the event

args - the arguments

propHandlerArgs - handler arguments

Returns:

the result

copyFrom

public void copyFrom(EventListenersContainer eventListenersContainer)

Copies all the events from the provided container.

Parameters:

eventListenersContainer - where to copy from

toString

public String toString()

Overrides:

toString in class Object