jQuery UI API - プラグインブリッジ(Widget Plugin Bridge)

カテゴリ

ユーティリティ(Utilities) | ウィジェット(Widgets)

使用法

説明:jQuery.widget.bridge() メソッドはjQueryウィジェットファクトリー(Widget Factory)の一部です。これは、$.widget() によって作成されたオブジェクトと jQuery API の間の仲介役を果たします。

jQuery.widget.bridge( name, constructor )

パラメータ 型 型
name String 作成するプラグインの名前。
constructor Function() プラグインが呼び出されたときにインスタンス化するオブジェクト。

$.widget.bridge()次のことを行います:

  • 通常のJavaScriptコンストラクタをjQuery APIに接続します。
  • オブジェクトインスタンスを自動的に作成し、要素の$.dataキャッシュ内に保存します。
  • パブリックメソッドの呼び出しを許可します。
  • プライベートメソッドの呼び出しを防止します。
  • 初期化されていないオブジェクトでのメソッド呼び出しを防止します。
  • 複数の初期化を防止します。

jQuery UIウィジェットは、$.widget( "foo.bar", {} );構文を使用して作成するオブジェクトを定義します。5つの.foo,$( ".foo" ).bar();を持つDOM構造は、"bar" オブジェクトの5つのインスタンスを作成します。$.widget.bridge()"bar" オブジェクトとパブリックAPIに基づいてライブラリ内で動作します。したがって、以下のように記述することで$( ".foo" ).bar()インスタンスを作成し、以下のように記述することで$( ".foo" ).bar( "baz" )メソッドを呼び出すことができます。

一度だけ初期化してメソッドを呼び出したい場合は、渡すjQuery.widget.bridge()オブジェクトは非常に小さくすることができます:

var Highlighter = function( options, element ) {
  this.options = options;
  this.element = $( element );
  this._set( 800 );
};
Highlighter.prototype = {
  toggle: function() {
    this._set( this.element.css( "font-weight") === 400 ? 800 : 400 );
  },
  _set: function(value) {
    this.element.css( "font-weight", value );
  }
};

ここで必要なのは、2つのパラメータを受け取るコンストラクタだけです:

  • options:設定オプションのオブジェクト
  • element:インスタンスが作成されるDOM要素

次に、ブリッジを使用することで、そのオブジェクトをjQueryプラグインとして任意のjQueryオブジェクト上で使用できます:

// Hook up the plugin
$.widget.bridge( "colorToggle", Highlighter );
 
// Initialize it on divs
$( "div" ).colorToggle().click(function() {
  // Call the public method on click
  $( this ).colorToggle( "toggle" );
});

ブリッジのすべての機能を使用するには、オブジェクトのプロトタイプには、_init()メソッドが必要です。このメソッドは、プラグインが呼び出され、インスタンスが既に存在する場合に呼び出されます。この場合、さらにoption()メソッドが必要です。このメソッドは、オプションを最初のパラメータとして呼び出されます。オプションがない場合、パラメータは空のオブジェクトです。optionメソッドの使用法については、を参照してください。$.Widget。

ブリッジにはオプションのプロパティがあります。存在する場合:オブジェクトのプロトタイプにwidgetFullNameプロパティがある場合、そのプロパティはインスタンスを保存および取得するためのキーとして使用されます。それ以外の場合は、nameパラメータが使用されます。

その他の拡張