View source

class Event

package js.jquery

extends Event

@:native("$.Event")

Available on js

Variables

altKey:Bool

button:Int

buttons:Int

char:Int

charCode:Int

clientX:Int

clientY:Int

ctrlKey:Bool

data:Dynamic

An optional object of data passed to an event method when the current executing handler is bound.

delegateTarget:Element

The element where the currently-called jQuery event handler was attached.

detail:Int

key:String

keyCode:Int

metaKey:Bool

Indicates whether the META key was pressed when the event fired.

namespace:String

The namespace specified when the event was triggered.

offsetX:Int

offsetY:Int

pageX:Float

The mouse position relative to the left edge of the document.

pageY:Float

The mouse position relative to the top edge of the document.

relatedTarget:Element

The other DOM element involved in the event, if any.

result:Dynamic

The last value returned by an event handler that was triggered by this event, unless the value was undefined.

screenX:Int

screenY:Int

shiftKey:Bool

toElement:Element

view:Window

which:Float

For key or mouse events, this property indicates the specific key or button that was pressed.

Methods

isDefaultPrevented():Bool

Returns whether event.preventDefault() was ever called on this event object.

isImmediatePropagationStopped():Bool

Returns whether event.stopImmediatePropagation() was ever called on this event object.

isPropagationStopped():Bool

Returns whether event.stopPropagation() was ever called on this event object.

Inherited Variables

Defined by Event

read onlybubbles:Bool

A Boolean indicating whether the event bubbles up through the DOM or not.

read onlycancelable:Bool

A Boolean indicating whether the event is cancelable.

read onlycurrentTarget:EventTarget

A reference to the currently registered target for the event. This is the object to which the event is currently slated to be sent to; it's possible this has been changed along the way through retargeting.

read onlydefaultPrevented:Bool

Indicates whether or not event.preventDefault() has been called on the event.

read onlyeventPhase:Int

Indicates which phase of the event flow is being processed.

read onlyexplicitOriginalTarget:EventTarget

The explicit original target of the event (Mozilla-specific).

read onlyisTrusted:Bool

Indicates whether or not the event was initiated by the browser (after a user click for instance) or by a script (using an event creation method, like event.initEvent)

read onlyoriginalTarget:EventTarget

The original target of the event, before any retargetings (Mozilla-specific).

read onlytarget:EventTarget

A reference to the target to which the event was originally dispatched.

read onlytimeStamp:Float

The time at which the event was created, in milliseconds. By specification, this value is time since epoch, but in reality browsers' definitions vary; in addition, work is underway to change this to be a DOMHighResTimeStamp instead.

read onlytype:String

The name of the event (case-insensitive).

Inherited Methods

Defined by Event

getPreventDefault():Bool

Non-standard. Returns the value of Event.defaultPrevented. Use Event.defaultPrevented instead.

initEvent(type:String, bubbles:Bool, cancelable:Bool):Void

Initializes the value of an Event created. If the event has already being dispatched, this method does nothing.

preventDefault():Void

Cancels the event (if it is cancelable).

stopImmediatePropagation():Void

For this particular event, no other listener will be called. Neither those attached on the same element, nor those attached on elements which will be traversed later (in capture phase, for instance)

stopPropagation():Void

Stops the propagation of events further along in the DOM.