// $Id$ (function ($) { /** * Provides AJAX page updating via jQuery $.ajax (Asynchronous JavaScript and XML). * * AJAX is a method of making a request via Javascript while viewing an HTML * page. The request returns an array of commands encoded in JSON, which is * then executed to make any changes that are necessary to the page. * * Drupal uses this file to enhance form elements with #ajax['path'] and * #ajax['wrapper'] properties. If set, this file will automatically be included * to provide AJAX capabilities. */ Drupal.ajax = Drupal.ajax || {}; /** * Attaches the AJAX behavior to each AJAX form element. */ Drupal.behaviors.AJAX = { attach: function (context, settings) { // Load all AJAX behaviors specified in the settings. for (var base in settings.ajax) { if (!$('#' + base + '.ajax-processed').length) { var element_settings = settings.ajax[base]; $(element_settings.selector).each(function () { Drupal.ajax[base] = new Drupal.ajax(base, this, element_settings); }); $('#' + base).addClass('ajax-processed'); } } // Bind AJAX behaviors to all items showing the class. $('.use-ajax:not(.ajax-processed)').addClass('ajax-processed').each(function () { var element_settings = {}; // For anchor tags, these will go to the target of the anchor rather // than the usual location. if ($(this).attr('href')) { element_settings.url = $(this).attr('href'); } var base = $(this).attr('id'); Drupal.ajax[base] = new Drupal.ajax(base, this, element_settings); }); // This class means to submit the form to the action using AJAX. $('.use-ajax-submit:not(.ajax-processed)').addClass('ajax-processed').each(function () { var element_settings = {}; // AJAX submits specified in this manner automatically submit to the // normal form action. element_settings.url = $(this.form).attr('action'); element_settings.set_click = TRUE; var base = $(this).attr('id'); Drupal.ajax[base] = new Drupal.ajax(base, this, element_settings); }); } }; /** * AJAX object. * * All AJAX objects on a page are accessible through the global Drupal.ajax * object and are keyed by the submit button's ID. You can access them from * your module's JavaScript file to override properties or functions. * * For example, if your AJAX enabled button has the ID 'edit-submit', you can * redefine the function that is called to insert the new content like this * (inside a Drupal.behaviors attach block): * @code * Drupal.behaviors.myCustomAJAXStuff = { * attach: function (context, settings) { * Drupal.ajax['edit-submit'].commands.insert = function (ajax, response, status) { * new_content = $(response.data); * $('#my-wrapper').append(new_content); * alert('New content was appended to #my-wrapper'); * } * } * }; * @endcode */ Drupal.ajax = function (base, element, element_settings) { var defaults = { url: 'system/ajax', event: 'mousedown', keypress: true, selector: '#' + base, effect: 'none', speed: 'slow', method: 'replace', progress: { type: 'bar', message: 'Please wait...' }, button: {} }; $.extend(this, defaults, element_settings); this.element = element; // Replacing 'nojs' with 'ajax' in the URL allows for an easy method to let // the server detect when it needs to degrade gracefully. this.url = element_settings.url.replace('/nojs/', '/ajax/'); this.wrapper = '#' + element_settings.wrapper; // If there isn't a form, jQuery.ajax() will be used instead, allowing us to // bind AJAX to links as well. if (this.element.form) { this.form = $(this.element.form); } // Set the options for the ajaxSubmit function. // The 'this' variable will not persist inside of the options object. var ajax = this; var options = { url: ajax.url, data: ajax.button, beforeSubmit: function (form_values, element_settings, options) { return ajax.beforeSubmit(form_values, element_settings, options); }, success: function (response, status) { // Sanity check for browser support (object expected). // When using iFrame uploads, responses must be returned as a string. if (typeof response == 'string') { response = Drupal.parseJson(response); } return ajax.success(response, status); }, complete: function (response, status) { if (status == 'error' || status == 'parsererror') { return ajax.error(response, ajax.url); } }, dataType: 'json', type: 'POST' }; // Bind the ajaxSubmit function to the element event. $(this.element).bind(element_settings.event, function () { if (ajax.form) { // If setClick is set, we must set this to ensure that the button's // value is passed. if (ajax.setClick) { // Mark the clicked button. 'form.clk' is a special variable for // ajaxSubmit that tells the system which element got clicked to // trigger the submit. Without it there would be no 'op' or // equivalent. ajax.form.clk = this.element; } ajax.form.ajaxSubmit(options); } else { $.ajax(options); } return false; }); // If necessary, enable keyboard submission so that AJAX behaviors // can be triggered through keyboard input as well as e.g. a mousedown // action. if (element_settings.keypress) { $(element_settings.element).keypress(function (event) { // Detect enter key. if (event.keyCode == 13) { $(element_settings.element).trigger(element_settings.event); return false; } }); } }; /** * Handler for the form redirection submission. */ Drupal.ajax.prototype.beforeSubmit = function (form_values, element, options) { // Disable the element that received the change. $(this.element).addClass('progress-disabled').attr('disabled', true); // Server-side code needs to know what element triggered the call, so it can // find the #ajax binding. form_values.push({ name: 'ajax_triggering_element', value: this.formPath }); // Insert progressbar or throbber. if (this.progress.type == 'bar') { var progressBar = new Drupal.progressBar('ajax-progress-' + this.element.id, eval(this.progress.update_callback), this.progress.method, eval(this.progress.error_callback)); if (this.progress.message) { progressBar.setProgress(-1, this.progress.message); } if (this.progress.url) { progressBar.startMonitoring(this.progress.url, this.progress.interval || 1500); } this.progress.element = $(progressBar.element).addClass('ajax-progress ajax-progress-bar'); this.progress.object = progressBar; $(this.element).after(this.progress.element); } else if (this.progress.type == 'throbber') { this.progress.element = $('