Class MouseEvent

The MouseEvent interface provides specific contextual information associated with Mouse events.

Extends

UIEvent

Members Table

The following table lists the members exposed by the MouseEvent object.

Show inherited members (marked with *)

Show: Properties Methods

Attribute Description Property Type Readonly Description $pseudoTarget * HTMLElement false Keeps the reference to pseudo element where event originated. altKey Boolean true Used to indicate whether the 'alt' key was depressed during the firing of the event. On some platforms this key may map to an alternative key name. bubbles * Boolean true Used to indicate whether or not an event is a bubbling event. button Number true During mouse events caused by the depression or release of a mouse button, button is used to indicate which mouse button changed state. The values for button range from zero to indicate the left button of the mouse, one to indicate the middle button if present, and two to indicate the right button. For mice configured for left handed use in which the button actions are reversed the values are instead read from right to left. Acceptable values: Value Description 0 Left mouse button was pressed. 1 Middle mouse button was pressed. 2 Right mouse button was pressed. cancelable * Boolean true Used to indicate whether or not an event can have its default action prevented. clientX Number true The horizontal coordinate at which the event occurred relative to the DOM implementation's client area. clientY Number true The vertical coordinate at which the event occurred relative to the DOM implementation's client area. ctrlKey Boolean true Used to indicate whether the 'ctrl' key was depressed during the firing of the event. currentTarget * Node true Used to indicate the EventTarget whose EventListeners are currently being processed. This is particularly useful during capturing and bubbling. defaultPrevented * Boolean true Used to indicate whether preventDefault() has been called for this event. detail * Number false Specifies some detail information about the Event, depending on the type of event. eventPhase * Number true Used to indicate which phase of event flow is currently being evaluated. metaKey Boolean true Used to indicate whether the 'meta' key was depressed during the firing of the event. On some platforms this key may map to an alternative key name. namespaceURI * String true The namespace URI associated with this event at initialization time, or null if it is unspecified. relatedTarget Node true Used to identify a secondary EventTarget related to a UI event. Currently this attribute is used with the mouseover event to indicate the EventTarget which the pointing device exited and with the mouseout event to indicate the EventTarget which the pointing device entered. screenX Number true The horizontal coordinate at which the event occurred relative to the origin of the screen coordinate system. screenY Number true The vertical coordinate at which the event occurred relative to the origin of the screen coordinate system. shiftKey Boolean true Used to indicate whether the 'shift' key was depressed during the firing of the event. target * Node true Used to indicate the EventTarget to which the event was originally dispatched. timeStamp * TimeStamp true Used to specify the time (in milliseconds relative to the epoch) at which the event was created. type * String true The name of the event (case-insensitive). The name must be an XML name. view * Object false The view attribute identifies the AbstractView from which the event was generated. Method Returns Description getModifierState Boolean Queries the state of a modifier using a key identifier. Sytaxis: object.getModifierState(modifier) Arguments: Name Type O/R Description modifier String Required A modifier key identifier. Common modifier keys are "Alt", "AltGraph", "CapsLock", "Control", "Meta", "NumLock", "Scroll", or "Shift" initEvent * Void The initEvent method is used to initialize the value of an Event created through the DocumentEvent interface. Sytaxis: object.initEvent(type, canBubble, cancelable) Arguments: Name Type O/R Description type String Required Specifies the event type. canBubble Boolean Required Specifies whether or not the event can bubble. cancelable Boolean Required Specifies whether or not the event's default action can be prevented. initMouseEvent Void The initMouseEvent method is used to initialize the value of a MouseEvent object. Sytaxis: object.initMouseEvent(type, canBubble, cancelable, view, detail, screenX, screenY, clientX, clientY, ctrlKey, shiftKey, metaKey, button, relatedTarget) Arguments: Name Type O/R Description type String Required Specifies the event type. canBubble Boolean Required Specifies whether or not the event can bubble. cancelable Boolean Required Specifies whether or not the event's default action can be prevented. view Object Required Specifies view. This value may be null. detail Number Required Specifies detail. screenX Number Required The horizontal coordinate at which the event occurred relative to the origin of the screen coordinate system. screenY Number Required The vertical coordinate at which the event occurred relative to the origin of the screen coordinate system. clientX Number Required The horizontal coordinate at which the event occurred relative to the viewport associated with the event. clientY Number Required The vertical coordinate at which the event occurred relative to the viewport associated with the event. ctrlKey Boolean Required Specifies if Control key was pressed. shiftKey Boolean Required Specifies if Shift key was pressed. metaKey Boolean Required Specifies if Meta key was pressed. button Number Required Indicates which pointer device button changed state. relatedTarget Node Required Specifies MouseEvent.relatedTarget. This value may be null. initUIEvent * Void The initUIEvent method is used to initialize the value of a UIEvent object. Sytaxis: object.initUIEvent(type, canBubble, cancelable, view, detail) Arguments: Name Type O/R Description type String Required Specifies the event type. canBubble Boolean Required Specifies whether or not the event can bubble. cancelable Boolean Required Specifies whether or not the event's default action can be prevented. view Object Required Specifies view. This value may be null. detail Number Required Specifies detail. preventDefault * Void If an event is cancelable, the preventDefault method is used to signify that the event is to be canceled, meaning any default action normally taken by the implementation as a result of the event will not occur. Sytaxis: object.preventDefault() stopImmediatePropagation * Void Prevents other event listeners from being triggered and, unlike stopPropagation() its effect is immediate Sytaxis: object.stopImmediatePropagation() stopPropagation * Void The stopPropagation method is used prevent further propagation of an event during event flow. The event will complete dispatch to all listeners on the current EventTarget before event flow stops. This method may be used during any stage of event flow. Sytaxis: object.stopPropagation() Event B C Interface Description Pseudo-class Description Constant Value Description

Remarks

Events of that type:

• click
• dblclick
• mousedown
• mousemove
• mouseout
• mouseover
• mouseup
• contextmenu
• mouseenter
• mouseleave