JqueryUI - 小部件工厂

早些时候，在 jQuery 中编写自定义控件的唯一方法是扩展 $.fn 命名空间。 这适用于简单的小部件。 假设您构建更多有状态的小部件，它很快就会变得很麻烦。 为了帮助构建小部件的过程，在 jQuery UI 中引入了小部件工厂，它删除了通常与管理小部件相关联的大部分样板。

jQueryUI Widget Factory 只是一个函数（$.widget），它将一个字符串名称和一个对象作为参数，并创建一个 jQuery 插件和一个"类"来封装其功能。

语法

以下是 jQueryUI Widget Factory 方法的语法 −

jQuery.widget( name [, base ], prototype )

name − 它是一个字符串，包含要创建的小部件的名称空间 和小部件名称（以点分隔）。

base − The base widget to inherit from. This must be a constructor that can be instantiated with the `new` keyword. Defaults to jQuery.Widget.

prototype − 用作小部件继承自的原型的对象。 例如，jQuery UI 有一个"mouse"鼠标插件，其余的交互插件都基于该插件。为了实现这一点，draggable, droppable, 等都像这样继承自鼠标插件: jQuery.widget( "ui.draggable", $.ui.mouse, {...} ); 如果不提供此参数，小部件将直接继承自"基础小部件"jQuery.Widget（注意小写"w"jQuery.widget 和大写"W"jQuery.Widget 之间的区别）。

基础小部件

Base widget是widget factory使用的widget。

选项

下表列出了可与基本小部件一起使用的不同选项 −

$( ".selector" ).widget({ disabled: true });

$( ".selector" ).widget({ hide: { effect: "explode", duration: 1000 } });

$( ".selector" ).widget({ show: { effect: "explode", duration: 1000 } });

方法

下表列出了可与基本小部件一起使用的不同方法 −

_create: function() {
   this.element.css( "background-color", this.options.color );
}

this._delay( this._foo, 100 );

_destroy: function() {
   this.element.removeClass( "my-widget" );
}

_create: function() {
   this._focusable( this.element.find( ".my-items" ) );
}

_getCreateEventData: function() {
   return this.options;
}

_getCreateOptions: function() {
   return { id: this.element.attr( "id" ) };
}

this._hide( this.element, this.options.hide, function() {
   $( this ).remove();
});

this._hoverable( this.element.find( "div" ) );

_init: function() {
   if ( this.options.autoOpen ) {
      this.open();
   }
}

this._off( this.element, "click" );

this._on( this.element, {
   "click a": function( event ) {
      event.preventDefault();
   }
});

_setOption: function( key, value ) {
   if ( key === "width" ) {
      this.element.width( value );
   }
   if ( key === "height" ) {
      this.element.height( value );
   }
   this._super( key, value );
}

_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();
   }
}

_this._show( this.element, this.options.show, function() {
   // Focus the element when it's fully visible.
   this.focus();
}

_setOption: function( key, value ) {
   if ( key === "title" ) {
      this.element.find( "h3" ).text( value );
   }
   this._super( key, value );
}

_setOption: function( key, value ) {
   if ( key === "title" ) {
      this.element.find( "h3" ).text( value );
   }
   this._superApply( arguments );
}

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()
      });
   }
});

this._on( this.element, {
   "click a": function( event ) {
      event.preventDefault();
      this.destroy();
   }
});

this._on( this.element, {
   "click a": function( event ) {
      event.preventDefault();
      this.disable();
   }
});

this._on( this.element, {
   "click a": function( event ) {
      event.preventDefault();
      this.enable();
   }
});

this.option( "width" );

var options = this.option();
for ( var key in options ) {
   console.log( key, options[ key ] );
}

this.option( "width", 500 );

this.option({
   width: 500,
   height: 500
});

_create: function() {
   this.widget().css( "border", "2px solid red" );
}

事件

$( ".selector" ).widget({
   create: function( event, ui ) {}
});

jQueryUI 小部件工厂生命周期

jQueryUI 小部件工厂提供了一种面向对象的方式来管理小部件的生命周期。 这些生命周期活动包括 −

创建和销毁一个小部件:例如，

$( "#elem" ).progressbar();

更改小部件选项:例如

$( "#elem" ).progressbar({ value: 20 });

在子类小部件中进行"超级"调用:例如

$( "#elem" ).progressbar( "value" );
or 
$( "#elem" ).progressbar( "value", 40 );

事件通知:例如

$( "#elem" ).bind( "progressbarchange", function() {
   alert( "The value has changed!" );
});

示例

现在让我们在以下示例中创建一个自定义小部件。 我们将创建一个按钮小部件。 我们将在以下示例中看到如何在小部件中创建选项、方法和事件 −

创建自定义小部件

让我们首先创建一个简单的自定义小部件。

<!DOCTYPE html>
<html>
   <head>
      <meta charset = "utf-8">
      <title>jQuery UI Widget - Default functionality</title>
      <link rel = "stylesheet" href = "//code.jquery.com/ui/1.10.4/themes/smoothness/jquery-ui.css">
      <script src = "https://code.jquery.com/jquery-1.10.2.js"></script>
      <script src = "https://code.jquery.com/ui/1.10.4/jquery-ui.js"></script>
      
      <script>
         $(function() {
            $.widget("iP.myButton", {
               _create: function() { 
                  this._button = $("<button>"); 
                  this._button.text("My first Widget Button");
                  this._button.width(this.options.width) 
                  this._button.css("background-color", this.options.color);    
                  this._button.css("position", "absolute");   
                  this._button.css("left", "100px");            
                  $(this.element).append(this._button);
               },
            });
            $("#button1").myButton();
         });
      </script>
   </head>
   
   <body>
      <div id = "button1"></div>
   </body>
</html>

让我们将上面的代码保存在一个 HTML 文件 widgetfactoryexample.htm 中，并在支持 javascript 的标准浏览器中打开它，您应该会看到以下输出 −

向自定义小部件添加选项

在前面的示例中，我们使用了_create 函数来创建自定义控件。 但用户一般都希望通过设置和修改选项来自定义控件。我们可以定义一个选项对象，它存储您定义的所有选项的默认值。 _setOption 函数用于此目的。 为用户设置的每个单独选项调用它。 这里我们设置按钮的 width 和 background-color。

<!DOCTYPE html>
<html>
   <head>
      <meta charset = "utf-8">
      <title>jQuery UI Widget - Default functionality</title>
      <link rel = "stylesheet" href = "//code.jquery.com/ui/1.10.4/themes/smoothness/jquery-ui.css">
      <script src = "https://code.jquery.com/jquery-1.10.2.js"></script>
      <script src = "https://code.jquery.com/ui/1.10.4/jquery-ui.js"></script>
      
      <script>
         $(function() {
            $.widget("iP.myButton", {
               _create: function() { 
                  this._button = $("<button>"); 
                  this._button.text("My first Widget Button");
                  this._button.width(this.options.width) 
                  this._button.css("background-color", this.options.color);    
                  this._button.css("position", "absolute");   
                  this._button.css("left", "100px");            
                  $(this.element).append(this._button);
               },
               _setOption: function(key, value) { 
                  switch (key) { 
                     case "width": 
                     this._button.width(value); 
                     break; 
                     case "color":
                     this._button.css("background-color",value);
                     break; 
                  } 
               },
            });
            $("#button2").myButton();
            $("#button2").myButton("option", {width:100,color:"#cedc98"});
         });
      </script>
   </head>
   
   <body>
      <div id = "button2"></div>
   </body>
</html>

让我们将上面的代码保存在一个 HTML 文件 widgetfactoryexample.htm 中，并在支持 javascript 的标准浏览器中打开它，您应该会看到以下输出 −

向自定义小部件添加方法

在下面的示例中，我们将添加用户可以使用的方法，这些方法很容易构建到框架中。 我们将编写一个 Move 方法，将按钮移动指定的水平距离。 为了让它工作，我们还需要在 _create 函数中设置 position 和 left 属性 −

this._button.css("position", "absolute");   
this._button.css("left", "100px");  

在此之后，用户现在可以以通常的 jQuery UI 方式调用您的方法 −

this._button.css("position", "absolute");   
this._button.css("left", "100px");  

$("button3").myButton("move", 200);

<!DOCTYPE html>
<html>
   <head>
      <meta charset = "utf-8">
      <title>jQuery UI Widget - Default functionality</title>
      <link rel = "stylesheet" href = "//code.jquery.com/ui/1.10.4/themes/smoothness/jquery-ui.css">
      <script src = "https://code.jquery.com/jquery-1.10.2.js"></script>
      <script src = "https://code.jquery.com/ui/1.10.4/jquery-ui.js"></script>

      <script>
         $(function() {
            $.widget("iP.myButton", {
               _create: function() { 
                  this._button = $("<button>"); 
                  this._button.text("My first Widget Button");
                  this._button.width(this.options.width) 
                  this._button.css("background-color", this.options.color);    
                  this._button.css("position", "absolute");   
                  this._button.css("left", "100px");            
                  $(this.element).append(this._button);
               },
         
               move: function(dx) { 
                  var x = dx + parseInt(this._button.css("left")); 
                  this._button.css("left", x); 
                  if(x>400) { this._trigger("outbounds",{},  {position:x}); }
               }
            });
            $("#button3").myButton();
            $("#button3").myButton("move", 200);
         });
      </script>
   </head>
   
   <body>
      <div id = "button3"></div>
   </body>
</html>

让我们将上面的代码保存在一个 HTML 文件 widgetfactoryexample.htm 中，并在支持 javascript 的标准浏览器中打开它，您应该会看到以下输出 −

向自定义小部件添加事件

在此示例中，我们将演示如何创建事件。 要创建一个事件，您所要做的就是使用 _trigger 方法。 第一个参数是事件的名称，第二个参数是您要传递的任何标准事件对象，第三个是您要传递的任何自定义事件对象。

这里我们在按钮移动超过 x=400 时触发一个事件。 您所要做的就是添加移动功能 −

if(x<400) { this._trigger("outbounds",{}, {position:x}); }

在这种情况下，该事件称为出站，并且一个空事件对象与一个自定义事件对象一起传递，该对象仅将位置作为其唯一属性提供。

整个移动函数是 −

move: function(dx) {
   var x = dx + parseInt(this._button.css("left")); 
   this._button.css("left", x); 
   if(x<400) { this._trigger("outbounds",{}, {position:x}); }
}

用户只需定义同名选项即可设置事件处理函数。

$("button4").myButton("option", {
   width: 100, 
   color: "red",
   outbounds:function(e,ui) {
      alert(ui.position);}
});

<!DOCTYPE html>
<html>
   <head>
      <meta charset = "utf-8">
      <title>jQuery UI Widget - Default functionality</title>
      <link rel = "stylesheet" href = "//code.jquery.com/ui/1.10.4/themes/smoothness/jquery-ui.css">
      <script src = "https://code.jquery.com/jquery-1.10.2.js"></script>
      <script src = "https://code.jquery.com/ui/1.10.4/jquery-ui.js"></script>
      
      <script>
         $(function() {
            $.widget("iP.myButton", {
               _create: function() { 
                  this._button = $("<button>"); 
                  this._button.text("My first Widget Button");
                  this._button.width(this.options.width) 
                  this._button.css("background-color", this.options.color);    
                  this._button.css("position", "absolute");   
                  this._button.css("left", "100px");            
                  $(this.element).append(this._button);
               },
               move: function(dx) { 
                  var x = dx + parseInt(this._button.css("left")); 
                  this._button.css("left", x); 
                  if(x>400) { this._trigger("outbounds",{},  {position:x}); }
               }
            });
            $("#button4").myButton();
            $("#button4").on("mybuttonoutbounds", function(e, ui) {
               //alert("out");
            });
            $("#button4").myButton("move", 500);
         });
      </script>
   </head>
   
   <body>
      <div id = "button4"></div>
   </body>
</html>

让我们将上面的代码保存在一个 HTML 文件 widgetfactoryexample.htm 中并在支持 javascript 的标准浏览器中打开它，一个警告框打开。