mirror of
https://github.com/Hopiu/jquery-mobile.git
synced 2026-03-16 22:10:25 +00:00
58 lines
No EOL
3.3 KiB
HTML
58 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>.ajaxComplete()</h1>
|
|
|
|
</div>
|
|
<div data-role="content" data-theme="c" id="ajaxComplete1">
|
|
<h2 class="jq-clearfix roundTop section-title">
|
|
<span class="name">.ajaxComplete( 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>Register a handler to be called when Ajax requests complete. This is an Ajax Event.</p>
|
|
<ul class="signatures"><li class="signature" id="ajaxComplete-handlerevent, XMLHttpRequest, ajaxOptions">
|
|
<h4 class="name">
|
|
<span class="versionAdded">version added: <a href="/category/version/1.0/">1.0</a></span>.ajaxComplete( 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 completes, jQuery triggers the <code>ajaxComplete</code> event. Any and all handlers that have been registered with the <code>.ajaxComplete()</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').ajaxComplete(function() {
|
|
$(this).text('Triggered ajaxComplete 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 completes, the log message is displayed.</p>
|
|
<p><strong>Note:</strong> Because <code>.ajaxComplete()</code> is implemented as a method of jQuery object 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>ajaxComplete</code> handlers are invoked, regardless of what Ajax request was completed. If we must differentiate between the requests, we can use the parameters passed to the handler. Each time an <code>ajaxComplete</code> handler is executed, it is passed the event object, the <code>XMLHttpRequest</code> object, and the settings object that was used in the creation of the request. For example, we can restrict our callback to only handling events dealing with a particular URL:</p>
|
|
<pre>$('.log').ajaxComplete(function(e, xhr, settings) {
|
|
if (settings.url == 'ajax/test.html') {
|
|
$(this).text('Triggered ajaxComplete handler.');
|
|
}
|
|
});</pre>
|
|
</div>
|
|
<h3>Example:</h3>
|
|
<div id="entry-examples" class="entry-examples"><div id="example-0">
|
|
<h4><span class="desc">Show a message when an Ajax request completes.</span></h4>
|
|
<pre><code class="example">$("#msg").ajaxComplete(function(event,request, settings){
|
|
$(this).append("<li>Request Complete.</li>");
|
|
});</code></pre>
|
|
</div></div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</body></html> |