source: trunk/web/addons/job_monarch/lib/extjs/docs/output/Ext.EventManager.html @ 619

Last change on this file since 619 was 619, checked in by ramonb, 15 years ago

lib/:

  • added new AJAX dependancies: ExtJS, pChart, Lightbox2
File size: 18.9 KB
Line 
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="../src/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            *
17Registers event handlers that want to receive a normalized EventObject instead of the standard browser event and provides
18several useful events directly.
19See <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>
20       
21        <div class="hr"></div>
22                <a id="Ext.EventManager-props"></a>
23        <h2>Public Properties</h2>
24                <table cellspacing="0" class="member-table">
25            <tr>
26                <th class="sig-header" colspan="2">Property</th>
27                <th class="msource-header">Defined By</th>
28            </tr>
29                <tr class="property-row">
30        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
31        <td class="sig">
32        <a id="Ext.EventManager-ieDeferSrc"></a>
33            <b>ieDeferSrc</b> : Object            <div class="mdesc">
34                            Url used for onDocumentReady with using SSL (defaults to Ext.SSL_SECURE_URL)                        </div>
35        </td>
36        <td class="msource">EventManager</td>
37    </tr>
38        <tr class="property-row alt">
39        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
40        <td class="sig">
41        <a id="Ext.EventManager-textResizeInterval"></a>
42            <b>textResizeInterval</b> : Object            <div class="mdesc">
43                            The frequency, in milliseconds, to check for text resize events (defaults to 50)                        </div>
44        </td>
45        <td class="msource">EventManager</td>
46    </tr>
47            </table>
48                <a id="Ext.EventManager-methods"></a>
49        <h2>Public Methods</h2>
50                <table cellspacing="0" class="member-table">
51            <tr>
52                <th class="sig-header" colspan="2">Method</th>
53                <th class="msource-header">Defined By</th>
54            </tr>
55                <tr class="method-row expandable">
56        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
57        <td class="sig">
58        <a id="Ext.EventManager-addListener"></a>
59            <b>addListener</b>(&nbsp;<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>&nbsp;) : void            <div class="mdesc">
60                        <div class="short">Appends an event handler to an element.  The shorthand version on is equivalent.  Typically you will
61use Ext.Element....</div>
62            <div class="long">
63                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
64use <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">
65        <strong>Parameters:</strong>
66        <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 This function is passed
67the following parameters:<ul>
68<li>evt : EventObject<div class="sub-desc">The <a ext:cls="Ext.EventObject" href="output/Ext.EventObject.html">EventObject</a> describing the event.</div></li>
69<li>t : Element<div class="sub-desc">The <a ext:cls="Ext.Element" href="output/Ext.Element.html">Element</a> which was the target of the event.
70Note that this may be filtered by using the <tt>delegate</tt> option.</div></li>
71<li>o : Object<div class="sub-desc">The options object from the addListener call.</div></li>
72</ul></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
73function (the handler function's "this" context)</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration properties.
74This may contain any of the following properties:<ul>
75<li>scope {Object} : The scope in which to execute the handler function. The handler function's "this" context.</li>
76<li>delegate {String} : A simple selector to filter the target or look for a descendant of the target</li>
77<li>stopEvent {Boolean} : True to stop the event. That is stop propagation, and prevent the default action.</li>
78<li>preventDefault {Boolean} : True to prevent the default action</li>
79<li>stopPropagation {Boolean} : True to prevent event propagation</li>
80<li>normalized {Boolean} : False to pass a browser event to the handler function instead of an Ext.EventObject</li>
81<li>delay {Number} : The number of milliseconds to delay the invocation of the handler after te event fires.</li>
82<li>single {Boolean} : True to add a handler to handle just the next firing of the event, and then remove itself.</li>
83<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
84by the specified number of milliseconds. If the event fires again within that time, the original
85handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>
86</ul><br>
87<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>
88        <strong>Returns:</strong>
89        <ul>
90            <li><code>void</code></li>
91        </ul>
92    </div>
93                </div>
94                        </div>
95        </td>
96        <td class="msource">EventManager</td>
97    </tr>
98        <tr class="method-row alt expandable">
99        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
100        <td class="sig">
101        <a id="Ext.EventManager-on"></a>
102            <b>on</b>(&nbsp;<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>&nbsp;) : void            <div class="mdesc">
103                        <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>
104            <div class="long">
105                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">
106        <strong>Parameters:</strong>
107        <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
108function (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>
109        <strong>Returns:</strong>
110        <ul>
111            <li><code>void</code></li>
112        </ul>
113    </div>
114                </div>
115                        </div>
116        </td>
117        <td class="msource">EventManager</td>
118    </tr>
119        <tr class="method-row expandable">
120        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
121        <td class="sig">
122        <a id="Ext.EventManager-onDocumentReady"></a>
123            <b>onDocumentReady</b>(&nbsp;<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>boolean options</code>]</span>&nbsp;) : void            <div class="mdesc">
124                        <div class="short">Fires when the document is ready (before onload and before images are loaded). Can be
125accessed shorthanded as Ext.onR...</div>
126            <div class="long">
127                Fires when the document is ready (before onload and before images are loaded). Can be
128accessed shorthanded as Ext.onReady().    <div class="mdetail-params">
129        <strong>Parameters:</strong>
130        <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>
131        <strong>Returns:</strong>
132        <ul>
133            <li><code>void</code></li>
134        </ul>
135    </div>
136                </div>
137                        </div>
138        </td>
139        <td class="msource">EventManager</td>
140    </tr>
141        <tr class="method-row alt expandable">
142        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
143        <td class="sig">
144        <a id="Ext.EventManager-onTextResize"></a>
145            <b>onTextResize</b>(&nbsp;<code>Function fn</code>, <code>Object scope</code>, <code>boolean options</code>&nbsp;) : void            <div class="mdesc">
146                        <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>
147            <div class="long">
148                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">
149        <strong>Parameters:</strong>
150        <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>
151        <strong>Returns:</strong>
152        <ul>
153            <li><code>void</code></li>
154        </ul>
155    </div>
156                </div>
157                        </div>
158        </td>
159        <td class="msource">EventManager</td>
160    </tr>
161        <tr class="method-row expandable">
162        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
163        <td class="sig">
164        <a id="Ext.EventManager-onWindowResize"></a>
165            <b>onWindowResize</b>(&nbsp;<code>Function fn</code>, <code>Object scope</code>, <code>boolean options</code>&nbsp;) : void            <div class="mdesc">
166                        <div class="short">Fires when the window is resized and provides resize event buffering (50 milliseconds), passes new viewport width and...</div>
167            <div class="long">
168                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">
169        <strong>Parameters:</strong>
170        <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>
171        <strong>Returns:</strong>
172        <ul>
173            <li><code>void</code></li>
174        </ul>
175    </div>
176                </div>
177                        </div>
178        </td>
179        <td class="msource">EventManager</td>
180    </tr>
181        <tr class="method-row alt expandable">
182        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
183        <td class="sig">
184        <a id="Ext.EventManager-removeAll"></a>
185            <b>removeAll</b>(&nbsp;<code>String/HTMLElement el</code>&nbsp;) : void            <div class="mdesc">
186                        <div class="short">Removes all event handers from an element.  Typically you will use Ext.Element.removeAllListeners
187directly on an Elem...</div>
188            <div class="long">
189                Removes all event handers from an element.  Typically you will use <a ext:cls="Ext.Element" ext:member="removeAllListeners" href="output/Ext.Element.html#removeAllListeners">Ext.Element.removeAllListeners</a>
190directly on an Element in favor of calling this version.    <div class="mdetail-params">
191        <strong>Parameters:</strong>
192        <ul><li><code>el</code> : String/HTMLElement<div class="sub-desc">The id or html element from which to remove the event</div></li>        </ul>
193        <strong>Returns:</strong>
194        <ul>
195            <li><code>void</code></li>
196        </ul>
197    </div>
198                </div>
199                        </div>
200        </td>
201        <td class="msource">EventManager</td>
202    </tr>
203        <tr class="method-row expandable">
204        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
205        <td class="sig">
206        <a id="Ext.EventManager-removeListener"></a>
207            <b>removeListener</b>(&nbsp;<code>String/HTMLElement el</code>, <code>String eventName</code>, <code>Function fn</code>&nbsp;) : void            <div class="mdesc">
208                        <div class="short">Removes an event handler from an element.  The shorthand version un is equivalent.  Typically
209you will use Ext.Elemen...</div>
210            <div class="long">
211                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
212you 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">
213        <strong>Parameters:</strong>
214        <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>
215        <strong>Returns:</strong>
216        <ul>
217            <li><code>void</code></li>
218        </ul>
219    </div>
220                </div>
221                        </div>
222        </td>
223        <td class="msource">EventManager</td>
224    </tr>
225        <tr class="method-row alt expandable">
226        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
227        <td class="sig">
228        <a id="Ext.EventManager-removeResizeListener"></a>
229            <b>removeResizeListener</b>(&nbsp;<code>Function fn</code>, <code>Object scope</code>&nbsp;) : void            <div class="mdesc">
230                        <div class="short">Removes the passed window resize listener.</div>
231            <div class="long">
232                Removes the passed window resize listener.    <div class="mdetail-params">
233        <strong>Parameters:</strong>
234        <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>
235        <strong>Returns:</strong>
236        <ul>
237            <li><code>void</code></li>
238        </ul>
239    </div>
240                </div>
241                        </div>
242        </td>
243        <td class="msource">EventManager</td>
244    </tr>
245        <tr class="method-row expandable">
246        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
247        <td class="sig">
248        <a id="Ext.EventManager-un"></a>
249            <b>un</b>(&nbsp;<code>String/HTMLElement el</code>, <code>String eventName</code>, <code>Function fn</code>&nbsp;) : Boolean            <div class="mdesc">
250                        <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>
251            <div class="long">
252                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">
253        <strong>Parameters:</strong>
254        <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>
255        <strong>Returns:</strong>
256        <ul>
257            <li><code>Boolean</code><div class="sub-desc">True if a listener was actually removed, else false</div></li>
258        </ul>
259    </div>
260                </div>
261                        </div>
262        </td>
263        <td class="msource">EventManager</td>
264    </tr>
265            </table>
266                <a id="Ext.EventManager-events"></a>
267        <h2>Public Events</h2>
268        <div class="no-members">This class has no public events.</div>
269        </div>
Note: See TracBrowser for help on using the repository browser.