jQuery Event Object

jQuery event system normalizes the event object according to W3C standards. The event object is guaranteed to be passed to the event handler. Most properties from the original event are copied over and normalized to the new event object.

The JavaScript event object will be passed through the callback function takes a single parameter when the handler is called.

The event object is often unneccessary and the parameter is omitted, as sufficient context is usually available when the handler is bound to know exactly what needs to be done when the handler is triggered, however there are certail attributes which you would need to be accessed.

The Event Attributes:

The following event properties/attributes are available and safe to access in a platform independent manner:

Property Description
altKey Set to true if the Alt key was pressed when the event was triggered, false if not. The Alt key is labeled Option on most Mac keyboards.
ctrlKey Set to true if the Ctrl key was pressed when the event was triggered, false if not.
data The value, if any, passed as the second parameter to the bind() command when the handler was established.
keyCode For keyup and keydown events, this returns the key that was pressed.
metaKey Set to true if the Meta key was pressed when the event was triggered, false if not. The Meta key is the Ctrl key on PCs and the Command key on Macs.
pageX For mouse events, specifies the horizontal coordinate of the event relative from the page origin.
pageY For mouse events, specifies the vertical coordinate of the event relative from the page origin.
relatedTarget For some mouse events, identifies the element that the cursor left or entered when the event was triggered.
screenX For mouse events, specifies the horizontal coordinate of the event relative from the screen origin.
screenY For mouse events, specifies the vertical coordinate of the event relative from the screen origin.
shiftKey Set to true if the Shift key was pressed when the event was triggered, false if not.
target Identifies the element for which the event was triggered.
timeStamp The timestamp (in milliseconds) when the event was created.
type For all events, specifies the type of event that was triggered (for example, click).
which For keyboard events, specifies the numeric code for the key that caused the event, and for mouse events, specifies which button was pressed (1 for left, 2 for middle, 3 for right)

The Event Methods:

There is a list of methods which can be called on an Event Object:

Method Description
preventDefault() Prevents the browser from executing the default action.
isDefaultPrevented() Returns whether event.preventDefault() was ever called on this event object.
stopPropagation() Stops the bubbling of an event to parent elements, preventing any parent handlers from being notified of the event.
isPropagationStopped() Returns whether event.stopPropagation() was ever called on this event object.
stopImmediatePropagation() Stops the rest of the handlers from being executed.
isImmediatePropagationStopped() Returns whether event.stopImmediatePropagation() was ever called on this event object.

Event Manipulation Methods:

Following table lists down important event-related methods:

Method Description
bind( type, [data], fn ) Binds a handler to one or more events (like click) for each matched element. Can also bind custom events.
die( type, fn ) This does the opposite of live, it removes a bound live event.
hover( over, out ) Simulates hovering for example moving the mouse on, and off, an object.
live( type, fn ) Binds a handler to an event (like click) for all current – and future – matched element. Can also bind custom events.
one( type, [data], fn ) Binds a handler to one or more events to be executed once for each matched element.
ready( fn ) Binds a function to be executed whenever the DOM is ready to be traversed and manipulated.
toggle( fn, fn2, fn3,… ) Toggle among two or more function calls every other click.
trigger( event, [data] ) Trigger an event on every matched element.
triggerHandler( event, [data] ) Triggers all bound event handlers on an element .
unbind( [type], [fn] ) This does the opposite of bind, it removes bound events from each of the matched elements.

Event Helper Methods:

jQuery also provides a set of event helper functions which can be used either to trigger an event to bind any event types mentioned above.

Trigger Methods:

Following is an example which would triggers the blur event on all paragraphs:

Binding Methods:

Following is an example which would bind a click event on all the div element.

Here is a complete list of all the support methods provided by jQuery:

Method Description
blur( ) Triggers the blur event of each matched element.
blur( fn ) Bind a function to the blur event of each matched element.
change( ) Triggers the change event of each matched element.
change( fn ) Binds a function to the change event of each matched element.
click( ) Triggers the click event of each matched element.
click( fn ) Binds a function to the click event of each matched element.
dblclick( ) Triggers the dblclick event of each matched element.
dblclick( fn ) Binds a function to the dblclick event of each matched element.
error( ) Triggers the error event of each matched element.
error( fn ) Binds a function to the error event of each matched element.
focus( ) Triggers the focus event of each matched element.
focus( fn ) Binds a function to the focus event of each matched element.
keydown( ) Triggers the keydown event of each matched element.
keydown( fn ) Bind a function to the keydown event of each matched element.
keypress( ) Triggers the keypress event of each matched element.
keypress( fn ) Binds a function to the keypress event of each matched element.
keyup( ) Triggers the keyup event of each matched element.
keyup( fn ) Bind a function to the keyup event of each matched element.
load( fn ) Binds a function to the load event of each matched element.
mousedown( fn ) Binds a function to the mousedown event of each matched element.
mouseenter( fn ) Bind a function to the mouseenter event of each matched element.
mouseleave( fn ) Bind a function to the mouseleave event of each matched element.
mousemove( fn ) Bind a function to the mousemove event of each matched element.
mouseout( fn ) Bind a function to the mouseout event of each matched element.
mouseover( fn ) Bind a function to the mouseover event of each matched element.
mouseup( fn ) Bind a function to the mouseup event of each matched element.
resize( fn ) Bind a function to the resize event of each matched element.
scroll( fn ) Bind a function to the scroll event of each matched element.
select( ) Trigger the select event of each matched element.
select( fn ) Bind a function to the select event of each matched element.
submit( ) Trigger the submit event of each matched element.
submit( fn ) Bind a function to the submit event of each matched element.
unload( fn ) Binds a function to the unload event of each matched element.

Leave a Reply

Your email address will not be published. Required fields are marked *

CAPTCHA