2 "name" : "Roo.EventManager",
7 "desc" : "Registers event handlers that want to receive a normalized EventObject instead of the standard browser event and provides \nseveral useful events directly.\nSee {@link Roo.EventObject} for more details on normalized event objects.",
12 "isBuilderTop" : false,
13 "memberOf" : "EventManager",
25 "name" : "addListener",
27 "desc" : "Appends an event handler to an element (shorthand for addListener)",
28 "sig" : "(element, eventName, handler, scope, options)",
32 "isConstructor" : false,
43 "type" : "String/HTMLElement",
44 "desc" : "The html element or id to assign the",
50 "desc" : "The type of event to listen for",
56 "desc" : "The method the event invokes",
62 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
68 "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delegate {String} A simple selector to filter the target or look for a descendant of the target</li>\n<li>stopEvent {Boolean} True to stop the event. That is stop propagation, and prevent the default action.</li>\n<li>preventDefault {Boolean} True to prevent the default action</li>\n<li>stopPropagation {Boolean} True to prevent event propagation</li>\n<li>normalized {Boolean} False to pass a browser event to the handler function instead of an Roo.EventObject</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<div style=\"margin: 5px 20px 20px;\">\nCode:<pre><code>\nel.on('click', this.onClick, this, {\n single: true,\n delay: 100,\n stopEvent : true,\n forumId: 4\n});</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<p>\nCode:<pre><code>\nel.on({\n 'click' : {\n fn: this.onClick\n scope: this,\n delay: 100\n },\n 'mouseover' : {\n fn: this.onMouseOver\n scope: this\n },\n 'mouseout' : {\n fn: this.onMouseOut\n scope: this\n }\n});</code></pre>\n<p>\nOr a shorthand syntax:<br>\nCode:<pre><code>\nel.on({\n 'click' : this.onClick,\n 'mouseover' : this.onMouseOver,\n 'mouseout' : this.onMouseOut\n scope: this\n});</code></pre>",
75 "name" : "onDocumentReady",
77 "desc" : "Fires when the document is ready (before onload and before images are loaded). Can be \naccessed shorthanded Roo.onReady().",
78 "sig" : "(fn, scope, options)",
82 "isConstructor" : false,
94 "desc" : "The method the event invokes",
100 "desc" : "An object that becomes the scope of the handler",
113 "name" : "onTextResize",
115 "desc" : "Fires when the user changes the active text size. Handler gets called with 2 params, the old size and the new size.",
116 "sig" : "(fn, scope, options)",
120 "isConstructor" : false,
132 "desc" : "The method the event invokes",
138 "desc" : "An object that becomes the scope of the handler",
153 "desc" : "Appends an event handler to an element (shorthand for addListener)",
154 "sig" : "(element, eventName, handler, scope, options)",
158 "isConstructor" : false,
169 "type" : "String/HTMLElement",
170 "desc" : "The html element or id to assign the",
174 "name" : "eventName",
176 "desc" : "The type of event to listen for",
182 "desc" : "The method the event invokes",
188 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
194 "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delegate {String} A simple selector to filter the target or look for a descendant of the target</li>\n<li>stopEvent {Boolean} True to stop the event. That is stop propagation, and prevent the default action.</li>\n<li>preventDefault {Boolean} True to prevent the default action</li>\n<li>stopPropagation {Boolean} True to prevent event propagation</li>\n<li>normalized {Boolean} False to pass a browser event to the handler function instead of an Roo.EventObject</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<div style=\"margin: 5px 20px 20px;\">\nCode:<pre><code>\nel.on('click', this.onClick, this, {\n single: true,\n delay: 100,\n stopEvent : true,\n forumId: 4\n});</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<p>\nCode:<pre><code>\nel.on({\n 'click' : {\n fn: this.onClick\n scope: this,\n delay: 100\n },\n 'mouseover' : {\n fn: this.onMouseOver\n scope: this\n },\n 'mouseout' : {\n fn: this.onMouseOut\n scope: this\n }\n});</code></pre>\n<p>\nOr a shorthand syntax:<br>\nCode:<pre><code>\nel.on({\n 'click' : this.onClick,\n 'mouseover' : this.onMouseOver,\n 'mouseout' : this.onMouseOut\n scope: this\n});</code></pre>",
201 "name" : "removeResizeListener",
203 "desc" : "Removes the passed window resize listener.",
204 "sig" : "(fn, scope)",
208 "isConstructor" : false,
220 "desc" : "The method the event invokes",
226 "desc" : "The scope of handler",
233 "name" : "onWindowResize",
235 "desc" : "Fires when the window is resized and provides resize event buffering (50 milliseconds), passes new viewport width and height to handlers.",
236 "sig" : "(fn, scope, options)",
240 "isConstructor" : false,
252 "desc" : "The method the event invokes",
258 "desc" : "An object that becomes the scope of the handler",
273 "desc" : "This is no longer needed and is deprecated. Places a simple wrapper around an event handler to override the browser event\nobject with a Roo.EventObject",
274 "sig" : "(fn, scope, override)",
278 "isConstructor" : false,
281 "deprecated" : "This has been deprecated: ",
290 "desc" : "The method the event invokes",
296 "desc" : "An object that becomes the scope of the handler",
302 "desc" : "If true, the obj passed in becomes\n the execution scope of the listener",
310 "desc" : "The wrapped function"
315 "name" : "removeListener",
317 "desc" : "Removes an event handler",
318 "sig" : "(element, eventName, fn)",
322 "isConstructor" : false,
333 "type" : "String/HTMLElement",
334 "desc" : "The id or html element to remove the \n event from",
338 "name" : "eventName",
340 "desc" : "The type of event",
354 "desc" : "True if a listener was actually removed"
projects / roojs1 / blob