Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Where are attached event-handlers 'meta-data' stored? On the "DOM," object, or...?

I've always wondered... so you have a code like this:

$('#click-me');

and you attach it with this:

$('#click-me').click(someFunction);

where is the 'meta-data' that says:

"Hey "jQuery-object #click-me," I will point you to 'someFunction' when you are clicked!"

I know that event-handlers can get destroyed such as my situation with Backbone.js where my events stopped firing due to me re-rendering the entire page, destroying some background functions/objects/Views along the way.. (this is the context as to why I'm asking this question)

NOW, MY QUESTION IS:

where are events 'meta-data' stored and how are they destroyed? Are they stored within the function that bound it to a function? Are they within the DOM 'meta-data' (if there is one) itself?

I'm trying to learn the intricacies of JavaScript because I'm tired of bugs. In addition to that, I'm wondering if I should watch out for garbage collection that might detach my events and such. Coming from C#, I would say JavaScript with the DOM is really something...

(also, as a side note, how can I access these events and 'debug' them? firefox? chrome?)


UPDATE

To say it in different words, where is the information that connects a DOM element to a certain event stored? DOM? Objects? (or.. does jQuery map it? does JavaScript have a 'meta-data'? it's around that context..

like image 460
Jan Carlo Viray Avatar asked Feb 03 '12 03:02

Jan Carlo Viray


People also ask

What are event handlers in HTML?

The event handlers handle this. The event handlers are the properties of the HTML or DOM elements, which manages how the element should react to a specific event. The below figure briefs the concept and processing of the event handlers:

What is the onload event handler in JavaScript?

What is the OnLoad Event Handler in JavaScript: The onLoad event executes when a page or a frame or an image is loaded. It initializes some variables when a page is loaded or set some properties when an image is loaded. Its syntax looks like below:

How to attach event handlers to child elements?

Use the on () method instead. Attaches event handlers to elements Deprecated in version 3.0. Use the on () method instead. Attaches a handler to current, or future, specified child elements of the matching elements

Why can’t I check the events attached to an element?

Because the native method for checking the events attached to an element doesn’t exist we need to find a different solution. Let’s have a look at the available options. A little bit old-school but it will do in some circumstances.


2 Answers

Update : So I misunderstood the question, you wanted to know how events are bound in the context of just javascript and html. My original answer below describes how jquery creates and manages events. It boils down to a call to element.addEventListener.

From the MDN docs you see the eventtarget can be an element, the document, window or an XMLHttpRequest. From the w3 specifications on DOM Events an event target adds, removes and dispatches an event. So even information is probably stored in whatever is encapsulating things like elements, this will be implemented at the browser level.

From the issue you mentioned about copying and then replacing the html from the body erases the events, I'm thinking the browser just gives you the markup (without the event metadata) and then when you replace it, the metadata is gone. ( http://jsfiddle.net/qu9bF/1/)


Original answer: How jquery event handlers work.

Ok so I started digging this, for JQuery 1.4.2 (because I had to use a couple tools, all of which aren't updated)

Take a look first at this: http://james.padolsey.com/jquery/#v=1.4.2&fn=click

function (fn) {
    return fn ? this.bind(name, fn) : this.trigger(name);
}

That is how click is defined, it isn't actually defined in code. JQuery defines this function for all events/handler functions like below, yes! they are created/defined dynamically :

jQuery.each( ("blur focus focusin focusout load resize scroll unload click
            dblclick " +
        "mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave " +
        "change select submit keydown keypress keyup error").split(" "), 
    function( i, name ) {
        // the magic happens here..
        //each string is added as a function to the prototype
        jQuery.fn[ name ] = function( fn ) {
                return fn ? this.bind( name, fn ) : this.trigger( name );
        };//if a handler is NOT specified then attach an event OR call/trigger it

        if ( jQuery.attrFn ) {
                jQuery.attrFn[ name ] = true;
        }
});

From here on we need to look at bind, now bind() and one() are also defined like this. Search for "Code : bind and one events" here

From here I used chrome with this fiddle http://jsfiddle.net/qu9bF/ to step into the code. The block from c.each(["bind" is how the bind function is defined. The source is minified, but chrome can format it.

enter image description here

From here on the code calls JQuery.events.add, you can find this under the Events section here. This is not the add() that is documented I think

Toward the bottom, this piece of code is what does the magic. It accordingly calls element.addEventListener or attachEvent. See how it adds the on for attachEvent.

// Check for a special event handler
// Only use addEventListener/attachEvent if the special
// events handler returns false
if ( !special.setup || 
      special.setup.call( elem, data, namespaces, eventHandle ) === false ) {
      // Bind the global event handler to the element
       if ( elem.addEventListener ) {
             elem.addEventListener( type, eventHandle, false );

        } else if ( elem.attachEvent ) {
             elem.attachEvent( "on" + type, eventHandle );
        }
 }

And there you have it! :) I hope it answered both your questions. You can link up to the non-minified versions of jquery source and step through it to figure things out. IMO sometimes IE9's debugger is more intuitive (that's the only thing I use it for), and use the pages I've mentioned to browse through the source sanely.

like image 81
gideon Avatar answered Sep 17 '22 08:09

gideon


jQuery stores all the event binding and data cache on the jQuery.cache object. All the DOM nodes which were wrapped with jQuery and had events bound to them or data set will get automatically cleared when you are using jQuery html, empty, remove, replace etc.

That's why it's very important to never use innerHTML or other native DOM methods to insert/replace content that was altered before by jQuery. It will lead to leaks that you won't be able to cleanup unless you reset the jQuery.cache object manually.

There is also an undocumented method jQuery.cleanData which takes a collection of DOM nodes as an argument and it iterates over them and cleans up all their event bindings, data and removes references to these elements from the cache. This one can be useful if you have DOM fragments which were detached from the main DOM tree and there is a risk that they won't get cleaned up properly.

like image 23
Tom Tu Avatar answered Sep 17 '22 08:09

Tom Tu