ajaxComplete( handler( event, XMLHttpRequest, ajaxOptions ) )

jQuery API の ajaxComplete( handler( event, XMLHttpRequest, ajaxOptions ) ) は、Ajaxリクエスト完了時に呼び出すグローバルAjaxイベントハンドラを登録するメソッド。Ajaxリクエストの成功、失敗にかかわらず、Ajaxリクエスト完了時に呼び出す。

引数

handler( event, XMLHttpRequest, ajaxOptions )

Ajaxリクエスト完了時に実行するコールバック関数。

event

イベント・オブジェクト

XMLHttpRequest

XMLHttpRequestオブジェクト。

ajaxOptions

Ajaxオプション。

記述方法

jQuery( セレクター ) . ajaxComplete( function() {
    jQuery( this ) . text( 'Ajaxリクエスト完了' );
} );

Ajaxリクエスト完了時に、セレクターに指定した要素内に、「Ajaxリクエスト完了」と表示する。

記述例

jQuery( '#sample' ) . ajaxComplete( function() {
    jQuery( this ) . text( 'Ajaxリクエスト完了' );
} );

Ajaxリクエスト完了時に、idが「sample」の要素内に、「Ajaxリクエスト完了」と表示する。

実装例(サンプル)

実装例(サンプル)の動作について

「toggle」ボタンをクリックすると、「jquery-sample-get.php」ファイルの実行結果を読み込み、黄色のボックス要素内に表示する。リクエスト時、「year」「month」「day」のパラメータを送信し、「jquery-sample-get.php」ファイルで取得し、表示する。「toggle」ボタンを、再度クリックすると、元に戻す。

Ajaxリクエストが完了すると、「toggle」ボタンの右横に「Ajaxリクエスト完了」と表示する。Ajaxリクエストの成功、失敗にかかわらず、「Ajaxリクエスト完了」と表示する。

実装例(サンプル)のソースコード

JavaScript

<script>
<!--
jQuery( function() {
    jQuery( '#jquery-sample-message' ) . ajaxComplete( function( event, XMLHttpRequest, ajaxOptions ) {
        jQuery( '#jquery-sample-message' ) . text( 'Ajaxリクエスト完了' );
    } );
    jQuery( '#jquery-sample-button' ) . toggle(
        function() {
            jQuery . get(
                'jquery-sample-get.php',
                { year: '2011', month: '12', day: '6' },
                function( data ) {
                    jQuery( '#jquery-sample-get' ) . html( data );
                }
                ,'html'
            );
        },
        function() {
            jQuery( '#jquery-sample-get' ) . html( '' );
            jQuery( '#jquery-sample-message' ) . text( '' );
        }
    );
} );
// -->
</script>

CSS

<style type="text/css">
<!--
#jquery-sample {
    margin: 10px;
    width: 200px;
}
#jquery-sample-get {
    margin: 10px;
    padding: 10px;
    height: 100px;
    background-color: yellow;
    border: 1px solid gray;
    border-radius: 10px;
}
-->
</style>

HTML

<div id="jquery-sample">
    <p>
        <button id="jquery-sample-button">toggle</button>
        <span id="jquery-sample-message"></span>
    </p>
    <div id="jquery-sample-get"></div>
</div>

読み込むPHPファイル

<p>読み込んだ内容。</p>
<p>年:<?php echo  $_GET['year']; ?>年</p>
<p>月:<?php echo  $_GET['month']; ?>月</p>
<p>日:<?php echo  $_GET['day']; ?>日</p>

スポンサード リンク

カテゴリー: Ajax, API, JavaScript, jQuery, グローバルAjaxイベントハンドラ タグ: パーマリンク