jQuery UI ウィジェット(Widget)メソッド呼び出し

ウィジェット(Widget)はウィジェットファクトリー(Widget Factory)を通じてメソッドを使用して、初期化後の状態を変更し、アクションを実行することによって作成されます。ウィジェットメソッドを呼び出す方法は2つあります - ウィジェットファクトリー(Widget Factory)で作成されたプラグイン、または要素のインスタンスオブジェクトのメソッドを呼び出す方法です。

プラグイン呼び出し

ウィジェットのプラグインを使ってメソッドを呼び出すには、メソッド名を文字列として渡します。例えば、ここをクリックして、呼び出し方dialog(ダイアログ)ウィジェットのclose()メソッド。

$( ".selector" ).dialog( "close" );

メソッドが引数を必要とする場合は、追加の引数としてプラグインに渡します。ここをクリックして、呼び出し方dialog(ダイアログ)のoption()メソッド。

$( ".selector" ).dialog( "option", "height" );

これはdialog(ダイアログ)のheightオプションの値を返します。

インスタンス呼び出し

各ウィジェットの各インスタンスはすべて、使用してjQuery.data()要素に格納されます。インスタンスオブジェクトを取得するには、ウィジェットのフルネームをキー名として使用して呼び出しますjQuery.data()。具体的には、次の例のようになります。

var dialog = $( ".selector" ).data( "ui-dialog" );

インスタンスオブジェクトを参照した後、その上で直接メソッドを呼び出すことができます。

var dialog = $( ".selector" ).data( "ui-dialog" );
dialog.close();

jQuery UI 1.11 では、新しいinstance()メソッドにより、このプロセスがより簡単になります。

$( ".selector" ).dialog( "instance" ).close();

戻り値の型

ウィジェットのプラグインを介して呼び出されるほとんどのメソッドは、jQueryオブジェクトを返すため、メソッド呼び出しは追加の jQuery メソッドでチェーンできます。インスタンス上で呼び出す場合は、返すのはundefined。したがって、メソッド呼び出しは追加の jQuery メソッドでチェーンできます。インスタンス上で呼び出す場合は、返すのは

var dialog = $( ".selector" ).dialog();
 
// Instance invocation - returns undefined
dialog.data( "ui-dialog" ).close();
 
// Plugin invocation - returns a jQuery object
dialog.dialog( "close" );
 
// Therefore, plugin method invocation makes it possible to
// chain method calls with other jQuery functions
dialog.dialog( "close" )
    .css( "color", "red" );

例外は、ウィジェット関連情報を返すメソッドです。例えばdialog(ダイアログ)のisOpen()メソッド。

$( ".selector" )
    .dialog( "isOpen" )
    // This will throw a TypeError
    .css( "color", "red" );

これにより、TypeErrorエラーが発生します。なぜならisOpen()返されるのはブール値であり、jQuery オブジェクトではありません。

その他の拡張