jQuery UI API - Widget-Plugin-Bridge
Kategorie
Nutzung
Beschreibung:Die Methode jQuery.widget.bridge() istTeil der jQuery Widget Factory.Sie fungiert als Vermittler zwischen Objekten, die von $.widget() erstellt wurden, und der jQuery-API.
| Parameters | Type | Type |
|---|---|---|
| name | String | Der Name des zu erstellenden Plugins. |
| constructor | Function() | Das Objekt, das instanziiert wird, wenn das Plugin aufgerufen wird. |
$.widget.bridge()Führt Folgendes aus:
- Verbindet einen regulären JavaScript-Konstruktor mit der jQuery-API.
- Erstellt automatisch Objektinstanzen und speichert sie im
$.dataCache des Elements. - Ermöglicht das Aufrufen öffentlicher Methoden.
- Verhindert das Aufrufen privater Methoden.
- Verhindert den Aufruf von Methoden auf nicht initialisierten Objekten.
- Verhindert mehrfache Initialisierungen.
jQuery-UI-Widgets verwenden$.widget( "foo.bar", {} );Syntax, um ein zu erstellendes Objekt zu definieren. Gegeben eine DOM-Struktur mit fünf.foo,$( ".foo" ).bar();DOM-Strukturen erzeugen fünf Instanzen des "bar"-Objekts.$.widget.bridge()Basierend auf dem "bar"-Objekt und einer öffentlichen API funktioniert es innerhalb der Bibliothek. Daher können Sie schreiben$( ".foo" ).bar()um Instanzen zu erstellen, und schreiben$( ".foo" ).bar( "baz" )um Methoden aufzurufen.
Wenn Sie nur einmal initialisieren und Methoden aufrufen möchten, dann kann das Objekt, das Sie übergeben,jQuery.widget.bridge()sehr klein sein:
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 );
}
};
Hier benötigen Sie nur einen Konstruktor, der zwei Parameter entgegennimmt:
options: ein Objekt mit Konfigurationsoptionenelement: das DOM-Element, auf dem die Instanz erstellt wird
Dann können Sie die Bridge verwenden, um das Objekt als jQuery-Plugin zu nutzen, und Sie können es auf jedem jQuery-Objekt verwenden:
// 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" );
});
Um alle Funktionen der Bridge zu nutzen, benötigt der Prototyp Ihres Objekts eine_init()Methode. Diese Methode wird aufgerufen, wenn das Plugin aufgerufen wird und bereits eine Instanz existiert. In diesem Fall benötigen Sie außerdem eineoption()Methode. Diese Methode wird mit den Optionen als erstem Argument aufgerufen. Wenn es keine Optionen gibt, ist das Argument ein leeres Objekt. Um mehr überoptiondie Verwendung der Methode zu erfahren, siehe$.Widget。
Die Bridge hat eine optionale Eigenschaft, falls vorhanden: Wenn der Objektprototyp einewidgetFullNameEigenschaft besitzt, wird diese Eigenschaft als Schlüssel zum Speichern und Abrufen von Instanzen verwendet. Andernfalls wird der Parameter name verwendet.