jQuery UI Widgets mit der Widget Factory erweitern

Die Widget Factory von jQuery UI erleichtert das Erstellen von Widgets, die die Funktionalität bestehender Widgets erweitern. Auf diese Weise können Sie leistungsstarke Widgets auf vorhandenen aufbauen oder subtile Anpassungen an der Funktionalität bestehender Widgets vornehmen.

Hinweis:Bevor Sie dieses Kapitel studieren, müssen Sie verstehen, was die Widget Factory ist und wie sie funktioniert. Wenn Sie mit diesem Wissen nicht vertraut sind, lesen Sie bitte zuerst dasHow to Use the Widget FactoryKapitel.

Widget-Erweiterungen erstellen

Das Erstellen von Widgets mit der Widget Factory erfolgt durch Übergeben$.widget()eines Widget-Namens und eines Prototypobjekts. Das folgende Beispiel erstellt ein "superDialog"-Widget im Namespace "custom".

$.widget( "custom.superDialog", {} );

Um Erweiterungen zu unterstützen,$.widget()wird optional der Konstruktor des Widgets akzeptiert, das als übergeordnetes Widget verwendet werden soll. Wenn Sie ein übergeordnetes Widget angeben, übergeben Sie es als zweiten Parameter, nach dem Widget-Namen und vor dem Widget-Prototypobjekt.

Wie im obigen Beispiel erstellt das Folgende ebenfalls ein "superDialog"-Widget im Namespace "custom". Diesmal übergibt es jedochdas Dialog-Widget von jQuery UI-Konstruktor ($.ui.dialog), was anzeigt, dass das superDialog-Widget das Dialog-Widget von jQuery UI als sein übergeordnetes Widget verwenden soll.

$.widget( "custom.superDialog", $.ui.dialog, {} );

Hier sind die Widgets superDialog und dialog im Wesentlichen äquivalent, nur mit unterschiedlichen Namen und Namespaces. Um unser neues Widget unverwechselbarer zu machen, können wir einige Methoden zu seinem Prototypobjekt hinzufügen.

Das Prototypobjekt des Widgets ist der letzte Parameter, der an$.widget()übergeben wird. Bisher hat unser Beispiel ein leeres Objekt verwendet. Jetzt fügen wir eine Methode zu diesem Objekt hinzu:

$.widget( "custom.superDialog", $.ui.dialog, {
    red: function() {
        this.element.css( "color", "red" );
    }
});
 
// Create a new <div>, convert it into a superDialog, and call the red() method.
$( "<div>I am red</div>" )
    .superDialog()
    .superDialog( "red" );

JetztsuperDialoghat einered()Methode, die seine Textfarbe auf Rot ändert. Beachten Sie, wie die Widget Factory automatisch setztthisauf das Instanzobjekt des Widgets. Um eine Liste aller verfügbaren Methoden und Eigenschaften der Instanz anzuzeigen, besuchen Sie bittedie Widget Factory API-Dokumentation。

Bestehende Methoden erweitern

Manchmal müssen Sie das Verhalten vorhandener Widget-Methoden anpassen oder erweitern. Sie können den Methodennamen als Namen der zu überschreibenden Methode im Prototypobjekt angeben. Das folgende Beispiel überschreibt dieopen()Methodevon dialog. Da der Dialog standardmäßig geöffnet ist, wenn dieser Code ausgeführt wird,"open"wird protokolliert.

$.widget( "custom.superDialog", $.ui.dialog, {
    open: function() {
        console.log( "open" );
    }
});
 
// Create a new <div>, and convert it into a superDialog.
$( "<div>" ).superDialog();

Beim Ausführen dieses Codes gibt es ein Problem. Weil wiropen()das Standardverhalten überschrieben haben, wird der Dialog nicht mehr auf dem Bildschirm angezeigt.

Wenn wir eine Methode auf dem Prototyp-Objekt verwenden, überschreiben wir tatsächlich die ursprüngliche Methode, indem wir eine neue Methode in der Prototyp-Kette verwenden.

Um die Methoden des übergeordneten Widgets verfügbar zu machen, stellt die Widget Factory zwei Methoden bereit -_super()und_superApply()。

Verwendung_super()und_superApply()um auf das übergeordnete Widget zuzugreifen

_super()und_superApply()und dieselbe Methode für das übergeordnete Widget aufzurufen. Siehe das folgende Beispiel. Wie das vorherige Beispiel überschreibt auch dieses Beispielopen()Methode zum Protokollieren"open". Wenn diesmal jedoch_super()ausgeführt wird, ruft die Methode des Dialogs aufopen(), und öffnet den Dialog.

$.widget( "custom.superDialog", $.ui.dialog, {
    open: function() {
        console.log( "open" );
 
        // Invoke the parent widget's open().
        return this._super();
    }
});
 
$( "<div>" ).superDialog();

_super()und_superApply()Es ist tatsächlich äquivalent zum ursprünglichenFunction.prototype.call()undFunction.prototype.apply()Methode. Daher,_super()akzeptiert eine Argumentliste,_superApply()akzeptiert ein Array als Argument. Das folgende Beispiel zeigt den Unterschied zwischen den beiden.

$.widget( "custom.superDialog", $.ui.dialog, {
    _setOption: function( key, value ) {
 
        // Both invoke dialog's setOption() method. _super() requires the arguments
        // be passed as an argument list, _superApply() as a single array.
        this._super( key, value );
        this._superApply( arguments );
    }
});

Widgets neu definieren

jQuery UI 1.9 fügte die Möglichkeit hinzu, Widgets neu zu definieren. Daher müssen wir, anstatt ein neues Widget zu erstellen, nur noch$.widget()einen vorhandenen Widget-Namen und Konstruktor übergeben. Das folgende Beispiel fügtopen()dasselbe Logging zu ... hinzu, aber nicht durch Erstellen eines neuen Widgets.

$.widget( "ui.dialog", $.ui.dialog, {
    open: function() {
        console.log( "open" );
        return this._super();
    }
});
 
$( "<div>" ).dialog();

Durch diese Methode können wir eine vorhandene Widget-Methode erweitern, aber wir können weiterhin verwenden_super()um auf die ursprüngliche Methode zuzugreifen – dies geschieht nicht durch Erstellen eines neuen Widgets, sondern durch direktes Neudefinieren des Widgets.

Widgets und Polymorphismus

Bei der Interaktion zwischen Widget-Erweiterungen und ihren Plugins ist zu beachten, dass das Plugin des übergeordneten Widgets nicht verwendet werden kann, um Methoden auf Elementen untergeordneter Widgets aufzurufen. Das folgende Beispiel veranschaulicht dies.

$.widget( "custom.superDialog", $.ui.dialog, {} );
 
var dialog = $( "<div>" ).superDialog();
 
// This works.
dialog.superDialog( "close" );
 
// This doesn't.
dialog.dialog( "close" );

Im obigen Beispiel, das Plugin des übergeordneten Widgets,dialog(), kann dieclose()-Methode am superDialog-Element nicht aufrufen. Weitere Informationen zum Aufrufen von Widget-Methoden finden Sie unterWidget-Methodenaufrufe。

Anpassen einzelner Instanzen

Bisher wurden bei allen Beispielen, die wir gesehen haben, Methoden am Prototyp des Widgets erweitert. Das Überschreiben von Methoden auf dem Prototyp wirkt sich auf alle Instanzen des Widgets aus.

Um dies zu veranschaulichen, siehe das Beispiel unten. Beide Instanzen des Dialogs verwenden dieselbeopen()Methode.

$.widget( "ui.dialog", $.ui.dialog, {
    open: function() {
        console.log( "open" );
        return this._super();
    }
});
 
// Create two dialogs, both use the same open(), therefore "open" is logged twice.
$( "<div>" ).dialog();
$( "<div>" ).dialog();

Manchmal müssen Sie nur das Verhalten einer einzelnen Instanz eines Widgets ändern. Dazu müssen Sie eine normale JavaScript-Eigenschaftszuweisung verwenden, eine Referenz auf die Instanz abrufen und die Methode überschreiben. Dies wird im folgenden Beispiel gezeigt.

var dialogInstance = $( "<div>" )
    .dialog()
    // Retrieve the dialog's instance and store it.
    .data( "ui-dialog" );
 
// Override the close() method for this dialog
dialogInstance.close = function() {
    console.log( "close" );
};
 
// Create a second dialog
$( "<div>" ).dialog();
 
// Select both dialogs and call close() on each of them.
// "close" will only be logged once.
$( ":data(ui-dialog)" ).dialog( "close" );

Die Technik des Überschreibens von Methoden für eine einzelne Instanz eignet sich perfekt für einmalige Anpassungen.

Andere Erweiterungen