JavaScript: The Definitive Guide, Fourth Edition

Name

MouseEvent.initMouseEvent( ) — initialize the properties of a MouseEvent object

Availability

DOM Level 2 Events

Synopsis

void initMouseEvent(String typeArg,
                    boolean canBubbleArg, 
                    boolean cancelableArg, 
                    AbstractView viewArg, 
                    long detailArg,
                    long screenXArg, 
                    long screenYArg, 
                    long clientXArg, 
                    long clientYArg, 
                    boolean ctrlKeyArg, 
                    boolean altKeyArg, 
                    boolean shiftKeyArg, 
                    boolean metaKeyArg, 
                    unsigned short buttonArg, 
                    EventTarget relatedTargetArg);

Arguments

The many arguments to this method specify the initial values of the properties of this MouseEvent object, including the properties inherited from the Event and UIEvent interfaces. The name of each argument clearly indicates the property for which it specifies the value, so they are not listed individually here.

Description

This method initializes the various properties of a newly created MouseEvent object. It may be called only on a MouseEvent object created with Document.createEvent( ) and only before that MouseEvent is passed to EventTarget.dispatchEvent( ).