jQuery UI API - Part Gallery (Widget Factory)
kategori
Utilitas (Utilities) | widget (Widgets)
jQuery.widget (nama [, basis], prototipe) Penggunaan
Keterangan: Gunakan semua widget jQuery UI dengan abstraksi yang sama untuk membuat stateful jQuery Plugin.
参数 | 类型 | 类型 |
---|---|---|
name | String | 要创建的小部件名称,包括命名空间。 |
base | Function() | 要继承的基础小部件。必须是一个可以使用 `new` 关键词实例化的构造函数。默认为 jQuery.Widget。 |
prototype | PlainObject | 要作为小部件原型使用的对象。 |
Anda dapat menggunakan $.Widget
objek untuk dasar warisan, atau mungkin secara eksplisit atau jQuery UI dari kontrol pihak ketiga yang ada, dibuat dari awal widget baru. Definisi widget dengan nama yang sama untuk mewarisi anggota dasar, dan bahkan memungkinkan Anda untuk benar memperluas widget.
jQuery UI mencakup banyak memegang bagian-bagian kecil, sehingga dari jQuery khas Plugin pola penggunaan yang sedikit berbeda. Semua widget jQuery UI menggunakan model yang sama, yang terdiri dari anggota perpustakaan (Widget Factory) definisi. Jadi, selama Anda belajar bagaimana menggunakan satu, Anda tahu bagaimana menggunakan widget lain (Widget).
Catatan: Bagian ini menggunakan anggota progress bar (Progressbar Widget) Demonstrasi, tetapi sintaks diterapkan untuk setiap widget.
inisialisasi
Dalam rangka untuk melacak keadaan widget, kita harus memperkenalkan siklus hidup seluruh widget. siklus hidup dimulai ketika inisialisasi widget. Untuk menginisialisasi widget, kita hanya perlu menyambungkan panggilan atau pluralitas elemen.
$ ( "#elem") .progressbar ();
Ini akan menginisialisasi objek jQuery untuk setiap elemen. Contoh unsur-unsur di atas dengan id "elem"
.
Pilihan
Sejak progressbar()
tanpa parameter ketika Anda menelepon, widget diinisialisasi menggunakan pilihan default. Kami dapat melewati serangkaian pilihan untuk menimpa default dalam pilihan inisialisasi:
$ ( "#elem") .progressbar ({Nilai: 20});
Kita mungkin harus lulus sesuai dengan jumlah pilihan, kita tidak lulus salah satu pilihan adalah dengan menggunakan nilai standar.
Anda dapat melewati beberapa pilihan parameter yang akan digabung menjadi satu objek (seperti $.extend( true, target, object1, objectN )
). Jumlah ini diatur untuk mencakup semua hal, berbagi antara contoh opsi berguna:
Pilihan var = {modal: true, menunjukkan: "lambat"}; $ ( "# Dialog1") .dialog (pilihan); $ ( "# Dialog2") .dialog (pilihan, {AutoOpen: false});
Semua pilihan yang disampaikan selama copy dalam inisialisasi, memastikan tindak lanjut tidak mempengaruhi sebagian kecil dari kasus ini untuk memodifikasi objek. Array adalah satu-satunya pengecualian, karena mereka dengan referensi. Pengecualian untuk ini adalah untuk benar mendukung data yang mengikat, dimana sumber data harus digunakan sebagai acuan.
Nilai default disimpan dalam sifat-sifat widget, sehingga kami dapat menutupi nilai pengaturan jQuery UI. Misalnya, setelah pengaturan berikut, semua contoh masa depan progress bar akan default ke nilai 80:
$ .ui.progressbar.prototype.options.value = 80;
Pilihan adalah bagian dari negara anggota kecil, sehingga kami juga dapat mengatur opsi setelah inisialisasi. Kami akan melihat opsi dalam metode berikutnya.
cara
Sekarang widget telah diinisialisasi, kita bisa query status, atau melakukan tindakan pada widget. Semua tindakan didasarkan pada setelah metode inisialisasi dipanggil untuk melakukan. Untuk memanggil metode pada widget, kami melewati nama metode untuk plugin jQuery. Sebagai contoh, menyerukan anggota progress bar (Progressbar Widget) value()
metode, kita bisa menggunakan:
$ ( "#elem") .progressbar ( "Nilai");
Jika metode ini membutuhkan parameter, kita dapat melewati parameter setelah nama metode. Misalnya, untuk lulus parameter 40
ke value()
metode, kita bisa menggunakan:
$ ( "#elem") .progressbar ( "Nilai", 40);
Seperti jQuery dengan cara lain, metode yang paling widget mengembalikan sebuah objek jQuery:
$ ( "#elem") .progressbar ( "value", 90) .addClass ( "hampir-dilakukan");
Setiap widget memiliki pengaturan metode sendiri, yang didasarkan pada fungsi yang disediakan oleh widget. Namun, ada beberapa cara yang hadir pada semua bagian-bagian kecil, yang akan dijelaskan secara rinci di bawah.
peristiwa
Semua widget dan mereka memiliki berbagai acara terkait perilaku untuk memberitahu Anda ketika perubahan negara. Untuk sebagian kecil, ketika acara ini dipicu, nama dalam huruf kecil dalam bentuk nama widget sebagai awalan. Sebagai contoh, kita dapat mengikat progress bar change
acara, yang dipicu ketika perubahan nilai.
$ ( "#elem") .bind ( "Progressbarchange", function () { alert ( "Nilai telah berubah!"); });
Setiap acara memiliki mundurnya sesuai, yang sebagai pilihan. Jika perlu, kita dapat memahami kemajuan change
callback, daripada mengikat progressbarchange
acara.
$ ( "#elem") .progressbar ({ mengubah: function () { alert ( "Nilai telah berubah!"); } });
Semua widget memiliki change
acara, yang dipicu ketika dipakai.
Instansiasi
Contoh widget adalah dengan menggunakan nama lengkap dengan sebagian kecil sebagai kunci jQuery.data()
toko. Oleh karena itu, Anda dapat menggunakan kode berikut dari elemen untuk mengambil anggota progress bar (Progressbar Widget) contoh objek.
$ ( "#elem") DATA ( "Ui-progressbar");
Apakah unsur ini terikat untuk widget yang diberikan, Anda dapat menggunakan :data
seleksi untuk mendeteksi.
$ ( "#elem") .is ( ": Data ( 'ui-progressbar')"); // benar $ ( "#elem") .is ( ": Data ( 'ui-draggable')"); // false
Anda juga dapat menggunakan :data
untuk mendapatkan daftar widget yang diberikan sebagai contoh semua elemen.
$ ( ": Data ( 'ui-progressbar')");
milik
Semua widget memiliki atribut sebagai berikut:
- defaultElement: elemen ketika membangun widget contoh elemen Tersedia untuk digunakan. Misalnya, karena progress bar
defaultElement
adalah"<div>
",$.ui.progressbar({ value: 50 })
dalam baru<div>
pada contoh dari progress bar widget misalnya. - Dokumen: bagian-bagian kecil dalam elemen
document
. Berguna jika Anda perlu untuk berinteraksi dengan dalam rangka widget. - elemen: sebuah objek jQuery yang berisi elemen yang digunakan untuk instantiate widget. Jika Anda memilih beberapa elemen dan memanggil
.myWidget()
, Anda akan membuat sebuah instance widget tunggal setiap elemen. Oleh karena itu, properti selalu mengandung unsur. - namespace: Lokasi widget prototipe toko global yang objek jQuery. Misalnya,
"ui"
sebuahnamespace
merupakan bagian prototipe kecil disimpan dalam$.ui
. - Pilihan: pilihan untuk menggunakan objek saat ini berisi widget. Ketika dipakai, salah satu opsi yang diberikan oleh pengguna akan secara otomatis dan
$.myNamespace.myWidget.prototype.options
menggabungkan default didefinisikan. Pilihan pengguna-ditentukan menimpa nilai default. - uuid: pengenal bilangan bulat unik menunjukkan kontrol.
- Versi: string versi widget. Untuk widget jQuery UI, properti akan ditetapkan ke versi widget jQuery UI digunakan. Plug-in pengembang harus secara eksplisit mengatur properti dari prototipe mereka.
- widgetEventPrefix: Tambahkan widget untuk nama awalan acara. Sebagai contoh, dapat drag dan drop widget (Draggable Widget) dari
widgetEventPrefix
adalah"drag"
, jadi ketika Anda membuat draggable, nama acara ini"dragcreate"
. Secara default, widgetwidgetEventPrefix
adalah namanya. Catatan: Properti ini telah ditinggalkan, di rilis yang sangat masa depan. Nama acara diubah menjadi widgetName: EVENTNAME (seperti"draggable:create"
). - widgetFullName: widget berisi nama lengkap namespace. Untuk
$.widget( "myNamespace.myWidget", {} )
,widgetFullName
akan"myNamespace-myWidget"
. - widgetName: nama widget. Untuk
$.widget( "myNamespace.myWidget", {} )
,widgetName
akan"myWidget"
. - window: mengandung bagian-bagian kecil dalam elemen
window
. Berguna jika Anda perlu untuk berinteraksi dengan dalam rangka widget.
jQuery.Widget penggunaan secara widget
Keterangan: Basis widget widget perpustakaan (Widget Factory) digunakan.
navigasi cepat
选项 | 方法 | 事件 |
---|---|---|
选项 | 类型 | 描述 | 默认值 |
---|---|---|---|
disabled | Boolean | 如果设置为 true ,则禁用该小部件。代码实例: 初始化带有指定 $( ".selector" ).widget({ disabled: true }); 在初始化后,获取或设置 // getter var disabled = $( ".selector" ).widget( "option", "disabled" ); // setter $( ".selector" ).widget( "option", "disabled", true ); |
false |
hide | Boolean 或 Number 或 String 或 Object | 是否使用动画隐藏元素,以及如何动画隐藏元素。 支持多个类型:
代码实例: 初始化带有指定 $( ".selector" ).widget({ hide: { effect: "explode", duration: 1000 } }); 在初始化后,获取或设置 // getter var hide = $( ".selector" ).widget( "option", "hide" ); // setter $( ".selector" ).widget( "option", "hide", { effect: "explode", duration: 1000 } ); |
null |
show | Boolean 或 Number 或 String 或 Object | 是否使用动画显示元素,以及如何动画显示元素。 支持多个类型:
代码实例: 初始化带有指定 $( ".selector" ).widget({ show: { effect: "blind", duration: 800 } }); 在初始化后,获取或设置 // getter var show = $( ".selector" ).widget( "option", "show" ); // setter $( ".selector" ).widget( "option", "show", { effect: "blind", duration: 800 } ); |
null |
方法 | 返回 | 描述 |
---|---|---|
_create() | jQuery (plugin only) | _create() 方法是小部件的构造函数。没有参数,但是 this.element 和 this.options 已经设置。
代码实例: 基于一个选项设置小部件元素的背景颜色。 _create: function() { this.element.css( "background-color", this.options.color ); } |
_delay( fn [, delay ] ) | Number | 在指定延迟后调用提供的函数。保持 this 上下文正确。本质上是 setTimeout() 。使用 clearTimeout() 返回超时 ID。
代码实例: 100 毫秒后在小部件上调用 this._delay( this._foo, 100 ); |
_destroy() | jQuery (plugin only) | 公共的 destroy() 方法清除所有的公共数据、事件等等。代表了定制、指定小部件、清理的 _destroy() 。
代码实例: 当小部件被销毁时,从小部件的元素移除一个 class。 _destroy: function() { this.element.removeClass( "my-widget" ); } |
_focusable( element ) | jQuery (plugin only) | 建立聚焦在元素上时要应用 ui-state-focus class 的 element 。
代码实例: 向小部件内的一组元素应用 focusable 样式: this._focusable( this.element.find( ".my-items" ) ); |
_getCreateEventData() | Object | 所有的小部件触发 create 事件。默认情况下,事件中不提供任何的数据,但是该方法会返回一个对象,作为 create 事件的数据被传递。
代码实例: 向 _getCreateEventData: function() { return this.options; } |
_getCreateOptions() | Object | 该方法允许小部件在初始化期间为定义选项定义一个自定义的方法。用户提供的选项会覆盖该方法返回的选项,即会覆盖默认的选项。
代码实例: 让小部件元素的 id 属性作为选项可用。 _getCreateOptions: function() { return { id: this.element.attr( "id" ) }; } |
_hide( element, option [, callback ] ) | jQuery (plugin only) | 使用内置的动画方法或使用自定义的特效隐藏一个元素。如需了解可能的 option 值,请查看 hide 。
代码实例: 为自定义动画传递 this._hide( this.element, this.options.hide, function() { // Remove the element from the DOM when it's fully hidden. $( this ).remove(); }); |
_hoverable( element ) | jQuery (plugin only) | 建立悬浮在元素上时要应用 ui-state-hover class 的 element 。事件处理程序在销毁时自动清理。
代码实例: 当悬浮在元素上时,向元素内所有的 this._hoverable( this.element.find( "div" ) ); |
_init() | jQuery (plugin only) | 小部件初始化的理念与创建不同。任何时候不带参数的调用插件或者只带一个选项哈希的调用插件,初始化小部件。当小部件被创建时会包含这个方法。
注释:如果存在不带参数成功调用小部件时要执行的逻辑动作,初始化只能在这时处理。
代码实例: 如果设置了 _init: function() { if ( this.options.autoOpen ) { this.open(); } } |
_off( element, eventName ) | jQuery (plugin only) | 从指定的元素取消绑定事件处理程序。
代码实例: 从小部件的元素上取消绑定所有 click 事件。 this._off( this.element, "click" ); |
_on( [suppressDisabledCheck ] [, element ], handlers ) | jQuery (plugin only) | 授权通过事件名称内的选择器被支持,例如 "click .foo" 。 _on() 方法提供了一些直接事件绑定的好处:
代码实例: 放置小部件元素内所有被点击的链接的默认行为。 this._on( this.element, { "click a": function( event ) { event.preventDefault(); } }); |
_setOption( key, value ) | jQuery (plugin only) | 为每个独立的选项调用 _setOptions() 方法。小部件状态随着改变而更新。
代码实例: 当小部件的 _setOption: function( key, value ) { if ( key === "width" ) { this.element.width( value ); } if ( key === "height" ) { this.element.height( value ); } this._super( key, value ); } |
_setOptions( options ) | jQuery (plugin only) | 当调用 option() 方法时调用,无论以什么形式调用 option() 。如果您要根据多个选项的改变而改变处理器密集型,重载该方法是很有用的。
代码实例: 如果小部件的 _setOptions: function( options ) { var that = this, resize = false; $.each( options, function( key, value ) { that._setOption( key, value ); if ( key === "height" || key === "width" ) { resize = true; } }); if ( resize ) { this.resize(); } } |
_show( element, option [, callback ] ) | jQuery (plugin only) | 使用内置的动画方法或使用自定义的特效显示一个元素。如需了解可能的 option 值,请查看 show 。
代码实例: 为自定义动画传递 this._show( this.element, this.options.show, function() { // Focus the element when it's fully visible. this.focus(); } |
_super( [arg ] [, ... ] ) | jQuery (plugin only) | 从父部件中调用相同名称的方法,带有任意指定的参数。本质上是 .call() 。
代码实例: 处理 _setOption: function( key, value ) { if ( key === "title" ) { this.element.find( "h3" ).text( value ); } this._super( key, value ); } |
_superApply( arguments ) | jQuery (plugin only) | 从父部件中调用相同名称的方法,带有参数的数组。本质上是 .apply() 。
代码实例: 处理 _setOption: function( key, value ) { if ( key === "title" ) { this.element.find( "h3" ).text( value ); } this._superApply( arguments ); } |
_trigger( type [, event ] [, data ] ) | Boolean | 触发一个事件及其相关的回调。带有该名称的选项与作为回调被调用的类型相等。 事件名称是小部件名称和类型的小写字母串。 注释:当提供数据时,您必须提供所有三个参数。如果没有传递事件,则传递 如果默认行为是阻止的,则返回
代码实例: 当按下一个键时,触发 this._on( this.element, { keydown: function( event ) { // Pass the original event so that the custom search event has // useful information, such as keyCode this._trigger( "search", event, { // Pass additional information unique to this event value: this.element.val() }); } }); |
destroy() | jQuery (plugin only) | 完全移除小部件功能。这会把元素返回到它的预初始化状态。
代码实例: 当点击小部件的任意锚点时销毁小部件。 this._on( this.element, { "click a": function( event ) { event.preventDefault(); this.destroy(); } }); |
disable() | jQuery (plugin only) | 禁用小部件。
代码实例: 当点击小部件的任意锚点时禁用小部件。 this._on( this.element, { "click a": function( event ) { event.preventDefault(); this.disable(); } }); |
enable() | jQuery (plugin only) | 启用小部件。
代码实例: 当点击小部件的任意锚点时启用小部件。 this._on( this.element, { "click a": function( event ) { event.preventDefault(); this.enable(); } }); |
option( optionName ) | Object | 获取当前与指定的 optionName 关联的值。
代码实例: 获得 this.option( "width" ); |
option() | PlainObject | 获取一个包含键/值对的对象,键/值对表示当前小部件选项哈希。
代码实例: 记录每个小部件选项的键/值对,用于调试。 var options = this.option(); for ( var key in options ) { console.log( key, options[ key ] ); } |
option( optionName, value ) | jQuery (plugin only) | 设置与指定的 optionName 关联的小部件选项的值。
代码实例: 设置 this.option( "width", 500 ); |
option( options ) | jQuery (plugin only) | 为小部件设置一个或多个选项。
代码实例: 设置 this.option({ width: 500, height: 500 }); |
widget() | jQuery | 返回一个包含原始元素或其他相关的生成元素的 jQuery 对象。
代码实例: 当创建小部件时,在小部件的原始元素周围放置一个红色的边框。 _create: function() { this.widget().css( "border", "2px solid red" ); } |
事件 | 类型 | 描述 |
---|---|---|
create( event, ui ) | widgetcreate | 当小部件被创建时触发。
注意: 代码实例: 初始化带有指定 create 回调的小部件: $( ".selector" ).widget({ create: function( event, ui ) {} }); 绑定一个事件监听器到 widgetcreate 事件: $( ".selector" ).on( "widgetcreate", function( event, ui ) {} ); |