com.gargoylesoftware.htmlunit.javascript.host.event

Class EventTarget

java.lang.Object

net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

com.gargoylesoftware.htmlunit.javascript.HtmlUnitScriptable

com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

com.gargoylesoftware.htmlunit.javascript.host.event.EventTarget

All Implemented Interfaces:

Serializable, Cloneable, net.sourceforge.htmlunit.corejs.javascript.ConstProperties, net.sourceforge.htmlunit.corejs.javascript.debug.DebuggableObject, net.sourceforge.htmlunit.corejs.javascript.Scriptable

Direct Known Subclasses:

ApplicationCache, AudioContext, AudioNode, BatteryManager, BroadcastChannel, DOMRequest, EventSource, FileReader, FontFaceSet, IDBDatabase, IDBMutableFile, IDBRequest, IDBTransaction, MediaDevices, MediaKeySession, MediaQueryList, MediaRecorder, MediaSource, MediaStream, MediaStreamTrack, MessagePort, MIDIAccess, MIDIPort, mozRTCPeerConnection, Node, Notification, Performance, PermissionStatus, RTCPeerConnection, ScreenOrientation, ServiceWorker, ServiceWorkerContainer, ServiceWorkerRegistration, SharedWorker, SourceBuffer, SourceBufferList, SpeechSynthesis, SpeechSynthesisUtterance, TextTrack, TextTrackCue, TextTrackList, webkitMediaStream, webkitRTCPeerConnection, webkitSpeechRecognition, WebSocket, Window, Worker, XMLHttpRequest, XMLHttpRequestEventTarget

public class EventTarget
extends SimpleScriptable

A JavaScript object for EventTarget.

Author:

Ahmed Ashour

See Also:

Serialized Form

Field Summary

Fields inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface net.sourceforge.htmlunit.corejs.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
EventTarget() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addEventListener(String type, net.sourceforge.htmlunit.corejs.javascript.Scriptable listener, boolean useCapture) Allows the registration of event listeners on the event target.
protected void	clearEventListenersContainer() Clears the event listener container.
boolean	dispatchEvent(Event event) Dispatches an event into the event system (standards-conformant browsers only).
ScriptResult	executeEventLocally(Event event) Executes the event on this object only (needed for instance for onload on (i)frame tags).
ScriptResult	fireEvent(Event event) Fires the event on the node with capturing and bubbling phase.
net.sourceforge.htmlunit.corejs.javascript.Function	getEventHandler(String eventName) Returns the specified event handler.
protected Object	getEventHandlerProp(String eventName) Gets the property defined as event handler (not necessary a Function if something else has been set).
EventListenersContainer	getEventListenersContainer() Gets the container for event listeners.
boolean	hasEventHandlers(String eventName) Returns true if there are any event handlers for the specified event.
void	removeEventListener(String type, net.sourceforge.htmlunit.corejs.javascript.Scriptable listener, boolean useCapture) Allows the removal of event listeners on the event target.
void	setEventHandler(String eventName, net.sourceforge.htmlunit.corejs.javascript.Function eventHandler) Defines an event handler.
protected void	setEventHandlerProp(String eventName, Object value) Defines an event handler (or maybe any other object).

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

clone, equivalentValues, get, getBrowserVersion, getDefaultValue, getDomNodeOrDie, getDomNodeOrNull, getPrototype, getScriptableFor, getStartingScope, getWindow, getWindow, getWithPreemption, has, hasInstance, initParentScope, isReadOnlySettable, makeScriptableFor, setCaseSensitive, setDomNode, setDomNode, setHtmlElement

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.HtmlUnitScriptable

defineFunctionProperties, defineProperty, getClassName, setClassName, setParentScope

Methods inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getSlot, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setPrototype, size

Methods inherited from class java.lang.Object

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

Constructor Detail

EventTarget

public EventTarget()

Default constructor.

Method Detail

addEventListener

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

Allows the registration of event listeners on the event target.

Parameters:

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

listener - the event listener

useCapture - If true, indicates that the user wishes to initiate capture

See Also:

Mozilla documentation

getEventListenersContainer

public EventListenersContainer getEventListenersContainer()

Gets the container for event listeners.

Returns:

the container (newly created if needed)

executeEventLocally

public ScriptResult executeEventLocally(Event event)

Executes the event on this object only (needed for instance for onload on (i)frame tags).

Parameters:

event - the event

Returns:

the result

See Also:

fireEvent(Event)

fireEvent

public ScriptResult fireEvent(Event event)

Fires the event on the node with capturing and bubbling phase.

Parameters:

event - the event

Returns:

the result

hasEventHandlers

public boolean hasEventHandlers(String eventName)

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

Parameters:

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

Returns:

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

getEventHandler

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

Returns the specified event handler.

Parameters:

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

Returns:

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

getEventHandlerProp

protected Object getEventHandlerProp(String eventName)

Gets the property defined as event handler (not necessary a Function if something else has been set).

Parameters:

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

Returns:

the property

dispatchEvent

public boolean dispatchEvent(Event event)

Dispatches an event into the event system (standards-conformant browsers only). See the Gecko DOM reference for more information.

Parameters:

event - the event to be dispatched

Returns:

false if at least one of the event handlers which handled the event called preventDefault; true otherwise

removeEventListener

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

Allows the removal of event listeners on the event target.

Parameters:

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

listener - the event listener

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

See Also:

Mozilla documentation

setEventHandlerProp

protected void setEventHandlerProp(String eventName,
                       Object value)

Defines an event handler (or maybe any other object).

Parameters:

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

value - the property (null to reset it)

setEventHandler

public void setEventHandler(String eventName,
                   net.sourceforge.htmlunit.corejs.javascript.Function eventHandler)

Defines an event handler.

Parameters:

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

eventHandler - the handler (null to reset it)

clearEventListenersContainer

protected void clearEventListenersContainer()

Clears the event listener container.