-<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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">EventManager</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventManager-on"></a>\r
- <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">\r
- <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>\r
- <div class="long">\r
- 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">\r
- <strong>Parameters:</strong>\r
- <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
-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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">EventManager</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventManager-onDocumentReady"></a>\r
- <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">\r
- <div class="short">Fires when the document is ready (before onload and before images are loaded). Can be
-accessed shorthanded as Ext.onR...</div>\r
- <div class="long">\r
- Fires when the document is ready (before onload and before images are loaded). Can be
-accessed shorthanded as Ext.onReady(). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">EventManager</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventManager-onTextResize"></a>\r
- <b>onTextResize</b>( <code>Function fn</code>, <code>Object scope</code>, <code>boolean options</code> ) : void <div class="mdesc">\r
- <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>\r
- <div class="long">\r
- 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">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">EventManager</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventManager-onWindowResize"></a>\r
- <b>onWindowResize</b>( <code>Function fn</code>, <code>Object scope</code>, <code>boolean options</code> ) : void <div class="mdesc">\r
- <div class="short">Fires when the window is resized and provides resize event buffering (50 milliseconds), passes new viewport width and...</div>\r
- <div class="long">\r
- 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">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">EventManager</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventManager-removeAll"></a>\r
- <b>removeAll</b>( <code>String/HTMLElement el</code> ) : void <div class="mdesc">\r
- <div class="short">Removes all event handers from an element. Typically you will use Ext.Element.removeAllListeners
-directly on an Elem...</div>\r
- <div class="long">\r
- 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>
-directly on an Element in favor of calling this version. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">EventManager</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventManager-removeListener"></a>\r
- <b>removeListener</b>( <code>String/HTMLElement el</code>, <code>String eventName</code>, <code>Function fn</code> ) : void <div class="mdesc">\r
- <div class="short">Removes an event handler from an element. The shorthand version un is equivalent. Typically
-you will use Ext.Elemen...</div>\r
- <div class="long">\r
- 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
-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">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">EventManager</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventManager-removeResizeListener"></a>\r
- <b>removeResizeListener</b>( <code>Function fn</code>, <code>Object scope</code> ) : void <div class="mdesc">\r
- <div class="short">Removes the passed window resize listener.</div>\r
- <div class="long">\r
- Removes the passed window resize listener. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">EventManager</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.EventManager-un"></a>\r
- <b>un</b>( <code>String/HTMLElement el</code>, <code>String eventName</code>, <code>Function fn</code> ) : Boolean <div class="mdesc">\r
- <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>\r
- <div class="long">\r
- 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">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">True if a listener was actually removed, else false</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">EventManager</td>\r
- </tr>\r
- </table>
- <a id="Ext.EventManager-events"></a>
- <h2>Public Events</h2>
- <div class="no-members">This class has no public events.</div>
- </div>
\ No newline at end of file
+<p>See <a href="output/Ext.Element.html#Ext.Element-addListener" ext:member="addListener" ext:cls="Ext.Element">Ext.Element.addListener</a> for examples of how to use these options.</p></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">EventManager</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.EventManager-function"></a><b><a href="source/EventManager.html#method-Ext.EventManager-function">function</a></b>()
+ :
+ Boolean<div class="mdesc"><div class="short"></div><div class="long"><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if the document is in a 'complete' state (or was determined to
+be true by other means). If false, the state is evaluated again until canceled.</div></li></ul></div></div></div></td><td class="msource">EventManager</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.EventManager-hasModifier"></a><b><a href="source/EventManager-more.html#method-Ext.EventManager-hasModifier">hasModifier</a></b>()
+ :
+ Boolean<div class="mdesc"><div class="short">Returns true if the control, meta, shift or alt key was pressed during this event.</div><div class="long">Returns true if the control, meta, shift or alt key was pressed during this event.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">EventManager</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.EventManager-on"></a><b><a href="source/EventManager.html#method-Ext.EventManager-on">on</a></b>( <code>String/HTMLElement el</code>, <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span>, <span title="Optional" class="optional">[<code>Object options</code>]</span> )
+ :
+ void<div class="mdesc"><div class="short">Appends an event handler to an element. Shorthand for addListener.</div><div class="long">Appends an event handler to an element. Shorthand for <a href="output/Ext.EventManager.html#Ext.EventManager-addListener" ext:member="addListener" ext:cls="Ext.EventManager">addListener</a>.<div class="mdetail-params"><strong>Parameters:</strong><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 name of the 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) (<code>this</code> reference) in which the handler function executes. <b>Defaults to the Element</b>.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing standard <a href="output/Ext.EventManager.html#Ext.EventManager-addListener" ext:member="addListener" ext:cls="Ext.EventManager">addListener</a> options</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">EventManager</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.EventManager-onDocumentReady"></a><b><a href="source/EventManager.html#method-Ext.EventManager-onDocumentReady">onDocumentReady</a></b>( <code>Function fn</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span>, <span title="Optional" class="optional">[<code>boolean options</code>]</span> )
+ :
+ void<div class="mdesc"><div class="short">Adds a listener to be notified when the document is ready (before onload and before images are loaded). Can be
+access...</div><div class="long">Adds a listener to be notified when the document is ready (before onload and before images are loaded). Can be
+accessed shorthanded as Ext.onReady().<div class="mdetail-params"><strong>Parameters:</strong><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) The scope (<code>this</code> reference) in which the handler function executes. Defaults to the browser window.</div></li><li><code>options</code> : boolean<div class="sub-desc">(optional) Options object as passed to <a href="output/Ext.Element.html#Ext.Element-addListener" ext:member="addListener" ext:cls="Ext.Element">Ext.Element.addListener</a>. It is recommended that the options
+<code>{single: true}</code> be used so that the handler is removed on first invocation.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">EventManager</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.EventManager-onTextResize"></a><b><a href="source/EventManager-more.html#method-Ext.EventManager-onTextResize">onTextResize</a></b>( <code>Function fn</code>, <code>Object scope</code>, <code>boolean options</code> )
+ :
+ void<div class="mdesc"><div class="short">Adds a listener to be notified when the user changes the active text size. Handler gets called with 2 params, the old...</div><div class="long">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.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>fn</code> : Function<div class="sub-desc">The function the event invokes.</div></li><li><code>scope</code> : Object<div class="sub-desc">The scope (<code>this</code> reference) in which the handler function executes. Defaults to the browser window.</div></li><li><code>options</code> : boolean<div class="sub-desc">Options object as passed to <a href="output/Ext.Element.html#Ext.Element-addListener" ext:member="addListener" ext:cls="Ext.Element">Ext.Element.addListener</a></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">EventManager</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.EventManager-onWindowResize"></a><b><a href="source/EventManager-more.html#method-Ext.EventManager-onWindowResize">onWindowResize</a></b>( <code>Function fn</code>, <code>Object scope</code>, <code>boolean options</code> )
+ :
+ void<div class="mdesc"><div class="short">Adds a listener to be notified when the browser window is resized and provides resize event buffering (100 millisecon...</div><div class="long">Adds a listener to be notified when the browser window is resized and provides resize event buffering (100 milliseconds),
+passes new viewport width and height to handlers.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>fn</code> : Function<div class="sub-desc">The handler function the window resize event invokes.</div></li><li><code>scope</code> : Object<div class="sub-desc">The scope (<code>this</code> reference) in which the handler function executes. Defaults to the browser window.</div></li><li><code>options</code> : boolean<div class="sub-desc">Options object as passed to <a href="output/Ext.Element.html#Ext.Element-addListener" ext:member="addListener" ext:cls="Ext.Element">Ext.Element.addListener</a></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">EventManager</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.EventManager-removeAll"></a><b><a href="source/EventManager.html#method-Ext.EventManager-removeAll">removeAll</a></b>( <code>String/HTMLElement el</code> )
+ :
+ void<div class="mdesc"><div class="short">Removes all event handers from an element. Typically you will use Ext.Element.removeAllListeners
+directly on an Elem...</div><div class="long">Removes all event handers from an element. Typically you will use <a href="output/Ext.Element.html#Ext.Element-removeAllListeners" ext:member="removeAllListeners" ext:cls="Ext.Element">Ext.Element.removeAllListeners</a>
+directly on an Element in favor of calling this version.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>el</code> : String/HTMLElement<div class="sub-desc">The id or html element from which to remove all event handlers.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">EventManager</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.EventManager-removeListener"></a><b><a href="source/EventManager.html#method-Ext.EventManager-removeListener">removeListener</a></b>( <code>String/HTMLElement el</code>, <code>String eventName</code>, <code>Function fn</code>, <code>Object scope</code> )
+ :
+ void<div class="mdesc"><div class="short">Removes an event handler from an element. The shorthand version un is equivalent. Typically
+you will use Ext.Elemen...</div><div class="long">Removes an event handler from an element. The shorthand version <a href="output/Ext.EventManager.html#Ext.EventManager-un" ext:member="un" ext:cls="Ext.EventManager">un</a> is equivalent. Typically
+you will use <a href="output/Ext.Element.html#Ext.Element-removeListener" ext:member="removeListener" ext:cls="Ext.Element">Ext.Element.removeListener</a> directly on an Element in favor of calling this version.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>el</code> : String/HTMLElement<div class="sub-desc">The id or html element from which to remove the listener.</div></li><li><code>eventName</code> : String<div class="sub-desc">The name of the event.</div></li><li><code>fn</code> : Function<div class="sub-desc">The handler function to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.EventManager.html#Ext.EventManager-addListener" ext:member="addListener" ext:cls="Ext.EventManager">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">If a scope (<b><code>this</code></b> reference) was specified when the listener was added,
+then this must refer to the same object.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">EventManager</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.EventManager-removeResizeListener"></a><b><a href="source/EventManager-more.html#method-Ext.EventManager-removeResizeListener">removeResizeListener</a></b>( <code>Function fn</code>, <code>Object scope</code> )
+ :
+ void<div class="mdesc"><div class="short">Removes the passed window resize listener.</div><div class="long">Removes the passed window resize listener.<div class="mdetail-params"><strong>Parameters:</strong><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><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">EventManager</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.EventManager-un"></a><b><a href="source/EventManager.html#method-Ext.EventManager-un">un</a></b>( <code>String/HTMLElement el</code>, <code>String eventName</code>, <code>Function fn</code>, <code>Object scope</code> )
+ :
+ void<div class="mdesc"><div class="short">Removes an event handler from an element. Shorthand for removeListener.</div><div class="long">Removes an event handler from an element. Shorthand for <a href="output/Ext.EventManager.html#Ext.EventManager-removeListener" ext:member="removeListener" ext:cls="Ext.EventManager">removeListener</a>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>el</code> : String/HTMLElement<div class="sub-desc">The id or html element from which to remove the listener.</div></li><li><code>eventName</code> : String<div class="sub-desc">The name of the event.</div></li><li><code>fn</code> : Function<div class="sub-desc">The handler function to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.EventManager.html#Ext.EventManager-on" ext:member="on" ext:cls="Ext.EventManager">on</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">If a scope (<b><code>this</code></b> reference) was specified when the listener was added,
+then this must refer to the same object.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">EventManager</td></tr></tbody></table><a id="Ext.EventManager-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>
\ No newline at end of file
git.ithinksw.org / extjs.git / blobdiff