JavaScript: The Definitive Guide, Fourth Edition

Name

EventTarget.dispatchEvent( ) — dispatch a synthetic event to this node

Availability

DOM Level 2 Events

Synopsis

boolean dispatchEvent(Event evt) 
    throws EventException;

Arguments

evt

The Event object to be dispatched.

Returns

false if the preventDefault( ) method of evt was called at any time during the propagation of the event, or true otherwise.

Throws

This method throws an EventException with its code property set to EventException.UNSPECIFIED_EVENT_TYPE_ERR if the Event object evt was not initialized or if its type property was null or the empty string.

Description

This method dispatches a synthetic event created with Document.createEvent( ) and initialized with the initialization method defined by the Event interface or one of its subinterfaces. The node on which this method is called becomes the target of the event, but the event first propagates down the document tree during the capturing phase, and then, if the bubbles property of the event is true, it bubbles up the document tree after being handled at the event target itself.

See Also

Document.createEvent( ), Event.initEvent( ), MouseEvent.initMouseEvent( )