X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/f5240829880f87e0cf581c6a296e436fdef0ef80..HEAD:/docs/source/ClickRepeater.html?ds=sidebyside diff --git a/docs/source/ClickRepeater.html b/docs/source/ClickRepeater.html index 743ddb4b..60d9686a 100644 --- a/docs/source/ClickRepeater.html +++ b/docs/source/ClickRepeater.html @@ -1,48 +1,39 @@ +
- +/*! - * Ext JS Library 3.3.0 - * Copyright(c) 2006-2010 Ext JS, Inc. - * licensing@extjs.com - * http://www.extjs.com/license - */ -/** - @class Ext.util.ClickRepeater - @extends Ext.util.Observable - - A wrapper class which can be applied to any element. Fires a "click" event while the - mouse is pressed. The interval between firings may be specified in the config but - defaults to 20 milliseconds. - - Optionally, a CSS class may be applied to the element during the time it is pressed. - - @cfg {Mixed} el The element to act as a button. - @cfg {Number} delay The initial delay before the repeating event begins firing. - Similar to an autorepeat key delay. - @cfg {Number} interval The interval between firings of the "click" event. Default 20 ms. - @cfg {String} pressClass 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 {Boolean} preventDefault True to prevent the default click event - @cfg {Boolean} stopDefault True to stop the default click event - - @history - 2007-02-02 jvs Original code contributed by Nige "Animal" White - 2007-02-02 jvs Renamed to ClickRepeater - 2007-02-03 jvs Modifications for FF Mac and Safari - - @constructor - @param {Mixed} el The element to listen on - @param {Object} config + +- \ No newline at end of file +/** + * @class Ext.util.ClickRepeater + * @extends Ext.util.Observable + * + * A wrapper class which can be applied to any element. Fires a "click" event while the + * mouse is pressed. The interval between firings may be specified in the config but + * defaults to 20 milliseconds. + * + * Optionally, a CSS class may be applied to the element during the time it is pressed. + * */ -Ext.util.ClickRepeater = Ext.extend(Ext.util.Observable, { - +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(); @@ -50,27 +41,27 @@ Ext.util.ClickRepeater = Ext.extend(Ext.util.Observable, { Ext.apply(this, config); this.addEvents( - /** - * @event mousedown + /** + * @event mousedown * Fires when the mouse button is depressed. * @param {Ext.util.ClickRepeater} this * @param {Ext.EventObject} e */ - "mousedown", - /** - * @event click + "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 + "click", + /** + * @event mouseup * Fires when the mouse key is released. * @param {Ext.util.ClickRepeater} this * @param {Ext.EventObject} e */ - "mouseup" + "mouseup" ); if(!this.disabled){ @@ -80,20 +71,49 @@ Ext.util.ClickRepeater = Ext.extend(Ext.util.Observable, { // allow inline handler if(this.handler){ - this.on("click", this.handler, this.scope || this); + this.on("click", this.handler, this.scope || this); } - Ext.util.ClickRepeater.superclass.constructor.call(this); + this.callParent(); }, - + + /** + * @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. + /** + * Enables the repeater and allows events to fire. */ enable: function(){ if(this.disabled){ @@ -108,14 +128,14 @@ Ext.util.ClickRepeater = Ext.extend(Ext.util.Observable, { this.disabled = false; }, - /** - * Disables the repeater and stops events from firing. + /** + * Disables the repeater and stops events from firing. */ disable: function(/* private */ force){ if(force || !this.disabled){ clearTimeout(this.timer); - if(this.pressClass){ - this.el.removeClass(this.pressClass); + if(this.pressedCls){ + this.el.removeCls(this.pressedCls); } Ext.getDoc().un('mouseup', this.handleMouseUp, this); this.el.removeAllListeners(); @@ -123,8 +143,8 @@ Ext.util.ClickRepeater = Ext.extend(Ext.util.Observable, { this.disabled = true; }, - /** - * Convenience function for setting disabled/enabled by boolean. + /** + * Convenience function for setting disabled/enabled by boolean. * @param {Boolean} disabled */ setDisabled: function(disabled){ @@ -144,44 +164,49 @@ Ext.util.ClickRepeater = Ext.extend(Ext.util.Observable, { destroy : function() { this.disable(true); Ext.destroy(this.el); - this.purgeListeners(); + this.clearListeners(); }, handleDblClick : function(e){ clearTimeout(this.timer); this.el.blur(); - this.fireEvent("mousedown", this, e); - this.fireEvent("click", this, e); + this.fireEvent("mousedown", this, e); + this.fireEvent("click", this, e); }, // private handleMouseDown : function(e){ clearTimeout(this.timer); this.el.blur(); - if(this.pressClass){ - this.el.addClass(this.pressClass); + if(this.pressedCls){ + this.el.addCls(this.pressedCls); } this.mousedownTime = new Date(); - Ext.getDoc().on("mouseup", this.handleMouseUp, this); - this.el.on("mouseout", this.handleMouseOut, this); + Ext.getDoc().on("mouseup", this.handleMouseUp, this); + this.el.on("mouseout", this.handleMouseOut, this); - this.fireEvent("mousedown", this, e); - this.fireEvent("click", this, e); + this.fireEvent("mousedown", this, e); + this.fireEvent("click", this, e); // Do not honor delay or interval if acceleration wanted. if (this.accelerate) { this.delay = 400; } - this.timer = this.click.defer(this.delay || this.interval, this, [e]); + + // Re-wrap the event object in a non-shared object, so it doesn't lose its context if + // the global shared EventObject gets a new Event put into it before the timer fires. + e = new Ext.EventObjectImpl(e); + + this.timer = Ext.defer(this.click, this.delay || this.interval, this, [e]); }, // private click : function(e){ - this.fireEvent("click", this, e); - this.timer = this.click.defer(this.accelerate ? - this.easeOutExpo(this.mousedownTime.getElapsed(), + this.fireEvent("click", this, e); + this.timer = Ext.defer(this.click, this.accelerate ? + this.easeOutExpo(Ext.Date.getElapsed(this.mousedownTime), 400, -390, 12000) : @@ -195,17 +220,17 @@ Ext.util.ClickRepeater = Ext.extend(Ext.util.Observable, { // private handleMouseOut : function(){ clearTimeout(this.timer); - if(this.pressClass){ - this.el.removeClass(this.pressClass); + if(this.pressedCls){ + this.el.removeCls(this.pressedCls); } - this.el.on("mouseover", this.handleMouseReturn, this); + this.el.on("mouseover", this.handleMouseReturn, this); }, // private handleMouseReturn : function(){ - this.el.un("mouseover", this.handleMouseReturn, this); - if(this.pressClass){ - this.el.addClass(this.pressClass); + this.el.un("mouseover", this.handleMouseReturn, this); + if(this.pressedCls){ + this.el.addCls(this.pressedCls); } this.click(); }, @@ -213,12 +238,15 @@ Ext.util.ClickRepeater = Ext.extend(Ext.util.Observable, { // private handleMouseUp : function(e){ clearTimeout(this.timer); - this.el.un("mouseover", this.handleMouseReturn, this); - this.el.un("mouseout", this.handleMouseOut, this); - Ext.getDoc().un("mouseup", this.handleMouseUp, this); - this.el.removeClass(this.pressClass); - this.fireEvent("mouseup", this, e); + this.el.un("mouseover", this.handleMouseReturn, this); + this.el.un("mouseout", this.handleMouseOut, this); + Ext.getDoc().un("mouseup", this.handleMouseUp, this); + if(this.pressedCls){ + this.el.removeCls(this.pressedCls); + } + this.fireEvent("mouseup", this, e); } -});+}); +