JqueryUI - Фабрика виджетов

Раньше единственным способом написания пользовательских элементов управления в jQuery было расширение пространства имен $ .fn . Это хорошо работает для простых виджетов. Предположим, вы создаете больше виджетов с отслеживанием состояния, это быстро становится громоздким. Чтобы помочь в процессе создания виджетов, в пользовательском интерфейсе jQuery была представлена ​​Widget Factory, которая удаляет большую часть шаблонов, которые обычно связаны с управлением виджетами.

Фабрика виджетов jQueryUI - это просто функция ($ .widget), которая принимает имя строки и объект в качестве аргументов и создает подключаемый модуль jQuery и «Класс» для инкапсуляции его функциональности.

Синтаксис

Ниже приведен синтаксис метода фабрики виджетов jQueryUI:

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

name- Это строка, содержащая пространство имен и имя виджета (разделенное точкой) создаваемого виджета.

base- Базовый виджет для наследования. Это должен быть конструктор, который можно создать с помощью ключевого слова `new`. По умолчанию jQuery.Widget .

prototype- Объект, который будет использоваться в качестве прототипа для наследования виджета. Например, пользовательский интерфейс jQuery имеет подключаемый модуль «мышь», на котором основаны остальные подключаемые модули взаимодействия. Для этого перетаскиваемые, отбрасываемые и т. Д. Все наследуются от плагина мыши следующим образом: jQuery.widget ("ui.draggable", $ .ui.mouse, {...}); Если вы не укажете этот аргумент, виджет будет наследовать непосредственно от «базового виджета» jQuery.Widget (обратите внимание на разницу между строчными буквами «w» jQuery.widget и прописными буквами «W» jQuery.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 . Он вызывается для каждой отдельной опции, которую устанавливает пользователь. Здесь мы устанавливаем ширину и цвет фона кнопки.

<!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, который сдвигает кнопку на заданное расстояние по горизонтали. Чтобы это работало, нам также необходимо установить свойства position и left в функции _create -

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

В этом случае событие называется outbounds, и пустой объект события передается с настраиваемым объектом события, который просто предоставляет позицию как свое единственное свойство.

Вся функция перемещения -

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, откроется окно с предупреждением.