Package | dom.events |
Class | public class MouseWheelEvent |
Inheritance | MouseWheelEvent MouseEvent UIEvent Event Object |
Introduced in: | DOM 3 Events |
To create an instance of the MouseWheelEvent interface, use the DocumentEvent.createEvent("MouseWheelEvent") method call.
See also
Property | Defined By | ||
---|---|---|---|
DOM 2 Events altKey : Boolean [read-only]
Refer to the KeyboardEvent.altKey attribute. | MouseEvent | ||
DOM 2 Events bubbles : Boolean [read-only]
Used to indicate whether or not an event is a bubbling event. | Event | ||
DOM 2 Events button : Number [read-only]
Returns an integer value indicating the button that changed state. | MouseEvent | ||
DOM 2 Events cancelable : Boolean [read-only]
Indicates whether the event is cancelable or not. | Event | ||
CSSOM View clientX : Number [read-only]
Returns the horizontal coordinate within the application's client area at which the event occurred
(as opposed to the coordinates within the page). | MouseEvent | ||
CSSOM View clientY : Number [read-only]
Returns the vertical coordinate within the application's client area at which the event occurred
(as opposed to the coordinates within the page). | MouseEvent | ||
DOM 2 Events ctrlKey : Boolean [read-only]
Refer to the KeyboardEvent.ctrlKey attribute. | MouseEvent | ||
DOM 2 Events currentTarget : EventTarget [read-only]
Identifies the current target for the event, as the event traverses the DOM. | Event | ||
DOM 3 Events defaulPrevented : Boolean [read-only]
Used to indicate whether Event.preventDefault() has been called for
this event. | Event | ||
DOM 2 Events detail : Number [read-only]
Specifies some detail information about the Event, depending
on the type of event. | UIEvent | ||
DOM 2 Events eventPhase : Number [read-only]
Used to indicate which phase of event flow is currently being accomplished. | Event | ||
Non-Standard explicitOriginalTarget : nsIDOMEventTarget [read-only]
The explicit original target of the event. | Event | ||
Non-Standard isChar : Boolean [read-only]
Returns a boolean indicating whether the event produced a key character or not. | UIEvent | ||
Non-Standard isTrusted : Boolean [read-only]
Determines if the event was from the user or script generated. | Event | ||
Non-Standard layerX : Number [read-only]
Returns the horizontal coordinate of the event relative to the current layer. | UIEvent | ||
Non-Standard layerY : Number [read-only]
Returns the vertical coordinate of the event relative to the current layer. | UIEvent | ||
DOM 2 Events metaKey : Boolean [read-only]
Refer to the KeyboardEvent.metaKey attribute. | MouseEvent | ||
DOM 3 Events namespaceURI : DOMString [read-only]
The namespace URI associated with this event at initialization time, or
null if it is unspecified. | Event | ||
CSSOM View offsetX : Number [read-only]
Returns the horizontal coordinate, as number of CSS pixels, of the
position where the event occurred relative to the origin of the padding box of the target node. | MouseEvent | ||
CSSOM View offsetY : Number [read-only]
Returns the vertical coordinate, as number of CSS pixels, of the
position where the event occurred relative to the origin of the padding box of the target node. | MouseEvent | ||
Non-Standard originalTarget : * [read-only]
The original target of the event before any retargetings. | Event | ||
CSSOM View pageX : Number [override] [read-only]
Returns the horizontal coordinate of the event relative to whole document. | MouseEvent | ||
CSSOM View pageY : Number [override] [read-only]
Returns the vertical coordinate of the event relative to the whole document. | MouseEvent | ||
DOM 2 Events relatedTarget : EventTarget [read-only]
Used to identify a secondary EventTarget related to a UI event, depending
on the type of event. | MouseEvent | ||
CSSOM View screenX : Number [read-only]
Returns the horizontal coordinate of the event within the screen as a whole. | MouseEvent | ||
CSSOM View screenY : Number [read-only]
Returns the vertical coordinate of the event within the screen as a whole. | MouseEvent | ||
DOM 2 Events shiftKey : Boolean [read-only]
Refer to the KeyboardEvent.shiftKey attribute. | MouseEvent | ||
DOM 2 Events target : EventTarget [read-only]
Used to indicate the event target. | Event | ||
DOM 2 Events timeStamp : DOMTimeStamp [read-only]
Used to specify the time at which the event was created in milliseconds
relative to 1970-01-01T00:00:00Z. | Event | ||
DOM 2 Events type : DOMString [read-only]
The local name of the event type. | Event | ||
DOM 2 Events view : AbstractView [read-only]
Returns the AbstractView object from which the event was generated. | UIEvent | ||
DOM 3 Events wheelDelta : Number [read-only]
The distance the wheel has rotated around the y-axis. | MouseWheelEvent | ||
Non-Standard which : DOMString [read-only]
Returns the numeric keyCode of the key pressed, or the character code (charCode) for
an alphanumeric key pressed. | UIEvent | ||
CSSOM View x : Number [read-only]
Returns the value of pageX. | MouseEvent | ||
CSSOM View y : Number [read-only]
Returns the value of pageY. | MouseEvent |
Method | Defined By | ||
---|---|---|---|
Queries the state of a modifier using a key identifier. | MouseEvent | ||
Initializes attributes of an Event created through the
DocumentEvent.createEvent method. | Event | ||
DOM 3 Events initEventNS(namespaceURIArg:DOMString, typeArg:DOMString, canBubbleArg:Boolean, cancelableArg:Boolean):void
Initializes attributes of an Event object. | Event | ||
DOM 2 Events initMouseEvent(typeArg:DOMString, canBubbleArg:Boolean, cancelableArg:Boolean, viewArg:AbstractView, detailArg:Number, screenXArg:Number, screenYArg:Number, clientXArg:Number, clientYArg:Number, ctrlKeyArg:Boolean, altKeyArg:Boolean, shiftKeyArg:Boolean, metaKeyArg:Boolean, buttonArg:Number, relatedTargetArg:EventTarget):void
Initializes attributes of a MouseEvent object. | MouseEvent | ||
DOM 3 Events initMouseEventNS(namespaceURIArg:DOMString, typeArg:DOMString, canBubbleArg:Boolean, cancelableArg:Boolean, viewArg:AbstractView, detailArg:Number, screenXArg:Number, screenYArg:Number, clientXArg:Number, clientYArg:Number, ctrlKeyArg:Boolean, altKeyArg:Boolean, shiftKeyArg:Boolean, metaKeyArg:Boolean, buttonArg:Number, relatedTargetArg:EventTarget, modifiersListArg:DOMString):void
Initializes attributes of a MouseEvent object. | MouseEvent | ||
DOM 3 Events initMouseWheelEventNS(namespaceURIArg:DOMString, typeArg:DOMString, canBubbleArg:Boolean, cancelableArg:Boolean, viewArg:AbstractView, detailArg:Number, screenXArg:Number, screenYArg:Number, clientXArg:Number, clientYArg:Number, buttonArg:Number, relatedTargetArg:EventTarget, modifiersListArg:DOMString, wheelDeltaArg:Number):void
Initializes attributes of a MouseWheelEvent object. | MouseWheelEvent | ||
DOM 2 Events initUIEvent(typeArg:DOMString, canBubbleArg:Boolean, cancelableArg:Boolean, viewArg:AbstractView, detailArg:Number):void
Initializes attributes of an UIEvent object. | UIEvent | ||
DOM 3 Events initUIEventNS(namespaceURIArg:DOMString, typeArg:DOMString, canBubbleArg:Boolean, cancelableArg:Boolean, viewArg:AbstractView, detailArg:Number):void
Initializes attributes of an UIEvent object. | UIEvent | ||
Obsolete preventBubble():void
Prevents the event from bubbling. | Event | ||
Obsolete preventCapture():void
This method is deprecated in favor of standard stopPropagation and is removed in Gecko 1.9. | Event | ||
DOM 2 Events preventDefault():void
Cancels the event if it is cancelable, without stopping further propagation of the event. | Event | ||
DOM 3 Events stopImmediatePropogation():void
Prevents other event listeners from being triggered and, unlike
Event.stopPropagation() its effect is immediate . | Event | ||
DOM 2 Events stopPropogation():void
Prevents other event listeners from being triggered but its effect is
deferred until all event listeners attached on the Event.currentTarget
have been triggered . | Event |
Constant | Defined By | ||
---|---|---|---|
HTML 4.0 abort : String = abort [static]
Loading of a resource has been aborted. | UIEvent | ||
DOM 2 Events AT_TARGET : Number = 2 [static]
The current event is in the target phase, i.e. | Event | ||
DOM 2 Events blur : String = blur [static]
An event target loses focus. | UIEvent | ||
DOM 2 Events BUBBLING_PHASE : Number = 3 [static]
The current event phase is the bubbling phase. | Event | ||
DOM 2 Events CAPTURING_PHASE : Number = 1 [static]
The current event phase is the capture phase. | Event | ||
HTML 4.0 change : String = change [static]
A control loses the input focus and its value has been modified since gaining focus. | UIEvent | ||
HTML 4.01 click : String = click [static]
A pointing device button is clicked over an element. | MouseEvent | ||
HTML 4.01 dblclick : String = dblclick [static]
A pointing device button is clicked twice over an element. | MouseEvent | ||
DOM 2 Events DOMActivate : String = DOMActivate [static]
Refer to Activation requests and behavior. | UIEvent | ||
DOM 2 Events DOMFocusIn : String = DOMFocusIn [static]
An event target receives focus. | UIEvent | ||
DOM 2 Events DOMFocusOut : String = DOMFocusOut [static]
An event target loses focus. | UIEvent | ||
HTML 4.0 error : String = error [static]
A resource failed to load, or has been loaded but cannot be interpreted according to its semantics
such as an invalid image, a script execution error, or non-well-formed XML. | UIEvent | ||
DOM 2 Events focus : String = focus [static]
An event target receives focus. | UIEvent | ||
HTML 4.0 load : String = load [static]
The DOM Implementation finishes loading the resource (such as the document) and any dependent resources
(such as images, style sheets, or scripts). | UIEvent | ||
HTML 4.01 mousedown : String = mousedown [static]
A pointing device button is pressed over an element. | MouseEvent | ||
HTML 4.01 mousemove : String = mousemove [static]
A pointing device is moved while it is over an element. | MouseEvent | ||
HTML 4.01 mouseout : String = mouseout [static]
A pointing device is moved away from an element. | MouseEvent | ||
HTML 4.01 mouseover : String = mouseover [static]
A pointing device is moved onto an element. | MouseEvent | ||
HTML 4.01 mouseup : String = mouseup [static]
A pointing device button is released over an element. | MouseEvent | ||
DOM 3 Events mousewheel : String = mousewheel [static]
Refer to Activation requests and behavior. | MouseWheelEvent | ||
HTML 4.0 reset : String = reset [static]
A form, such as a [HTML 4.01] or [XHTML 1.0] form, is reset. | UIEvent | ||
DOM 2 Events resize : String = resize [static]
A document view or an element has been resized. | UIEvent | ||
DOM 2 Events scroll : String = scroll [static]
A document view or an element has been scrolled. | UIEvent | ||
HTML 4.0 select : String = select [static]
A user selects some text. | UIEvent | ||
HTML 4.0 submit : String = submit [static]
A form, such as a [HTML 4.01] or [XHTML 1.0] form, is submitted. | UIEvent | ||
HTML 4.0 unload : String = unload [static]
The DOM implementation removes from the environment the resource (such as the document) or any dependent
resources (such as images, style sheets, scripts). | UIEvent |
DOM 3 Events wheelDelta | property |
wheelDelta:Number
[read-only] Introduced in: | DOM 3 Events |
The distance the wheel has rotated around the y-axis.
public function get wheelDelta():Number
See also
DOM 3 Events initMouseWheelEventNS | () | method |
public function initMouseWheelEventNS(namespaceURIArg:DOMString, typeArg:DOMString, canBubbleArg:Boolean, cancelableArg:Boolean, viewArg:AbstractView, detailArg:Number, screenXArg:Number, screenYArg:Number, clientXArg:Number, clientYArg:Number, buttonArg:Number, relatedTargetArg:EventTarget, modifiersListArg:DOMString, wheelDeltaArg:Number):void
Introduced in: | DOM 3 Events |
Initializes attributes of a MouseWheelEvent object. This method has the same behavior as MouseEvent.initMouseEventNS().
Parameters
namespaceURIArg:DOMString — Specifies Event.namespaceURI, the namespace URI associated with this event, or null if no namespace.
| |
typeArg:DOMString — Specifies Event.type, the local name of the event type.
| |
canBubbleArg:Boolean — Specifies Event.bubbles. This parameter overrides the intrinsic bubbling behavior of the event.
| |
cancelableArg:Boolean — Specifies Event.cancelable. This parameter overrides the intrinsic cancelable behavior of the event.
| |
viewArg:AbstractView — Specifies UIEvent.view. This value may be null.
| |
detailArg:Number — Specifies UIEvent.detail.
| |
screenXArg:Number — Refer to the MouseEvent.initMouseEventNS() method for a description of this parameter.
| |
screenYArg:Number — Refer to the MouseEvent.initMouseEventNS() method for a description of this parameter.
| |
clientXArg:Number — Refer to the MouseEvent.initMouseEventNS() method for a description of this parameter.
| |
clientYArg:Number — Refer to the MouseEvent.initMouseEventNS() method for a description of this parameter.
| |
buttonArg:Number — Refer to the MouseEvent.initMouseEventNS() method for a description of this parameter.
| |
relatedTargetArg:EventTarget — Refer to the MouseEvent.initMouseEventNS() method for a description of this parameter.
| |
modifiersListArg:DOMString — Refer to the MouseEvent.initMouseEventNS() method for a description of this parameter.
| |
wheelDeltaArg:Number — Specifies MouseWheelEvent.wheelDelta.
|
See also
DOM 3 Events mousewheel | Constant |
public static const mousewheel:String = mousewheel
Introduced in: | DOM 3 Events |
Refer to Activation requests and behavior.
Title | Value |
---|---|
Namespace | None |
Cancelable | Yes |
Bubbles | Yes |
Target | Document, Element |
Context info | MouseWheelEvent.wheelDelta, MouseEvent.altKey, MouseEvent.ctrlKey, MouseEvent.shiftKey, MouseEvent.metaKey, and UIEvent.view are in use. MouseEvent.screenX, MouseEvent.screenY, MouseEvent.clientX, MouseEvent.clientY, and MouseEvent.button are in use if the wheel is associated to a pointing device. MouseEvent.relatedTarget indicates the event target the pointing device is pointing at, if any. UIEvent.detail is not in use. |
See also