mirror of
https://github.com/Hopiu/jquery-mobile.git
synced 2026-03-16 22:10:25 +00:00
56 lines
No EOL
3.3 KiB
HTML
56 lines
No EOL
3.3 KiB
HTML
<!DOCTYPE html>
|
|
<html lang='en'><head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, minimum-scale=1, maximum-scale=1"><meta http-equiv='content-type' content='text/html; charset=UTF-8' /></head><body>
|
|
<div data-role="page">
|
|
<div data-role="header">
|
|
<h1>.ajaxSend()</h1>
|
|
|
|
</div>
|
|
<div data-role="content" data-theme="c" id="ajaxSend1">
|
|
<h2 class="jq-clearfix roundTop section-title">
|
|
<span class="name">.ajaxSend( handler(event, XMLHttpRequest, ajaxOptions) )</span> <span class="returns">Returns: <a class="return" href="http://docs.jquery.com/Types#jQuery">jQuery</a></span>
|
|
</h2>
|
|
<div class=" entry-details">
|
|
<p class="desc"><strong>Description: </strong></p>
|
|
<ul class="signatures"><li class="signature" id="ajaxSend-handlerevent, XMLHttpRequest, ajaxOptions">
|
|
<h4 class="name">
|
|
<span class="versionAdded">version added: <a href="/category/version/1.0/">1.0</a></span>.ajaxSend( handler(event, XMLHttpRequest, ajaxOptions) )</h4>
|
|
<p class="arguement"><strong>handler(event, XMLHttpRequest, ajaxOptions)</strong>The function to be invoked.</p>
|
|
</li></ul>
|
|
<div class="longdesc">
|
|
<p>Whenever an Ajax request is about to be sent, jQuery triggers the <code>ajaxSend</code> event. Any and all handlers that have been registered with the <code>.ajaxSend()</code> method are executed at this time.</p>
|
|
<p>To observe this method in action, we can set up a basic Ajax load request:</p>
|
|
<pre><div class="trigger">Trigger</div>
|
|
<div class="result"></div>
|
|
<div class="log"></div></pre>
|
|
<p>We can attach our event handler to any element:</p>
|
|
<pre>$('.log').ajaxSend(function() {
|
|
$(this).text('Triggered ajaxSend handler.');
|
|
});</pre>
|
|
<p>Now, we can make an Ajax request using any jQuery method:</p>
|
|
<pre>$('.trigger').click(function() {
|
|
$('.result').load('ajax/test.html');
|
|
});</pre>
|
|
<p>When the user clicks the button and the Ajax request is about to begin, the log message is displayed.</p>
|
|
<p><strong>Note:</strong> Because <code>.ajaxSend()</code> is implemented as a method of jQuery instances, we can use the <code>this</code> keyword as we do here to refer to the selected elements within the callback function.</p>
|
|
<p>All <code>ajaxSend</code> handlers are invoked, regardless of what Ajax request is to be sent. If we must differentiate between the requests, we can use the parameters passed to the handler. Each time an <code>ajaxSend</code> handler is executed, it is passed the event object, the <code>XMLHttpRequest</code> object, and the <a href="http://api.jquery.com/jQuery.ajax/">settings object</a> that was used in the creation of the Ajax request. For example, we can restrict our callback to only handling events dealing with a particular URL:</p>
|
|
<pre>$('.log').ajaxSend(function(e, xhr, settings) {
|
|
if (settings.url == 'ajax/test.html') {
|
|
$(this).text('Triggered ajaxSend handler.');
|
|
}
|
|
});</pre>
|
|
</div>
|
|
<h3>Example:</h3>
|
|
<div id="entry-examples" class="entry-examples"><div id="example-0">
|
|
<h4><span class="desc">Show a message before an Ajax request is sent.</span></h4>
|
|
<pre><code class="example">$("#msg").ajaxSend(function(evt, request, settings){
|
|
$(this).append("<li>Starting request at " + settings.url + "</li>");
|
|
});</code></pre>
|
|
</div></div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</body></html> |