From f53401f97c30236985148e737397b16630be0f46 Mon Sep 17 00:00:00 2001 From: Bob Vincent Date: Wed, 6 Jul 2011 09:46:39 -0400 Subject: [PATCH] Issue #1178238 by pillarsdotnet: Revised documentation for #ajax['prevent'] property. --- developer/topics/forms_api_reference.html | 27 +++++++++++++++++---------- 1 files changed, 17 insertions(+), 10 deletions(-) diff --git a/developer/topics/forms_api_reference.html b/developer/topics/forms_api_reference.html index 6131d1782c140f6af5d06b742e6526f44c13dda3..81196ca02c20107086895cb10d640507eb7eb4f0 100644 --- a/developer/topics/forms_api_reference.html +++ b/developer/topics/forms_api_reference.html @@ -2595,14 +2595,14 @@ be called after the form or element is built.

<?php
  $form['file_public_path'] = array(
    '#type' => 'textfield',
    '#title' => t('Public file system path'),
    '#default_value' => variable_get('file_public_path', conf_path() . '/files'),
    '#maxlength' => 255,
    '#description' => t('A local file system path where public files will be stored. This directory must exist and be writable by Drupal. This directory must be relative to the Drupal installation directory and be accessible over the web.'),
    '#after_build' => array('system_check_directory'),
  );
?>
-

#ajax

+

#ajax

Used by: button, checkbox, checkboxes, hidden, image button, password, radio, radios, select, submit, tableselect, textarea, text_format, textfield

An array of elements whose values control the behavior of the -element with respect to the Drupal AJAX javascript methods.

+element with respect to the Drupal AJAX framework.

AJAX (Asynchronous Javascript and XML) is a term used for dynamic @@ -2753,16 +2753,23 @@ used for many situations.

#ajax['prevent']

Description: -Binding to mousedown rather than click means that it is possible to trigger a -click by pressing the mouse, holding the mouse button down until the Ajax -request is complete and the button is re-enabled, and then releasing the mouse -button. Set 'prevent' so that ajax.js binds an additional handler to prevent -such a click from triggering a non-Ajax form submission. This also prevents a -textfield's ENTER press triggering this button's non-Ajax form submission -behavior.

+A JavaScript event to prevent when 'event' is triggered. Defaults to 'click' for +#ajax on #type 'submit', 'button', and 'image_button'. Multiple events may be +specified separated by spaces. For example, when binding #ajax behaviors to form +buttons, pressing the ENTER key within a textfield triggers the 'click' event of +the form's first submit button. Triggering Ajax in this situation leads to +problems, like breaking autocomplete textfields. Because of that, Ajax behaviors +are bound to the 'mousedown' event on form buttons by default. However, binding +to 'mousedown' rather than 'click' means that it is possible to trigger a click +by pressing the mouse, holding the mouse button down until the Ajax request is +complete and the button is re-enabled, and then releasing the mouse button. For +this case, 'prevent' can be set to 'click', so an additional event handler is +bound to prevent such a click from triggering a non-Ajax form submission. This +also prevents a textfield's ENTER press triggering a button's non-Ajax form +submission behavior.

Values: -String. Possible values: Any valid jQuery event, including 'click' (default), 'mousedown', 'blur', 'change', etc.

+String. Possible values: One or more jQuery events, with multiple events separated by space characters.

#ajax['progress']

-- 1.7.4.1