X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/source/ClickRepeater.html diff --git a/docs/source/ClickRepeater.html b/docs/source/ClickRepeater.html index bad9e112..60d9686a 100644 --- a/docs/source/ClickRepeater.html +++ b/docs/source/ClickRepeater.html @@ -1,5 +1,22 @@ -Sencha Documentation Project
/**
- * @class Ext.util.ClickRepeater
+
+
+
+  
+  The source code
+  
+  
+  
+  
+
+
+  
/**
+ * @class Ext.util.ClickRepeater
  * @extends Ext.util.Observable
  *
  * A wrapper class which can be applied to any element. Fires a "click" event while the
@@ -8,14 +25,15 @@
  *
  * Optionally, a CSS class may be applied to the element during the time it is pressed.
  *
- * @constructor
- * @param {Mixed} el The element to listen on
- * @param {Object} config
  */
-
 Ext.define('Ext.util.ClickRepeater', {
     extend: 'Ext.util.Observable',
 
+    /**
+     * Creates new ClickRepeater.
+     * @param {String/HTMLElement/Ext.Element} el The element or its ID to listen on
+     * @param {Object} config (optional) Config object.
+     */
     constructor : function(el, config){
         this.el = Ext.get(el);
         this.el.unselectable();
@@ -23,21 +41,21 @@ Ext.define('Ext.util.ClickRepeater', {
         Ext.apply(this, config);
 
         this.addEvents(
-        /**
+        /**
          * @event mousedown
          * Fires when the mouse button is depressed.
          * @param {Ext.util.ClickRepeater} this
          * @param {Ext.EventObject} e
          */
         "mousedown",
-        /**
+        /**
          * @event click
          * Fires on a specified interval during the time the element is pressed.
          * @param {Ext.util.ClickRepeater} this
          * @param {Ext.EventObject} e
          */
         "click",
-        /**
+        /**
          * @event mouseup
          * Fires when the mouse key is released.
          * @param {Ext.util.ClickRepeater} this
@@ -59,42 +77,42 @@ Ext.define('Ext.util.ClickRepeater', {
         this.callParent();
     },
 
-    /**
-     * @cfg {Mixed} el The element to act as a button.
+    /**
+     * @cfg {String/HTMLElement/Ext.Element} el The element to act as a button.
      */
 
-    /**
+    /**
      * @cfg {String} pressedCls A CSS class name to be applied to the element while pressed.
      */
 
-    /**
+    /**
      * @cfg {Boolean} accelerate True if autorepeating should start slowly and accelerate.
      * "interval" and "delay" are ignored.
      */
 
-    /**
+    /**
      * @cfg {Number} interval The interval between firings of the "click" event. Default 20 ms.
      */
     interval : 20,
 
-    /**
+    /**
      * @cfg {Number} delay The initial delay before the repeating event begins firing.
      * Similar to an autorepeat key delay.
      */
     delay: 250,
 
-    /**
+    /**
      * @cfg {Boolean} preventDefault True to prevent the default click event
      */
     preventDefault : true,
-    /**
+    /**
      * @cfg {Boolean} stopDefault True to stop the default click event
      */
     stopDefault : false,
 
     timer : 0,
 
-    /**
+    /**
      * Enables the repeater and allows events to fire.
      */
     enable: function(){
@@ -110,7 +128,7 @@ Ext.define('Ext.util.ClickRepeater', {
         this.disabled = false;
     },
 
-    /**
+    /**
      * Disables the repeater and stops events from firing.
      */
     disable: function(/* private */ force){
@@ -125,7 +143,7 @@ Ext.define('Ext.util.ClickRepeater', {
         this.disabled = true;
     },
 
-    /**
+    /**
      * Convenience function for setting disabled/enabled by boolean.
      * @param {Boolean} disabled
      */
@@ -229,4 +247,6 @@ Ext.define('Ext.util.ClickRepeater', {
         this.fireEvent("mouseup", this, e);
     }
 });
-
\ No newline at end of file +
+ +