Upgrade to ExtJS 3.1.1 - Released 02/08/2010
[extjs.git] / docs / source / EventManager-more.html
1 <html>\r
2 <head>\r
3   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    \r
4   <title>The source code</title>\r
5     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
6     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
7 </head>\r
8 <body  onload="prettyPrint();">\r
9     <pre class="prettyprint lang-js">/**
10 * @class Ext.EventManager
11 */
12 Ext.apply(Ext.EventManager, function(){
13    var resizeEvent,
14        resizeTask,
15        textEvent,
16        textSize,
17        D = Ext.lib.Dom,
18        propRe = /^(?:scope|delay|buffer|single|stopEvent|preventDefault|stopPropagation|normalized|args|delegate)$/,
19        curWidth = 0,
20        curHeight = 0,
21        // note 1: IE fires ONLY the keydown event on specialkey autorepeat
22        // note 2: Safari < 3.1, Gecko (Mac/Linux) & Opera fire only the keypress event on specialkey autorepeat
23        // (research done by @Jan Wolter at http://unixpapa.com/js/key.html)
24        useKeydown = Ext.isWebKit ?
25                    Ext.num(navigator.userAgent.match(/AppleWebKit\/(\d+)/)[1]) >= 525 :
26                    !((Ext.isGecko && !Ext.isWindows) || Ext.isOpera);
27
28    return {
29        // private
30        doResizeEvent: function(){
31            var h = D.getViewHeight(),
32                w = D.getViewWidth();
33
34             //whacky problem in IE where the resize event will fire even though the w/h are the same.
35             if(curHeight != h || curWidth != w){
36                resizeEvent.fire(curWidth = w, curHeight = h);
37             }
38        },
39
40        <div id="method-Ext.EventManager-onWindowResize"></div>/**
41         * Adds a listener to be notified when the browser window is resized and provides resize event buffering (100 milliseconds),
42         * passes new viewport width and height to handlers.
43         * @param {Function} fn      The handler function the window resize event invokes.
44         * @param {Object}   scope   The scope (<code>this</code> reference) in which the handler function executes. Defaults to the browser window.
45         * @param {boolean}  options Options object as passed to {@link Ext.Element#addListener}
46         */
47        onWindowResize : function(fn, scope, options){
48            if(!resizeEvent){
49                resizeEvent = new Ext.util.Event();
50                resizeTask = new Ext.util.DelayedTask(this.doResizeEvent);
51                Ext.EventManager.on(window, "resize", this.fireWindowResize, this);
52            }
53            resizeEvent.addListener(fn, scope, options);
54        },
55
56        // exposed only to allow manual firing
57        fireWindowResize : function(){
58            if(resizeEvent){
59                resizeTask.delay(100);
60            }
61        },
62
63        <div id="method-Ext.EventManager-onTextResize"></div>/**
64         * Adds a listener to be notified when the user changes the active text size. Handler gets called with 2 params, the old size and the new size.
65         * @param {Function} fn      The function the event invokes.
66         * @param {Object}   scope   The scope (<code>this</code> reference) in which the handler function executes. Defaults to the browser window.
67         * @param {boolean}  options Options object as passed to {@link Ext.Element#addListener}
68         */
69        onTextResize : function(fn, scope, options){
70            if(!textEvent){
71                textEvent = new Ext.util.Event();
72                var textEl = new Ext.Element(document.createElement('div'));
73                textEl.dom.className = 'x-text-resize';
74                textEl.dom.innerHTML = 'X';
75                textEl.appendTo(document.body);
76                textSize = textEl.dom.offsetHeight;
77                setInterval(function(){
78                    if(textEl.dom.offsetHeight != textSize){
79                        textEvent.fire(textSize, textSize = textEl.dom.offsetHeight);
80                    }
81                }, this.textResizeInterval);
82            }
83            textEvent.addListener(fn, scope, options);
84        },
85
86        <div id="method-Ext.EventManager-removeResizeListener"></div>/**
87         * Removes the passed window resize listener.
88         * @param {Function} fn        The method the event invokes
89         * @param {Object}   scope    The scope of handler
90         */
91        removeResizeListener : function(fn, scope){
92            if(resizeEvent){
93                resizeEvent.removeListener(fn, scope);
94            }
95        },
96
97        // private
98        fireResize : function(){
99            if(resizeEvent){
100                resizeEvent.fire(D.getViewWidth(), D.getViewHeight());
101            }
102        },
103
104         <div id="prop-Ext.EventManager-textResizeInterval"></div>/**
105         * The frequency, in milliseconds, to check for text resize events (defaults to 50)
106         */
107        textResizeInterval : 50,
108
109        <div id="prop-Ext.EventManager-ieDeferSrc"></div>/**
110         * Url used for onDocumentReady with using SSL (defaults to Ext.SSL_SECURE_URL)
111         */
112        ieDeferSrc : false,
113
114        // protected for use inside the framework
115        // detects whether we should use keydown or keypress based on the browser.
116        useKeydown: useKeydown
117    };
118 }());
119
120 Ext.EventManager.on = Ext.EventManager.addListener;
121
122
123 Ext.apply(Ext.EventObjectImpl.prototype, {
124    <div id="prop-Ext.EventManager-BACKSPACE"></div>/** Key constant @type Number */
125    BACKSPACE: 8,
126    <div id="prop-Ext.EventManager-TAB"></div>/** Key constant @type Number */
127    TAB: 9,
128    <div id="prop-Ext.EventManager-NUM_CENTER"></div>/** Key constant @type Number */
129    NUM_CENTER: 12,
130    <div id="prop-Ext.EventManager-ENTER"></div>/** Key constant @type Number */
131    ENTER: 13,
132    <div id="prop-Ext.EventManager-RETURN"></div>/** Key constant @type Number */
133    RETURN: 13,
134    <div id="prop-Ext.EventManager-SHIFT"></div>/** Key constant @type Number */
135    SHIFT: 16,
136    <div id="prop-Ext.EventManager-CTRL"></div>/** Key constant @type Number */
137    CTRL: 17,
138    CONTROL : 17, // legacy
139    <div id="prop-Ext.EventManager-ALT"></div>/** Key constant @type Number */
140    ALT: 18,
141    <div id="prop-Ext.EventManager-PAUSE"></div>/** Key constant @type Number */
142    PAUSE: 19,
143    <div id="prop-Ext.EventManager-CAPS_LOCK"></div>/** Key constant @type Number */
144    CAPS_LOCK: 20,
145    <div id="prop-Ext.EventManager-ESC"></div>/** Key constant @type Number */
146    ESC: 27,
147    <div id="prop-Ext.EventManager-SPACE"></div>/** Key constant @type Number */
148    SPACE: 32,
149    <div id="prop-Ext.EventManager-PAGE_UP"></div>/** Key constant @type Number */
150    PAGE_UP: 33,
151    PAGEUP : 33, // legacy
152    <div id="prop-Ext.EventManager-PAGE_DOWN"></div>/** Key constant @type Number */
153    PAGE_DOWN: 34,
154    PAGEDOWN : 34, // legacy
155    <div id="prop-Ext.EventManager-END"></div>/** Key constant @type Number */
156    END: 35,
157    <div id="prop-Ext.EventManager-HOME"></div>/** Key constant @type Number */
158    HOME: 36,
159    <div id="prop-Ext.EventManager-LEFT"></div>/** Key constant @type Number */
160    LEFT: 37,
161    <div id="prop-Ext.EventManager-UP"></div>/** Key constant @type Number */
162    UP: 38,
163    <div id="prop-Ext.EventManager-RIGHT"></div>/** Key constant @type Number */
164    RIGHT: 39,
165    <div id="prop-Ext.EventManager-DOWN"></div>/** Key constant @type Number */
166    DOWN: 40,
167    <div id="prop-Ext.EventManager-PRINT_SCREEN"></div>/** Key constant @type Number */
168    PRINT_SCREEN: 44,
169    <div id="prop-Ext.EventManager-INSERT"></div>/** Key constant @type Number */
170    INSERT: 45,
171    <div id="prop-Ext.EventManager-DELETE"></div>/** Key constant @type Number */
172    DELETE: 46,
173    <div id="prop-Ext.EventManager-ZERO"></div>/** Key constant @type Number */
174    ZERO: 48,
175    <div id="prop-Ext.EventManager-ONE"></div>/** Key constant @type Number */
176    ONE: 49,
177    <div id="prop-Ext.EventManager-TWO"></div>/** Key constant @type Number */
178    TWO: 50,
179    <div id="prop-Ext.EventManager-THREE"></div>/** Key constant @type Number */
180    THREE: 51,
181    <div id="prop-Ext.EventManager-FOUR"></div>/** Key constant @type Number */
182    FOUR: 52,
183    <div id="prop-Ext.EventManager-FIVE"></div>/** Key constant @type Number */
184    FIVE: 53,
185    <div id="prop-Ext.EventManager-SIX"></div>/** Key constant @type Number */
186    SIX: 54,
187    <div id="prop-Ext.EventManager-SEVEN"></div>/** Key constant @type Number */
188    SEVEN: 55,
189    <div id="prop-Ext.EventManager-EIGHT"></div>/** Key constant @type Number */
190    EIGHT: 56,
191    <div id="prop-Ext.EventManager-NINE"></div>/** Key constant @type Number */
192    NINE: 57,
193    <div id="prop-Ext.EventManager-A"></div>/** Key constant @type Number */
194    A: 65,
195    <div id="prop-Ext.EventManager-B"></div>/** Key constant @type Number */
196    B: 66,
197    <div id="prop-Ext.EventManager-C"></div>/** Key constant @type Number */
198    C: 67,
199    <div id="prop-Ext.EventManager-D"></div>/** Key constant @type Number */
200    D: 68,
201    <div id="prop-Ext.EventManager-E"></div>/** Key constant @type Number */
202    E: 69,
203    <div id="prop-Ext.EventManager-F"></div>/** Key constant @type Number */
204    F: 70,
205    <div id="prop-Ext.EventManager-G"></div>/** Key constant @type Number */
206    G: 71,
207    <div id="prop-Ext.EventManager-H"></div>/** Key constant @type Number */
208    H: 72,
209    <div id="prop-Ext.EventManager-I"></div>/** Key constant @type Number */
210    I: 73,
211    <div id="prop-Ext.EventManager-J"></div>/** Key constant @type Number */
212    J: 74,
213    <div id="prop-Ext.EventManager-K"></div>/** Key constant @type Number */
214    K: 75,
215    <div id="prop-Ext.EventManager-L"></div>/** Key constant @type Number */
216    L: 76,
217    <div id="prop-Ext.EventManager-M"></div>/** Key constant @type Number */
218    M: 77,
219    <div id="prop-Ext.EventManager-N"></div>/** Key constant @type Number */
220    N: 78,
221    <div id="prop-Ext.EventManager-O"></div>/** Key constant @type Number */
222    O: 79,
223    <div id="prop-Ext.EventManager-P"></div>/** Key constant @type Number */
224    P: 80,
225    <div id="prop-Ext.EventManager-Q"></div>/** Key constant @type Number */
226    Q: 81,
227    <div id="prop-Ext.EventManager-R"></div>/** Key constant @type Number */
228    R: 82,
229    <div id="prop-Ext.EventManager-S"></div>/** Key constant @type Number */
230    S: 83,
231    <div id="prop-Ext.EventManager-T"></div>/** Key constant @type Number */
232    T: 84,
233    <div id="prop-Ext.EventManager-U"></div>/** Key constant @type Number */
234    U: 85,
235    <div id="prop-Ext.EventManager-V"></div>/** Key constant @type Number */
236    V: 86,
237    <div id="prop-Ext.EventManager-W"></div>/** Key constant @type Number */
238    W: 87,
239    <div id="prop-Ext.EventManager-X"></div>/** Key constant @type Number */
240    X: 88,
241    <div id="prop-Ext.EventManager-Y"></div>/** Key constant @type Number */
242    Y: 89,
243    <div id="prop-Ext.EventManager-Z"></div>/** Key constant @type Number */
244    Z: 90,
245    <div id="prop-Ext.EventManager-CONTEXT_MENU"></div>/** Key constant @type Number */
246    CONTEXT_MENU: 93,
247    <div id="prop-Ext.EventManager-NUM_ZERO"></div>/** Key constant @type Number */
248    NUM_ZERO: 96,
249    <div id="prop-Ext.EventManager-NUM_ONE"></div>/** Key constant @type Number */
250    NUM_ONE: 97,
251    <div id="prop-Ext.EventManager-NUM_TWO"></div>/** Key constant @type Number */
252    NUM_TWO: 98,
253    <div id="prop-Ext.EventManager-NUM_THREE"></div>/** Key constant @type Number */
254    NUM_THREE: 99,
255    <div id="prop-Ext.EventManager-NUM_FOUR"></div>/** Key constant @type Number */
256    NUM_FOUR: 100,
257    <div id="prop-Ext.EventManager-NUM_FIVE"></div>/** Key constant @type Number */
258    NUM_FIVE: 101,
259    <div id="prop-Ext.EventManager-NUM_SIX"></div>/** Key constant @type Number */
260    NUM_SIX: 102,
261    <div id="prop-Ext.EventManager-NUM_SEVEN"></div>/** Key constant @type Number */
262    NUM_SEVEN: 103,
263    <div id="prop-Ext.EventManager-NUM_EIGHT"></div>/** Key constant @type Number */
264    NUM_EIGHT: 104,
265    <div id="prop-Ext.EventManager-NUM_NINE"></div>/** Key constant @type Number */
266    NUM_NINE: 105,
267    <div id="prop-Ext.EventManager-NUM_MULTIPLY"></div>/** Key constant @type Number */
268    NUM_MULTIPLY: 106,
269    <div id="prop-Ext.EventManager-NUM_PLUS"></div>/** Key constant @type Number */
270    NUM_PLUS: 107,
271    <div id="prop-Ext.EventManager-NUM_MINUS"></div>/** Key constant @type Number */
272    NUM_MINUS: 109,
273    <div id="prop-Ext.EventManager-NUM_PERIOD"></div>/** Key constant @type Number */
274    NUM_PERIOD: 110,
275    <div id="prop-Ext.EventManager-NUM_DIVISION"></div>/** Key constant @type Number */
276    NUM_DIVISION: 111,
277    <div id="prop-Ext.EventManager-F1"></div>/** Key constant @type Number */
278    F1: 112,
279    <div id="prop-Ext.EventManager-F2"></div>/** Key constant @type Number */
280    F2: 113,
281    <div id="prop-Ext.EventManager-F3"></div>/** Key constant @type Number */
282    F3: 114,
283    <div id="prop-Ext.EventManager-F4"></div>/** Key constant @type Number */
284    F4: 115,
285    <div id="prop-Ext.EventManager-F5"></div>/** Key constant @type Number */
286    F5: 116,
287    <div id="prop-Ext.EventManager-F6"></div>/** Key constant @type Number */
288    F6: 117,
289    <div id="prop-Ext.EventManager-F7"></div>/** Key constant @type Number */
290    F7: 118,
291    <div id="prop-Ext.EventManager-F8"></div>/** Key constant @type Number */
292    F8: 119,
293    <div id="prop-Ext.EventManager-F9"></div>/** Key constant @type Number */
294    F9: 120,
295    <div id="prop-Ext.EventManager-F10"></div>/** Key constant @type Number */
296    F10: 121,
297    <div id="prop-Ext.EventManager-F11"></div>/** Key constant @type Number */
298    F11: 122,
299    <div id="prop-Ext.EventManager-F12"></div>/** Key constant @type Number */
300    F12: 123,
301
302    /** @private */
303    isNavKeyPress : function(){
304        var me = this,
305            k = this.normalizeKey(me.keyCode);
306        return (k >= 33 && k <= 40) ||  // Page Up/Down, End, Home, Left, Up, Right, Down
307        k == me.RETURN ||
308        k == me.TAB ||
309        k == me.ESC;
310    },
311
312    isSpecialKey : function(){
313        var k = this.normalizeKey(this.keyCode);
314        return (this.type == 'keypress' && this.ctrlKey) ||
315        this.isNavKeyPress() ||
316        (k == this.BACKSPACE) || // Backspace
317        (k >= 16 && k <= 20) || // Shift, Ctrl, Alt, Pause, Caps Lock
318        (k >= 44 && k <= 45);   // Print Screen, Insert
319    },
320
321    getPoint : function(){
322        return new Ext.lib.Point(this.xy[0], this.xy[1]);
323    },
324
325    <div id="method-Ext.EventManager-hasModifier"></div>/**
326     * Returns true if the control, meta, shift or alt key was pressed during this event.
327     * @return {Boolean}
328     */
329    hasModifier : function(){
330        return ((this.ctrlKey || this.altKey) || this.shiftKey);
331    }
332 });</pre>    \r
333 </body>\r
334 </html>