jQuery UI 動作原理

jQuery UI には、状態を維持するウィジェット(Widget)が多く含まれているため、典型的な jQuery プラグインの使用パターンとは少し異なります。インストール方法はほとんどの jQuery プラグインと似ています。jQuery UI のウィジェットは、ウィジェットファクトリー(Widget Factory)に基づいて作成され、ウィジェットファクトリーは共通の API を提供します。したがって、そのうちの1つの使い方を学べば、他のウィジェット(Widget)の使い方もわかります。本チュートリアルでは、プログレスバー(progressbar)ウィジェットのコード例を使って、一般的な機能を紹介します。

インストール

ウィジェットの状態を追跡するため、まずウィジェットのライフサイクル全体を紹介します。ウィジェットがインストールされるとライフサイクルが始まります。1つ以上の要素でプラグインを呼び出すだけで、ウィジェットがインストールされます。

$( "#elem" ).progressbar();

これにより、jQuery オブジェクト内の各要素が初期化されます。この例では、要素の id は "elem" です。引数なしの.progressbar()メソッドを呼び出すため、ウィジェットはデフォルトのオプションに従って初期化されます。インストール時に一連のオプションを渡すことで、デフォルトのオプションを上書きできます。

$( "#elem" ).progressbar({ value: 20 });

インストール時に渡すオプションの数は、必要に応じて決めることができます。渡さなかったオプションは、すべてデフォルト値が使用されます。

オプションはウィジェットの状態の一部を構成するため、インストール後にもオプションを設定できます。後述のoptionメソッドの中でこの部分を説明します。

メソッド

ウィジェットが初期化されたので、その状態を照会したり、ウィジェット上でアクションを実行したりできます。初期化後のすべてのアクションは、メソッド呼び出しの形式で行われます。ウィジェット上でメソッドを呼び出すには、jQuery プラグインにメソッド名を渡します。たとえば、プログレスバー(progressbar)ウィジェット上でvalueメソッドを呼び出すには、次のようにします。

$( "#elem" ).progressbar( "value" );

メソッドが引数を受け付ける場合は、メソッド名の後に引数を渡すことができます。たとえば、40 给 valueメソッドに引数を渡すには、次のようにします。

$( "#elem" ).progressbar( "value", 40 );

jQuery の他のメソッドと同様に、ほとんどのウィジェットメソッドはチェーン化のために jQuery オブジェクトを返します。

$( "#elem" )
    .progressbar( "value", 90 )
    .addClass( "almost-done" );

共通メソッド

各ウィジェットには、そのウィジェットが提供する機能に基づいた独自のメソッドのセットがあります。ただし、すべてのウィジェットに共通するメソッドもいくつかあります。

option

前述したように、初期化後にoptionメソッドを使ってオプションを変更できます。たとえば、optionメソッドを呼び出して、プログレスバー(progressbar)の value を 30 に変更できます。

$( "#elem" ).progressbar( "option", "value", 30 );

注意してください。これは、先ほど呼び出したvalueメソッドの例とは異なります。この例では、optionメソッドを呼び出して、value オプションを 30 に変更します。

オプションの現在の値を取得することもできます。

$( "#elem" ).progressbar( "option", "value" );

さらに、optionメソッドにオブジェクトを渡すことで、複数のオプションを一度に更新できます。

$( "#elem" ).progressbar( "option", {
    value: 100,
    disabled: true
});

お気づきかもしれませんが、optionメソッドは、jQuery コードのゲッターやセッターと同じシグネチャを持っています。たとえば.css()と.attr()唯一の違いは、最初の引数として文字列 "option" を渡す必要があることです。

disable

disableメソッドはウィジェットを無効にします。プログレスバー(progressbar)の例では、これによりスタイルが変更され、プログレスバーが無効状態で表示されます。

$( "#elem" ).progressbar( "disable" );

呼び出すdisableメソッドは設定することと同等ですdisabledオプションをtrue。

enable

enableメソッドはdisableメソッドの反対です。

$( "#elem" ).progressbar( "enable" );

呼び出すenableメソッドは設定することと同等ですdisabledオプションをfalse。

destroy

もしウィジェットが不要になった場合は、ウィジェットを破棄して元のマークアップに戻すことができます。これはウィジェットのライフサイクルの終了を意味します。

$( "#elem" ).progressbar( "destroy" );

一度ウィジェットを破棄すると、そのウィジェットを再初期化しない限り、そのウィジェット上でメソッドを呼び出すことはできません。要素を削除する場合は、直接.remove()、または.html() 或 .empty()を使用して実現できます。ウィジェットは自動的に破棄されます。

widget

一部のウィジェットは、ラッパー要素や元の要素から切り離された要素を生成します。次の例では、widget生成された要素を返します。プログレスバー(progressbar)の例では、生成されたラッパーがないため、widgetメソッドは元の要素を返します。

$( "#elem" ).progressbar( "widget" );

イベント

すべてのウィジェットには、それぞれのさまざまな動作に関連するイベントがあり、状態が変化したときに通知してくれます。ほとんどのウィジェットでは、イベント名がウィジェット名をプレフィックスとします。たとえば、プログレスバー(progressbar)の change イベントをバインドでき、値が変化するたびにトリガーされます。

$( "#elem" ).bind( "progressbarchange", function() {
    alert( "The value has changed!" );
});

各イベントには、対応するコールバックがあり、オプションとして提供されます。プログレスバー(progressbar)のchangeコールバックは、バインドすることと同等ですprogressbarchangeイベント。

$( "#elem" ).progressbar({
    change: function() {
        alert( "The value has changed!" );
    }
});

共通イベント

ほとんどのイベントは特定のウィジェット向けですが、すべてのウィジェットには共通のcreateイベントがあります。このイベントは、ウィジェットが作成されたときにトリガーされます。

その他の拡張