Prototype - Event stop() Method


This method stops the event's propagation and prevents its default action from being triggered eventually.

There are two aspects to how your browser handles an event once it fires up −

  • The browser usually triggers event handlers on the actual element the event occurred on, then on its parent element, and so on and so forth, until the document.s root element is reached. This is called event bubbling, and is the most common form of event propagation. You may very well want to stop this propagation when you just handled an event, and don't want it to keep bubbling up (or see no need for it).

  • Once your code gets a chance to process the event, the browser handles it as well, if that event has a default behavior. For instance, clicking on links navigates to them; submitting forms sends them over to the server side; hitting the Return key in a single-line form field submits it, etc. You may very well want to prevent this default behavior if you do your own handling.

Because stopping one of those aspects means, in 99.9% of the cases, preventing the other one as well, Prototype bundles both in this stop function. Calling it on an event object stop propagation and prevents the default behavior.



Return Value



Here's a code snippet that prevents a form from being sent to the server side if a certain field is empty.

Event.observe('signinForm', 'submit', function(event) {
   var login = $F('login').strip();
   if ('' == login) {
      // Display the issue one way or another