2 |
aperonnet |
1 |
<div class="body-wrap">
|
|
|
2 |
<div class="top-tools">
|
|
|
3 |
<a class="inner-link" href="#Ext.EventManager-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
|
|
|
4 |
<a class="inner-link" href="#Ext.EventManager-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
|
|
|
5 |
<a class="inner-link" href="#Ext.EventManager-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
|
|
|
6 |
<a class="bookmark" href="../docs/?class=Ext.EventManager"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
|
|
|
7 |
</div>
|
|
|
8 |
<h1>Class Ext.EventManager</h1>
|
|
|
9 |
<table cellspacing="0">
|
|
|
10 |
<tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr>
|
|
|
11 |
<tr><td class="label">Defined In:</td><td class="hd-info"><a href="../source/core/EventManager.js" target="_blank">EventManager.js</a></td></tr>
|
|
|
12 |
<tr><td class="label">Class:</td><td class="hd-info">EventManager</td></tr>
|
|
|
13 |
<tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
|
|
|
14 |
</table>
|
|
|
15 |
<div class="description">
|
|
|
16 |
Registers event handlers that want to receive a normalized EventObject instead of the standard browser event and provides
|
|
|
17 |
several useful events directly.
|
|
|
18 |
See <a ext:cls="Ext.EventObject" href="output/Ext.EventObject.html">Ext.EventObject</a> for more details on normalized event objects.<br><br><i>This class is a singleton and cannot be created directly.</i> </div>
|
|
|
19 |
|
|
|
20 |
<div class="hr"></div>
|
|
|
21 |
<a id="Ext.EventManager-props"></a>
|
|
|
22 |
<h2>Public Properties</h2>
|
|
|
23 |
<table cellspacing="0" class="member-table">
|
|
|
24 |
<tr>
|
|
|
25 |
<th class="sig-header" colspan="2">Property</th>
|
|
|
26 |
<th class="msource-header">Defined By</th>
|
|
|
27 |
</tr>
|
|
|
28 |
<tr class="property-row">
|
|
|
29 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
30 |
<td class="sig">
|
|
|
31 |
<a id="Ext.EventManager-ieDeferSrc"></a>
|
|
|
32 |
<b>ieDeferSrc</b> : Object <div class="mdesc">
|
|
|
33 |
Url used for onDocumentReady with using SSL (defaults to Ext.SSL_SECURE_URL) </div>
|
|
|
34 |
</td>
|
|
|
35 |
<td class="msource">EventManager</td>
|
|
|
36 |
</tr>
|
|
|
37 |
<tr class="property-row alt">
|
|
|
38 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
39 |
<td class="sig">
|
|
|
40 |
<a id="Ext.EventManager-textResizeInterval"></a>
|
|
|
41 |
<b>textResizeInterval</b> : Object <div class="mdesc">
|
|
|
42 |
The frequency, in milliseconds, to check for text resize events (defaults to 50) </div>
|
|
|
43 |
</td>
|
|
|
44 |
<td class="msource">EventManager</td>
|
|
|
45 |
</tr>
|
|
|
46 |
</table>
|
|
|
47 |
<a id="Ext.EventManager-methods"></a>
|
|
|
48 |
<h2>Public Methods</h2>
|
|
|
49 |
<table cellspacing="0" class="member-table">
|
|
|
50 |
<tr>
|
|
|
51 |
<th class="sig-header" colspan="2">Method</th>
|
|
|
52 |
<th class="msource-header">Defined By</th>
|
|
|
53 |
</tr>
|
|
|
54 |
<tr class="method-row expandable">
|
|
|
55 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
56 |
<td class="sig">
|
|
|
57 |
<a id="Ext.EventManager-addListener"></a>
|
|
|
58 |
<b>addListener</b>( <code>String/HTMLElement el</code>, <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc">
|
|
|
59 |
<div class="short">Appends an event handler to an element. The shorthand version on is equivalent. Typically you will
|
|
|
60 |
use Ext.Element....</div>
|
|
|
61 |
<div class="long">
|
|
|
62 |
Appends an event handler to an element. The shorthand version <a ext:cls="Ext.EventManager" ext:member="on" href="output/Ext.EventManager.html#on">on</a> is equivalent. Typically you will
|
|
|
63 |
use <a ext:cls="Ext.Element" ext:member="addListener" href="output/Ext.Element.html#addListener">Ext.Element.addListener</a> directly on an Element in favor of calling this version. <div class="mdetail-params">
|
|
|
64 |
<strong>Parameters:</strong>
|
|
|
65 |
<ul><li><code>el</code> : String/HTMLElement<div class="sub-desc">The html element or id to assign the event handler to</div></li><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler function the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
|
|
|
66 |
function (the handler function's "this" context)</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration properties.
|
|
|
67 |
This may contain any of the following properties:<ul>
|
|
|
68 |
<li>scope {Object} : The scope in which to execute the handler function. The handler function's "this" context.</li>
|
|
|
69 |
<li>delegate {String} : A simple selector to filter the target or look for a descendant of the target</li>
|
|
|
70 |
<li>stopEvent {Boolean} : True to stop the event. That is stop propagation, and prevent the default action.</li>
|
|
|
71 |
<li>preventDefault {Boolean} : True to prevent the default action</li>
|
|
|
72 |
<li>stopPropagation {Boolean} : True to prevent event propagation</li>
|
|
|
73 |
<li>normalized {Boolean} : False to pass a browser event to the handler function instead of an Ext.EventObject</li>
|
|
|
74 |
<li>delay {Number} : The number of milliseconds to delay the invocation of the handler after te event fires.</li>
|
|
|
75 |
<li>single {Boolean} : True to add a handler to handle just the next firing of the event, and then remove itself.</li>
|
|
|
76 |
<li>buffer {Number} : Causes the handler to be scheduled to run in an <a ext:cls="Ext.util.DelayedTask" href="output/Ext.util.DelayedTask.html">Ext.util.DelayedTask</a> delayed
|
|
|
77 |
by the specified number of milliseconds. If the event fires again within that time, the original
|
|
|
78 |
handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>
|
|
|
79 |
</ul><br>
|
|
|
80 |
<p>See <a ext:cls="Ext.Element" ext:member="addListener" href="output/Ext.Element.html#addListener">Ext.Element.addListener</a> for examples of how to use these options.</p></div></li> </ul>
|
|
|
81 |
<strong>Returns:</strong>
|
|
|
82 |
<ul>
|
|
|
83 |
<li><code>void</code></li>
|
|
|
84 |
</ul>
|
|
|
85 |
</div>
|
|
|
86 |
</div>
|
|
|
87 |
</div>
|
|
|
88 |
</td>
|
|
|
89 |
<td class="msource">EventManager</td>
|
|
|
90 |
</tr>
|
|
|
91 |
<tr class="method-row alt expandable">
|
|
|
92 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
93 |
<td class="sig">
|
|
|
94 |
<a id="Ext.EventManager-on"></a>
|
|
|
95 |
<b>on</b>( <code>String/HTMLElement el</code>, <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc">
|
|
|
96 |
<div class="short">Appends an event handler to an element. Shorthand for <a ext:cls="Ext.EventManager" ext:member="addListener" href="output/Ext.EventManager.html#addListener">addListener</a>.</div>
|
|
|
97 |
<div class="long">
|
|
|
98 |
Appends an event handler to an element. Shorthand for <a ext:cls="Ext.EventManager" ext:member="addListener" href="output/Ext.EventManager.html#addListener">addListener</a>. <div class="mdetail-params">
|
|
|
99 |
<strong>Parameters:</strong>
|
|
|
100 |
<ul><li><code>el</code> : String/HTMLElement<div class="sub-desc">The html element or id to assign the event handler to</div></li><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler function the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
|
|
|
101 |
function (the handler function's "this" context)</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing standard <a ext:cls="Ext.EventManager" ext:member="addListener" href="output/Ext.EventManager.html#addListener">addListener</a> options</div></li> </ul>
|
|
|
102 |
<strong>Returns:</strong>
|
|
|
103 |
<ul>
|
|
|
104 |
<li><code>void</code></li>
|
|
|
105 |
</ul>
|
|
|
106 |
</div>
|
|
|
107 |
</div>
|
|
|
108 |
</div>
|
|
|
109 |
</td>
|
|
|
110 |
<td class="msource">EventManager</td>
|
|
|
111 |
</tr>
|
|
|
112 |
<tr class="method-row expandable">
|
|
|
113 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
114 |
<td class="sig">
|
|
|
115 |
<a id="Ext.EventManager-onDocumentReady"></a>
|
|
|
116 |
<b>onDocumentReady</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>boolean options</code>]</span> ) : void <div class="mdesc">
|
|
|
117 |
<div class="short">Fires when the document is ready (before onload and before images are loaded). Can be
|
|
|
118 |
accessed shorthanded as Ext.onR...</div>
|
|
|
119 |
<div class="long">
|
|
|
120 |
Fires when the document is ready (before onload and before images are loaded). Can be
|
|
|
121 |
accessed shorthanded as Ext.onReady(). <div class="mdetail-params">
|
|
|
122 |
<strong>Parameters:</strong>
|
|
|
123 |
<ul><li><code>fn</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) An object that becomes the scope of the handler</div></li><li><code>options</code> : boolean<div class="sub-desc">(optional) An object containing standard <a ext:cls="Ext.EventManager" ext:member="addListener" href="output/Ext.EventManager.html#addListener">addListener</a> options</div></li> </ul>
|
|
|
124 |
<strong>Returns:</strong>
|
|
|
125 |
<ul>
|
|
|
126 |
<li><code>void</code></li>
|
|
|
127 |
</ul>
|
|
|
128 |
</div>
|
|
|
129 |
</div>
|
|
|
130 |
</div>
|
|
|
131 |
</td>
|
|
|
132 |
<td class="msource">EventManager</td>
|
|
|
133 |
</tr>
|
|
|
134 |
<tr class="method-row alt expandable">
|
|
|
135 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
136 |
<td class="sig">
|
|
|
137 |
<a id="Ext.EventManager-onTextResize"></a>
|
|
|
138 |
<b>onTextResize</b>( <code>Function fn</code>, <code>Object scope</code>, <code>boolean options</code> ) : void <div class="mdesc">
|
|
|
139 |
<div class="short">Fires when the user changes the active text size. Handler gets called with 2 params, the old size and the new size.</div>
|
|
|
140 |
<div class="long">
|
|
|
141 |
Fires when the user changes the active text size. Handler gets called with 2 params, the old size and the new size. <div class="mdetail-params">
|
|
|
142 |
<strong>Parameters:</strong>
|
|
|
143 |
<ul><li><code>fn</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">An object that becomes the scope of the handler</div></li><li><code>options</code> : boolean<div class="sub-desc"></div></li> </ul>
|
|
|
144 |
<strong>Returns:</strong>
|
|
|
145 |
<ul>
|
|
|
146 |
<li><code>void</code></li>
|
|
|
147 |
</ul>
|
|
|
148 |
</div>
|
|
|
149 |
</div>
|
|
|
150 |
</div>
|
|
|
151 |
</td>
|
|
|
152 |
<td class="msource">EventManager</td>
|
|
|
153 |
</tr>
|
|
|
154 |
<tr class="method-row expandable">
|
|
|
155 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
156 |
<td class="sig">
|
|
|
157 |
<a id="Ext.EventManager-onWindowResize"></a>
|
|
|
158 |
<b>onWindowResize</b>( <code>Function fn</code>, <code>Object scope</code>, <code>boolean options</code> ) : void <div class="mdesc">
|
|
|
159 |
<div class="short">Fires when the window is resized and provides resize event buffering (50 milliseconds), passes new viewport width and...</div>
|
|
|
160 |
<div class="long">
|
|
|
161 |
Fires when the window is resized and provides resize event buffering (50 milliseconds), passes new viewport width and height to handlers. <div class="mdetail-params">
|
|
|
162 |
<strong>Parameters:</strong>
|
|
|
163 |
<ul><li><code>fn</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">An object that becomes the scope of the handler</div></li><li><code>options</code> : boolean<div class="sub-desc"></div></li> </ul>
|
|
|
164 |
<strong>Returns:</strong>
|
|
|
165 |
<ul>
|
|
|
166 |
<li><code>void</code></li>
|
|
|
167 |
</ul>
|
|
|
168 |
</div>
|
|
|
169 |
</div>
|
|
|
170 |
</div>
|
|
|
171 |
</td>
|
|
|
172 |
<td class="msource">EventManager</td>
|
|
|
173 |
</tr>
|
|
|
174 |
<tr class="method-row alt expandable">
|
|
|
175 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
176 |
<td class="sig">
|
|
|
177 |
<a id="Ext.EventManager-removeListener"></a>
|
|
|
178 |
<b>removeListener</b>( <code>String/HTMLElement el</code>, <code>String eventName</code>, <code>Function fn</code> ) : Boolean <div class="mdesc">
|
|
|
179 |
<div class="short">Removes an event handler from an element. The shorthand version un is equivalent. Typically
|
|
|
180 |
you will use Ext.Elemen...</div>
|
|
|
181 |
<div class="long">
|
|
|
182 |
Removes an event handler from an element. The shorthand version <a ext:cls="Ext.EventManager" ext:member="un" href="output/Ext.EventManager.html#un">un</a> is equivalent. Typically
|
|
|
183 |
you will use <a ext:cls="Ext.Element" ext:member="removeListener" href="output/Ext.Element.html#removeListener">Ext.Element.removeListener</a> directly on an Element in favor of calling this version. <div class="mdetail-params">
|
|
|
184 |
<strong>Parameters:</strong>
|
|
|
185 |
<ul><li><code>el</code> : String/HTMLElement<div class="sub-desc">The id or html element from which to remove the event</div></li><li><code>eventName</code> : String<div class="sub-desc">The type of event</div></li><li><code>fn</code> : Function<div class="sub-desc">The handler function to remove</div></li> </ul>
|
|
|
186 |
<strong>Returns:</strong>
|
|
|
187 |
<ul>
|
|
|
188 |
<li><code>Boolean</code><div class="sub-desc">True if a listener was actually removed, else false</div></li>
|
|
|
189 |
</ul>
|
|
|
190 |
</div>
|
|
|
191 |
</div>
|
|
|
192 |
</div>
|
|
|
193 |
</td>
|
|
|
194 |
<td class="msource">EventManager</td>
|
|
|
195 |
</tr>
|
|
|
196 |
<tr class="method-row expandable">
|
|
|
197 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
198 |
<td class="sig">
|
|
|
199 |
<a id="Ext.EventManager-removeResizeListener"></a>
|
|
|
200 |
<b>removeResizeListener</b>( <code>Function fn</code>, <code>Object scope</code> ) : void <div class="mdesc">
|
|
|
201 |
<div class="short">Removes the passed window resize listener.</div>
|
|
|
202 |
<div class="long">
|
|
|
203 |
Removes the passed window resize listener. <div class="mdetail-params">
|
|
|
204 |
<strong>Parameters:</strong>
|
|
|
205 |
<ul><li><code>fn</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">The scope of handler</div></li> </ul>
|
|
|
206 |
<strong>Returns:</strong>
|
|
|
207 |
<ul>
|
|
|
208 |
<li><code>void</code></li>
|
|
|
209 |
</ul>
|
|
|
210 |
</div>
|
|
|
211 |
</div>
|
|
|
212 |
</div>
|
|
|
213 |
</td>
|
|
|
214 |
<td class="msource">EventManager</td>
|
|
|
215 |
</tr>
|
|
|
216 |
<tr class="method-row alt expandable">
|
|
|
217 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
218 |
<td class="sig">
|
|
|
219 |
<a id="Ext.EventManager-un"></a>
|
|
|
220 |
<b>un</b>( <code>String/HTMLElement el</code>, <code>String eventName</code>, <code>Function fn</code> ) : Boolean <div class="mdesc">
|
|
|
221 |
<div class="short">Removes an event handler from an element. Shorthand for <a ext:cls="Ext.EventManager" ext:member="removeListener" href="output/Ext.EventManager.html#removeListener">removeListener</a>.</div>
|
|
|
222 |
<div class="long">
|
|
|
223 |
Removes an event handler from an element. Shorthand for <a ext:cls="Ext.EventManager" ext:member="removeListener" href="output/Ext.EventManager.html#removeListener">removeListener</a>. <div class="mdetail-params">
|
|
|
224 |
<strong>Parameters:</strong>
|
|
|
225 |
<ul><li><code>el</code> : String/HTMLElement<div class="sub-desc">The id or html element from which to remove the event</div></li><li><code>eventName</code> : String<div class="sub-desc">The type of event</div></li><li><code>fn</code> : Function<div class="sub-desc">The handler function to remove</div></li> </ul>
|
|
|
226 |
<strong>Returns:</strong>
|
|
|
227 |
<ul>
|
|
|
228 |
<li><code>Boolean</code><div class="sub-desc">True if a listener was actually removed, else false</div></li>
|
|
|
229 |
</ul>
|
|
|
230 |
</div>
|
|
|
231 |
</div>
|
|
|
232 |
</div>
|
|
|
233 |
</td>
|
|
|
234 |
<td class="msource">EventManager</td>
|
|
|
235 |
</tr>
|
|
|
236 |
</table>
|
|
|
237 |
<a id="Ext.EventManager-events"></a>
|
|
|
238 |
<h2>Public Events</h2>
|
|
|
239 |
<div class="no-members">This class has no public events.</div>
|
|
|
240 |
</div>
|